adbc_driver_flightsql

低階 API

Flight SQL 驅動程式的低階 ADBC 綁定。

class adbc_driver_flightsql.ConnectionOptions(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基底類別：Enum

Flight SQL 驅動程式特定的連線選項。

OPTION_BOOL_SESSION_OPTION_PREFIX = 'adbc.flight.sql.session.optionbool.'

取得或設定布林值的會期選項。

OPTION_ERASE_SESSION_OPTION_PREFIX = 'adbc.flight.sql.session.optionerase.'

清除會期選項（使用“”作為值）。

OPTION_SESSION_OPTIONS = 'adbc.flight.sql.session.options'

以 JSON 鍵值 blob 格式取得所有會期選項。

OPTION_SESSION_OPTION_PREFIX = 'adbc.flight.sql.session.option.'

取得或設定會期選項。

OPTION_STRING_LIST_SESSION_OPTION_PREFIX = 'adbc.flight.sql.session.optionstringlist.'

以 JSON 陣列格式取得或設定字串列表值的會期選項。

RPC_CALL_HEADER_PREFIX = 'adbc.flight.sql.rpc.call_header.'

將任意標頭新增至所有外送請求。

此選項應為要新增的標頭名稱加上前綴（即應像 f"{ConnectionOptions.RPC_CALL_HEADER_PREFIX}x-my-header" 這樣使用）。

覆寫透過等效資料庫選項設定的任何標頭。

TIMEOUT_FETCH = 'adbc.flight.sql.rpc.timeout_seconds.fetch'

設定擷取資料呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC DoGet 呼叫。

TIMEOUT_QUERY = 'adbc.flight.sql.rpc.timeout_seconds.query'

設定執行查詢呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC GetFlightInfo 呼叫。

TIMEOUT_UPDATE = 'adbc.flight.sql.rpc.timeout_seconds.update'

設定上傳或更新資料呼叫的逾時時間（以浮點秒為單位）。

class adbc_driver_flightsql.DatabaseOptions(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基底類別：Enum

Flight SQL 驅動程式特定的資料庫選項。

AUTHORITY = 'adbc.flight.sql.client_option.authority'

身份驗證握手中的伺服器名稱

AUTHORIZATION_HEADER = 'adbc.flight.sql.authorization_header'

用於請求的授權標頭。

MTLS_CERT_CHAIN = 'adbc.flight.sql.client_option.mtls_cert_chain'

啟用 mTLS 並使用這些 PEM 編碼憑證。

MTLS_PRIVATE_KEY = 'adbc.flight.sql.client_option.mtls_private_key'

啟用 mTLS 並使用此 PEM 編碼私密金鑰。

RPC_CALL_HEADER_PREFIX = 'adbc.flight.sql.rpc.call_header.'

將任意標頭新增至所有外送請求。

此選項應為要新增的標頭名稱加上前綴（即應像 f"{DatabaseOptions.RpcCallHeaderPrefix}.x-my-header" 這樣使用）。

TIMEOUT_FETCH = 'adbc.flight.sql.rpc.timeout_seconds.fetch'

設定擷取資料呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC DoGet 呼叫。

TIMEOUT_QUERY = 'adbc.flight.sql.rpc.timeout_seconds.query'

設定執行查詢呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC GetFlightInfo 呼叫。

TIMEOUT_UPDATE = 'adbc.flight.sql.rpc.timeout_seconds.update'

設定上傳或更新資料呼叫的逾時時間（以浮點秒為單位）。

TLS_OVERRIDE_HOSTNAME = 'adbc.flight.sql.client_option.tls_override_hostname'

覆寫用於 TLS 的主機名稱。

TLS_ROOT_CERTS = 'adbc.flight.sql.client_option.tls_root_certs'

將這些 PEM 編碼的根憑證用於 TLS。

TLS_SKIP_VERIFY = 'adbc.flight.sql.client_option.tls_skip_verify'

不要驗證伺服器的 TLS 憑證。

WITH_BLOCK = 'adbc.flight.sql.client_option.with_block'

封鎖並等待連線建立。

啟用 Cookie 中介軟體。預設為停用（“false”）

WITH_MAX_MSG_SIZE = 'adbc.flight.sql.client_option.with_max_msg_size'

設定最大 gRPC 訊息大小（以位元組為單位）。預設值為 16 MiB。

class adbc_driver_flightsql.StatementOptions(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

基底類別：Enum

Flight SQL 驅動程式特定的陳述式選項。

LAST_FLIGHT_INFO = 'adbc.flight.sql.statement.exec.last_flight_info'

最新的 FlightInfo 值。

執行緒安全。主要在增量執行時有用，進階用戶端可能想要檢查服務的最新 FlightInfo，但無需等待 execute_partitions 返回。（服務可能會傳送具有進度/app_metadata 值的更新 FlightInfo，但只有在有新的端點時，execute_partitions 才會返回。）

QUEUE_SIZE = 'adbc.rpc.result_queue_size'

每個分割區要排隊的批次數量。預設值為 5。

這控制我們在結果集中提前讀取多少。

RPC_CALL_HEADER_PREFIX = 'adbc.flight.sql.rpc.call_header.'

將任意標頭新增至所有外送請求。

此選項應為要新增的標頭名稱加上前綴（即應像 f"{ConnectionOptions.RPC_CALL_HEADER_PREFIX}x-my-header" 這樣使用）。

覆寫透過等效資料庫或連線選項設定的任何標頭。

SUBSTRAIT_VERSION = 'adbc.flight.sql.substrait.version'

設定在 Flight SQL 請求中傳遞的 Substrait 版本。

大多數伺服器不會使用它，因為 Substrait 規範已更新為在最初新增至 Flight SQL 後將版本嵌入到計畫本身中。

TIMEOUT_FETCH = 'adbc.flight.sql.rpc.timeout_seconds.fetch'

設定擷取資料呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC DoGet 呼叫。

TIMEOUT_QUERY = 'adbc.flight.sql.rpc.timeout_seconds.query'

設定執行查詢呼叫的逾時時間（以浮點秒為單位）。

這對應於 Flight RPC GetFlightInfo 呼叫。

TIMEOUT_UPDATE = 'adbc.flight.sql.rpc.timeout_seconds.update'

設定上傳或更新資料呼叫的逾時時間（以浮點秒為單位）。

adbc_driver_flightsql.connect(uri: str, db_kwargs: Dict[str, str] | None = None) → AdbcDatabase

建立 Flight SQL 後端的低階 ADBC 連線。

參數：
uristr

要連線的 URI。

db_kwargsdict，選用

初始資料庫連線參數。

DBAPI 2.0 API

ADBC Arrow Flight SQL 驅動程式的 DBAPI 2.0 相容外觀模式。

adbc_driver_flightsql.dbapi.connect(uri: str, db_kwargs: Dict[str, str] | None = None, conn_kwargs: Dict[str, str] | None = None, **kwargs) → Connection

透過 ADBC 連線至 Flight SQL 後端。

參數：
uristr

要連線的 URI。

db_kwargsdict，選用

初始資料庫連線參數。

conn_kwargsdict，選用

連線特定的參數。（ADBC 區分在多個「連線」物件之間共用的「資料庫」物件。）