IBM Books

API Reference

SQLULOAD-IN

This structure is used to input information during a call to sqluload - Load.

Table 68. Fields in the SQLULOAD-IN Structure
Field Name Data Type Description
SIZEOFSTRUCT UNSIGNED LONG Size of this structure in bytes.
SAVECNT UNSIGNED LONG The number of records to load before establishing a consistency point. This value is converted to a page count, and rounded up to intervals of the extent size. Since a message is issued at each consistency point, this option should be selected if the load will be monitored using sqluqry - Load Query. If the value of savecnt is not sufficiently high, the synchronization of activities performed at each consistency point will impact performance.

The default value is 0, meaning that no consistency points will be established, unless necessary.

RESTARTCNT UNSIGNED LONG The number of records to skip before starting to load records. This parameter should be used if a previous attempt to load records fails after some records have been committed to the database. The parameter's value represents a starting point for the next load.
ROWCNT UNSIGNED LONG The number of physical records to be loaded. Allows a user to load only the first rowcnt rows in a file.
WARNINGCNT UNSIGNED LONG Stops the load after warningcnt warnings. Set this parameter if no warnings are expected, but verification that the correct file and table are being used is desired. If warningcnt is 0, or this option is not specified, the load will continue regardless of the number of warnings issued.

If the load is stopped because the threshold of warnings was encountered, another load can be started in RESTART mode by specifying the restartcnt option. Alternatively, another load can be initiated in REPLACE mode, starting at the beginning of the input file.

DATA_BUFFER_SIZE UNSIGNED LONG The number of 4KB pages (regardless of the degree of parallelism) to use as buffered space for transferring data within the utility. If the value specified is less than the algorithmic minimum, the minimum required resource is used, and no warning is returned.

This memory is allocated directly from the utility heap, whose size can be modified through the util_heap_sz database configuration parameter.

If a value is not specified, an intelligent default is calculated by the utility at run time. The default is based on a percentage of the free space available in the utility heap at the instantiation time of the loader, as well as some characteristics of the table.

SORT_BUFFER_SIZE UNSIGNED LONG The number of 4KB pages of memory that are to be used for sorting the index keys during a load operation.
Note:Sort buffer size has a very large impact on sort performance. Therefore, for very large tables (for example, tables in excess of 100M), this buffer should be set as large as possible.

If a value is not specified, the utility uses the larger of:

  • 2MB for OS/2 or Windows NT, or 6MB for all other platforms
  • The minimum size allowed by the sort algorithm
  • 15% of the free space remaining in the utility heap.

If a value greater than zero, but less than the required minimum is specified, the minimum value for that load is returned.

HOLD_QUIESCE UNSIGNED SHORT A flag whose value is set to TRUE if the utility is to leave the table in quiesced exclusive state after the load, and to FALSE if it is not.
RESTARTPHASE CHAR(1) Phase at which to restart the load operation. See below for values.
STATSOPT CHAR(1) Granularity of statistics to collect. See below for values.
CPU_PARALLELISM UNSIGNED SHORT The number of processes or threads that the load utility will spawn for parsing, converting and formatting records when building table objects. This parameter is designed to exploit SMP parallelism. It is particularly useful when loading presorted data, because record order in the source data is preserved. If the value of parameter is zero, the load utility uses an intelligent default value at run time.
Note:If this parameter is used with tables containing either LOB or LONG VARCHAR fields, its value becomes one, regardless of the number of system CPUs or the value specified by the user.
DISK_PARALLELISM UNSIGNED SHORT The number of processes or threads that the load utility will spawn for writing data to the table space containers. If a value is not specified, the utility selects an intelligent default based on the number of table space containers and the characteristics of the table.
NON_RECOVERABLE UNSIGNED SHORT Set to SQLU_NON_RECOVERABLE_LOAD if the load transaction is to be marked as non-recoverable, and it will not be possible to recover it by a subsequent rollforward action. The rollforward utility will skip the transaction, and will mark the table into which data was being loaded as "invalid". The utility will also ignore any subsequent transactions against that table. After the roll forward is completed, such a table can only be dropped.

With this option, table spaces are not put in backup pending state following the load operation, and a copy of the loaded data does not have to be made during the load.

Set to SQLU_RECOVERABLE_LOAD if the load transaction is to be marked as recoverable.

Valid values for RESTARTPHASE (defined in sqlutil) are:

SQLU_LOAD_PHASE
Restart at load phase.
SQLU_BUILD_PHASE
Restart at build phase.
SQLU_DELETE_PHASE
Restart at delete phase.

Valid values for STATSOPT (defined in sqlutil) are:

SQLU_STATS_NONE
SQL_STATS_EXTTABLE_ONLY
SQL_STATS_EXTTABLE_INDEX
SQL_STATS_INDEX
SQL_STATS_TABLE
SQL_STATS_EXTINDEX_ONLY
SQL_STATS_EXTINDEX_TABLE
SQL_STATS_ALL
SQL_STATS_BOTH

Language Syntax

C Structure



/* File: sqlutil.h */
/* Structure: SQLULOAD-IN */
/* ... */
SQL_STRUCTURE sqluload_in
{
  unsigned long   sizeOfStruct;
  unsigned long   savecnt;
  unsigned long   restartcnt;
  unsigned long   rowcnt;
  unsigned long   warningcnt;
  unsigned long   data_buffer_size;
  unsigned long   sort_buffer_size;
  unsigned short  hold_quiesce;
  char            restartphase;
  char            statsopt;
  unsigned short  cpu_parallelism;
  unsigned short  disk_parallelism;
  unsigned short  non_recoverable;
};
/* ... */

COBOL Structure



* File: sqlutil.cbl
01 SQLULOAD-IN.
    05 SQL-SIZE-OF-STRUCT     PIC 9(9) COMP-5 VALUE 40.
    05 SQL-SAVECNT            PIC 9(9) COMP-5.
    05 SQL-RESTARTCOUNT       PIC 9(9) COMP-5.
    05 SQL-ROWCNT             PIC 9(9) COMP-5.
    05 SQL-WARNINGCNT         PIC 9(9) COMP-5.
    05 SQL-DATA-BUFFER-SIZE   PIC 9(9) COMP-5.
    05 SQL-SORT-BUFFER-SIZE   PIC 9(9) COMP-5.
    05 SQL-HOLD-QUIESCE       PIC 9(4) COMP-5.
    05 SQL-RESTARTPHASE       PIC X.
    05 SQL-STATSOPT           PIC X.
    05 SQL-CPU-PARALLELISM    PIC 9(4) COMP-5.
    05 SQL-DISK-PARALLELISM   PIC 9(4) COMP-5.
    05 SQL-NON-RECOVERABLE    PIC 9(4) COMP-5.
    05 FILLER                 PIC X(2).
*


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]

[ DB2 List of Books | Search the DB2 Books ]