Skip to main content

Module dpl

Module dpl 

Source
Expand description

Direct Path Load (DPL) protocol support.

Implements the three TTC functions used by python-oracledb’s Connection.direct_path_load():

  • function 128 — direct path prepare (send table/column names, receive server-side column metadata and a direct path cursor id),
  • function 129 — direct path load stream (column-array piece stream),
  • function 130 — direct path op (FINISH commits, ABORT discards).

The builders/parsers mirror impl/thin/messages/direct_path_*.pyx of the python-oracledb v4.0.1 reference and are validated against golden wire captures in tests/golden/. The batch state machine mirrors impl/base/batch_load_manager.pyx.

Re-exports§

pub use parse_direct_path_simple_response as parse_direct_path_load_stream_response;
pub use parse_direct_path_simple_response as parse_direct_path_op_response;
pub use parse_direct_path_simple_response_with_limits as parse_direct_path_load_stream_response_with_limits;
pub use parse_direct_path_simple_response_with_limits as parse_direct_path_op_response_with_limits;

Structs§

BatchLoadState
Batch/chunk state machine shared by executemany ingestion and direct path load. Port of BatchLoadManager/DataFrameBatchLoadManager (impl/base/batch_load_manager.pyx).
DirectPathPiece
A finalized direct path piece, ready to be written to a load stream message.
DirectPathPrepareResult
DirectPathStream
Result of encoding one batch of rows into the piece stream format.

Enums§

DirectPathColumnValue
One column value of a direct path load row, already converted to the Oracle-facing intermediate form (mirrors the reference’s OracleData).

Constants§

TNS_DPLS_MAX_MESSAGE_SIZE
TNS_DPLS_MAX_PIECE_SIZE
TNS_DPLS_MAX_SHORT_LENGTH
TNS_DPLS_ROW_HEADER_FAST_PIECE
TNS_DPLS_ROW_HEADER_FAST_ROW
TNS_DPLS_ROW_HEADER_FIRST
TNS_DPLS_ROW_HEADER_LAST
TNS_DPLS_ROW_HEADER_SPLIT_WITH_NEXT
TNS_DPLS_ROW_HEADER_SPLIT_WITH_PREV
TNS_DPP_OP_CODE_LOAD
TNS_DP_INTERFACE_VERSION
TNS_DP_OP_ABORT
TNS_DP_OP_FINISH
TNS_DP_STREAM_VERSION
TNS_FUNC_DIRECT_PATH_LOAD_STREAM
TNS_FUNC_DIRECT_PATH_OP
TNS_FUNC_DIRECT_PATH_PREPARE

Functions§

build_direct_path_load_stream_payload
Builds the payload for TTC function 129 (direct path load stream).
build_direct_path_op_payload
Builds the payload for TTC function 130 (direct path op).
build_direct_path_prepare_payload
Builds the payload for TTC function 128 (direct path prepare).
encode_direct_path_rows
Encodes a batch of rows into direct path pieces.
parse_direct_path_prepare_response
Parses the response to TTC function 128 (direct path prepare).
parse_direct_path_prepare_response_with_limits
parse_direct_path_simple_response
Parses the response to TTC functions 129 and 130 (both return the same shape: a ub2 count of out values that are each skipped).
parse_direct_path_simple_response_with_limits