Data Movement Utilities Guide and Reference

Data Structure: SQLULOAD-IN

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

Table 6. Fields in the SQLULOAD-IN Structure
Field Name Data Type Description
SIZEOFSTRUCT sqluint32 Size of this structure in bytes.
SAVECNT sqluint32 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 operation will be monitored using db2LoadQuery - Load Query API. 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 sqluint32G Reserved.
ROWCNT sqluint32 The number of physical records to be loaded. Allows a user to load only the first rowcnt rows in a file.
WARNINGCNT sqluint32 Stops the load operation 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 operation will continue regardless of the number of warnings issued.

If the load operation is stopped because the threshold of warnings was exceeded, another load operation can be started in RESTART mode. The load operation will automatically continue from the last consistency point. Alternatively, another load operation can be initiated in REPLACE mode, starting at the beginning of the input file.

DATA_BUFFER_SIZE sqluint32 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 required minimum 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 sqluint32 Reserved.
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) Reserved.
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 intra-partition parallelism. It is particularly useful when loading presorted data, because record order in the source data is preserved. If the value of this 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 roll forward 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 operation.

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

INDEXING_MODE UNSIGNED SHORT Specifies whether the load utility is to rebuild indexes or to extend them incrementally. See below for values.

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

Valid values for INDEXING_MODE (defined in sqlutil) are:

SQLU_INX_AUTOSELECT

SQLU_INX_REBUILD

SQLU_INX_INCREMENTAL

SQLU_INX_DEFERRED

For an explanation of these indexing modes, see LOAD Command.

Language Syntax

C Structure



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

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.  * No longer used.
    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 SQL-INDEXING-MODE      PIC 9(4) COMP-5.
*
 


[ Top of Page | Previous Page | Next Page ]