Table 17-4 lists the direct path loading functions that are described in this section.
Table 17-4 Direct Path Loading Functions
| Function | Purpose |
|---|---|
|
Terminate a direct path operation |
|
|
Get a specified entry in a column array |
|
|
Set a specified entry in a column array to a specific value |
|
|
Reset the row array state |
|
|
Get the base row pointers for a specified row number |
|
|
Convert from a column array to a direct path stream format |
|
|
Do a data savepoint, or commit the loaded data and finish the load operation |
|
|
Finish and commit the loaded data |
|
|
Deprecated. |
|
|
Load the data converted to direct path stream format |
|
|
Prepare direct path interface to convert or load rows |
|
|
Reset the direct path stream state |
Direct path context handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
All state that was maintained by the server on behalf of the direct path operation is destroyed by a termination. For a direct path load, the data loaded before the terminate operation is not visible to any queries. However, the data may still consume space in the segments that are being loaded. Any load completion operations, such as index maintenance operations, are not performed.
sword OCIDirPathColArrayEntryGet ( OCIDirPathColArray *dpca,
OCIError *errhp,
ub4 rownum,
ub2 colIdx,
ub1 **cvalpp,
ub4 *clenp,
ub1 *cflgp );
Direct path column array handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Zero-based row offset.
The column's index used when building the column parameter list.
Pointer to pointer to column data.
Pointer to length of column data.
Pointer to column flag.
One of these values is returned:
OCI_DIRPATH_COL_COMPLETE - All data for the column is present.
OCI_DIRPATH_COL_NULL - Column is NULL.
OCI_DIRPATH_COL_PARTIAL - Partial column data is being supplied.
If cflgp is set to OCI_DIRPATH_COL_NULL, the cvalpp and clenp parameters are not set by this operation.
sword OCIDirPathColArrayEntrySet ( OCIDirPathColArray *dpca,
OCIError *errhp,
ub4 rownum,
ub2 colIdx,
ub1 *cvalp,
ub4 clen,
ub1 cflg );
Direct path column array handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Zero-based row offset.
The column's index used when building the column parameter list.
Pointer to column data.
Length of column data.
Column flag. One of these values is returned:
OCI_DIRPATH_COL_COMPLETE - All data for the column is present.
OCI_DIRPATH_COL_NULL - Column is NULL.
OCI_DIRPATH_COL_PARTIAL - Partial column data is being supplied.
This example sets the source of data for the first row in a column array to addr, with a length of len. In this example, the column is identified by colId.
err = OCIDirPathColArrayEntrySet(dpca, errhp, (ub2)0, colId, addr, len,
OCI_DIRPATH_COL_COMPLETE);
Direct path column array handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Resetting the column array state is necessary when piecing in a large column and an error occurs in the middle of loading the column. Do not reset the column array if the last OCIDirPathColArrayReset() call returned OCI_NEED_DATA or OCI_CONTINUE. That is, you are in the middle of a row conversion. Use OCI_DIRPATH_COL_ERROR to purge the current row for OCI_NEED_DATA.
sword OCIDirPathColArrayRowGet ( OCIDirPathColArray *dpca,
OCIError *errhp,
ub4 rownum,
ub1 ***cvalppp,
ub4 **clenpp,
ub1 **cflgpp );
Direct path column array handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Zero-based row offset
Pointer to vector of pointers to column data
Pointer to vector of column data lengths
Pointer to vector of column flags
Returns pointers to column array entries for the given row. This allows the application to do simple pointer arithmetic to iterate across the columns of the specific row. You can use this interface to efficiently get or set the column array entries of a row, as opposed to calling OCIDirPathColArrayEntrySet() for every column. The application is also responsible for not dereferencing memory beyond the column array boundaries. The dimensions of the column array are available as attributes of the column array.
sword OCIDirPathColArrayToStream ( OCIDirPathColArray *dpca,
OCIDirPathCtx const *dpctx,
OCIDirPathStream *dpstr,
OCIError *errhp,
ub4 rowcnt,
ub4 rowoff );
Direct path column array handle.
Direct path context handle for the object being loaded.
Direct path stream handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Number of rows in the column array.
Starting index in the column array.
This interface is used to convert a column array representation of data in its external format to a direct path stream format. The converted format is suitable for loading with OCIDirPathLoadStream().
The column data in direct path stream format is converted to its Oracle Database internal representation. All conversions are done on the client side of the two-task interface; all conversion errors occur synchronously with the call to this interface. Information concerning which row and column an error occurred on is available as an attribute of the column array handle.
Note that in a threaded environment, concurrent OCIDirPathColArrayToStream() operations can be referencing the same direct path context handle. However, the direct path context handle is not modified by this interface.
The return codes for this call are:
OCI_SUCCESS - All data in the column array was successfully converted to stream format. The column array attribute OCI_ATTR_ROW_COUNT is the number of rows processed.
OCI_ERROR - An error occurred during conversion; the error handle contains the error information. The column array attribute OCI_ATTR_ROW_COUNT is the number of rows successfully converted in the last call. The attribute OCI_ATTR_COL_COUNT contains the column index into the column array for the column that caused the error. A stream must always be loaded after column array to stream conversion returns OCI_ERROR. It cannot be reset or converted to until it is loaded.
OCI_CONTINUE - Not all of the data in the column array could be converted to stream format. The stream buffer is not large enough to contain all of the column array data. The caller should either load the data, save the data to a file, or use another stream and call OCIDirPathColArrayToStream() again to convert the remainder of the column array data. The column array attribute OCI_ATTR_ROW_COUNT is the number of rows successfully converted in the last call. The row offset must be updated for the next conversion; internal state does keep track of the column to continue conversion from. The OCI_ATTR_ROW_COUNT value must be added to the previous row offset by the caller.
OCI_NEED_DATA - All of the data in the column array was successfully converted, but a partial column was encountered. The caller should load the resulting stream, and supply the remainder of the row, iteratively if necessary. The column array attribute OCI_ATTR_ROW_COUNT is the number of rows successfully converted in the last call. The attribute OCI_ATTR_COL_COUNT contains the column index into the column array for the column that is marked partial.
Depending on the action requested, does a data savepoint, or commits the loaded data and finishes the direct path load operation.
Direct path context handle for the object loaded.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
Values for action parameter to OCIDirPathDataSave() are as follows:
A return value of OCI_SUCCESS indicates that the backend has properly executed a data savepoint or executed the finishing logic.
Executing a data savepoint is not allowed for LOBs.
Executing the finishing logic is different from properly terminating the load, because resources allocated are not freed.
Direct path context handle for the object loaded.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
After the load has completed, and the loaded data is to be committed, the direct path finishing function is called. Finish is not allowed until all streams have been loaded, and there is not a partially loaded row.
A return value of OCI_SUCCESS indicates that the backend has properly terminated the load.
Direct path context handle for the object loaded.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
This function is necessary when part of a row is loaded, but a conversion error occurs on the next piece being processed by the application. Only the row currently in partial state is discarded. If the server is not currently processing a partial row for the object associated with the direct path context, this function does nothing.
sword OCIDirPathLoadStream ( OCIDirPathCtx *dpctx,
OCIDirPathStream *dpstr,
OCIError *errhp );
Direct path context handle for the object loaded.
Direct path stream handle for the stream to load.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
When the interface returns an error, information concerning the row in the column array that sourced the stream can be obtained as an attribute of the direct path stream. Also, the offset into the stream where the error occurred can be obtained as an attribute of the stream.
Return codes for this function are:
OCI_SUCCESS - All data in the stream was successfully loaded.
OCI_ERROR - An error occurred while loading the data. The problem could be a partition mapping error, a NULL constraint violation, a function-based index evaluation error, or an out of space condition, such as cannot allocate extent. OCI_ATTR_ROW_COUNT is the number of rows successfully loaded in the last call.
OCI_NEED_DATA - Last row was not complete. The caller must supply another row piece. If the stream was sourced from a column array, the attribute OCI_ATTR_ROW_COUNT is the number of complete rows successfully loaded in the last call.
OCI_NO_DATA - Attempt to load an empty stream or a stream that has been completely processed.
A stream must be repeatedly loaded until OCI_SUCCESS, OCI_NEED_DATA, or OCI_NO_DATA is returned. For example, a stream cannot be reset if OCI_ERROR is returned from OCIDirPathLoadStream().
Direct path context handle for the object loaded.
Service context.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
After the name of the object to be operated on is set, the external attributes of the column data are set, and all load options are set, the direct path interface must be prepared with OCIDirPathPrepare() before any rows can be converted or loaded.
A return value of OCI_SUCCESS indicates that the backend has been properly initialized for a direct path load operation. A nonzero return indicates an error. Possible errors are:
Invalid context
Not connected to a server
Object name not set
Already prepared (cannot prepare twice)
Object not suitable for a direct path operation
Direct path stream handle.
An error handle that you can pass to OCIErrorGet() for diagnostic information when there is an error.
A direct path stream maintains the state that indicates where the next OCIDirPathColArrayToStream() call should start writing into the stream. Normally, data is appended to the end of the stream. A stream cannot be reset until it is successfully loaded (the loading returned OCI_SUCCESS, OCI_NEED_DATA, or OCI_NO_DATA).