OdbcBindings class
Properties
hashCode
→ int
The hash code for this object.
no setter inherited
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
supportsAsyncExecuteApi
→ bool
no setter
supportsAsyncMultiResultStream
→ bool
True when both multi-result streaming start FFIs and the existing
async-poll FFI are available.
no setter
supportsAsyncStreamApi
→ bool
no setter
supportsAuditApi
→ bool
no setter
supportsCapabilitiesApi
→ bool
True when the v3.0 capability FFIs are available (UPSERT / RETURNING /
session init builders).
no setter
supportsConnectionDbmsInfoApi
→ bool
True when the loaded native library exposes the v2.1 live DBMS
introspection FFI (odbc_get_connection_dbms_info).
no setter
supportsDriverCapabilitiesApi
→ bool
no setter
supportsExecQueryMultiParams
→ bool
True when the loaded native library exports
odbc_exec_query_multi_params (added in v3.2.0). Used by
OdbcNative.execQueryMultiParams to fall back gracefully on older
binaries.
no setter
supportsMetadataCacheApi
→ bool
no setter
supportsMultiResultStream
→ bool
True when the loaded native library exports
odbc_stream_multi_start_batched (added in v3.3.0). Used by
OdbcNative.streamMultiStartBatched to refuse silently on older
binaries.
no setter
supportsPoolCreateWithOptions
→ bool
no setter
supportsStructuredErrorForConnection
→ bool
no setter
supportsTransactionAccessMode
→ bool
True when the loaded native library exports
odbc_transaction_begin_v2 (added in Sprint 4.1). Callers that need
the accessMode (READ ONLY / READ WRITE) parameter should gate
on this flag; older binaries silently fall back to v1, which is
equivalent to always passing accessMode = readWrite.
no setter
supportsTransactionLockTimeout
→ bool
True when the loaded native library exports
odbc_transaction_begin_v3 (added in Sprint 4.2). Callers that need
the lockTimeoutMs parameter should gate on this flag; older
binaries silently fall back to v2 (or v1, depending on what they
export) and the lock-timeout argument is ignored — every
transaction uses the engine default.
no setter
supportsXa
→ bool
True when the loaded native library exports the XA / 2PC FFI
family (Sprint 4.3). All ten entry points (odbc_xa_start,
_end, _prepare, _commit_prepared, _rollback_prepared,
_commit_one_phase, _rollback_active, _recover_count,
_recover_get, _resume_prepared) ship together. The Dart-
side wrappers throw UnsupportedError when called against an
older binary; high-level callers should gate on this flag.
no setter
Methods
noSuchMethod (Invocation invocation )
→ dynamic
Invoked when a nonexistent method or property is accessed.
inherited
odbc_append_returning_sql (Pointer <Utf8 > connStr , Pointer <Utf8 > sql , int verb , Pointer <Utf8 > columnsCsv , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten )
→ int
odbc_async_cancel (int requestId )
→ int ?
odbc_async_free (int requestId )
→ int ?
odbc_async_get_result (int requestId , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten )
→ int ?
odbc_async_poll (int requestId , Pointer <Int32 > outStatus )
→ int ?
odbc_audit_clear ()
→ int
odbc_audit_enable (int enabled )
→ int
odbc_audit_get_events (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten , int limit )
→ int
odbc_audit_get_status (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_build_upsert_sql (Pointer <Utf8 > connStr , Pointer <Utf8 > table , Pointer <Utf8 > payloadJson , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten )
→ int
odbc_bulk_insert_array (int connId , Pointer <Utf8 > table , Pointer <Pointer <Utf8 > > columns , int columnCount , Pointer <Uint8 > dataBuffer , int bufferLen , int rowCount , Pointer <Uint32 > rowsInserted )
→ int
odbc_bulk_insert_parallel (int poolId , Pointer <Utf8 > table , Pointer <Pointer <Utf8 > > columns , int columnCount , Pointer <Uint8 > dataBuffer , int bufferLen , int parallelism , Pointer <Uint32 > rowsInserted )
→ int
odbc_cancel (int stmtId )
→ int
odbc_catalog_columns (int connId , Pointer <Utf8 > table , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_catalog_foreign_keys (int connId , Pointer <Utf8 > table , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_catalog_indexes (int connId , Pointer <Utf8 > table , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_catalog_primary_keys (int connId , Pointer <Utf8 > table , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_catalog_tables (int connId , Pointer <Utf8 > catalog , Pointer <Utf8 > schema , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_catalog_type_info (int connId , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_clear_all_statements ()
→ int
odbc_clear_statement_cache ()
→ int
odbc_close_statement (int stmtId )
→ int
odbc_connect (Pointer <Utf8 > connStr )
→ int
odbc_connect_with_timeout (Pointer <Utf8 > connStr , int timeoutMs )
→ int
odbc_detect_driver (Pointer <Utf8 > connStr , Pointer <Int8 > outBuf , int bufferLen )
→ int
odbc_disconnect (int connId )
→ int
odbc_exec_query (int connId , Pointer <Utf8 > sql , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten )
→ int
odbc_exec_query_multi (int connId , Pointer <Utf8 > sql , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_exec_query_multi_params (int connId , Pointer <Utf8 > sql , Pointer <Uint8 > ? paramsBuffer , int paramsLen , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_exec_query_params (int connId , Pointer <Utf8 > sql , Pointer <Uint8 > ? paramsBuffer , int paramsLen , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_execute (int stmtId , Pointer <Uint8 > ? paramsBuffer , int paramsLen , int timeoutOverrideMs , int fetchSize , Pointer <Uint8 > outBuffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_execute_async (int connId , Pointer <Utf8 > sql )
→ int ?
odbc_get_cache_metrics (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_connection_dbms_info (int connId , Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_driver_capabilities (Pointer <Utf8 > connStr , Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_error (Pointer <Int8 > buffer , int bufferLen )
→ int
odbc_get_metrics (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_session_init_sql (Pointer <Utf8 > connStr , Pointer <Utf8 > ? optionsJson , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_structured_error (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_get_structured_error_for_connection (int connId , Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int ?
odbc_get_version (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_init ()
→ int
odbc_metadata_cache_clear ()
→ int
odbc_metadata_cache_enable (int maxEntries , int ttlSeconds )
→ int
odbc_metadata_cache_stats (Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_pool_close (int poolId )
→ int
odbc_pool_create (Pointer <Utf8 > connStr , int maxSize )
→ int
odbc_pool_create_with_options (Pointer <Utf8 > connStr , int maxSize , Pointer <Utf8 > ? optionsJson )
→ int
odbc_pool_get_connection (int poolId )
→ int
odbc_pool_get_state (int poolId , Pointer <Uint32 > outSize , Pointer <Uint32 > outIdle )
→ int
odbc_pool_get_state_json (int poolId , Pointer <Uint8 > buffer , int bufferLen , Pointer <Uint32 > outWritten )
→ int
odbc_pool_health_check (int poolId )
→ int
odbc_pool_release_connection (int connectionId )
→ int
odbc_pool_set_size (int poolId , int newMaxSize )
→ int
odbc_prepare (int connId , Pointer <Utf8 > sql , int timeoutMs )
→ int
odbc_savepoint_create (int txnId , Pointer <Utf8 > name )
→ int
odbc_savepoint_release (int txnId , Pointer <Utf8 > name )
→ int
odbc_savepoint_rollback (int txnId , Pointer <Utf8 > name )
→ int
odbc_set_log_level (int level )
→ int
odbc_stream_cancel (int streamId )
→ int
odbc_stream_close (int streamId )
→ int
odbc_stream_fetch (int streamId , Pointer <Uint8 > outBuf , int bufLen , Pointer <Uint32 > outWritten , Pointer <Uint8 > hasMore )
→ int
odbc_stream_multi_start_async (int connId , Pointer <Utf8 > sql , int chunkSize )
→ int ?
Starts a streaming multi-result batch in async mode (poll + fetch).
Returns null if the native library predates v3.3.0.
odbc_stream_multi_start_batched (int connId , Pointer <Utf8 > sql , int chunkSize )
→ int ?
Starts a streaming multi-result batch in batched mode.
Returns null if the native library predates v3.3.0.
odbc_stream_poll_async (int streamId , Pointer <Int32 > outStatus )
→ int ?
odbc_stream_start (int connId , Pointer <Utf8 > sql , int chunkSize )
→ int
odbc_stream_start_async (int connId , Pointer <Utf8 > sql , int fetchSize , int chunkSize )
→ int ?
odbc_stream_start_batched (int connId , Pointer <Utf8 > sql , int fetchSize , int chunkSize )
→ int
odbc_transaction_begin (int connId , int isolationLevel , [int savepointDialect = 0 ])
→ int
odbc_transaction_begin_v2 (int connId , int isolationLevel , int savepointDialect , int accessMode )
→ int
Sprint 4.1 — begin a transaction with the access-mode hint
(READ ONLY / READ WRITE).
odbc_transaction_begin_v3 (int connId , int isolationLevel , int savepointDialect , int accessMode , int lockTimeoutMs )
→ int
Sprint 4.2 — begin a transaction with full control over isolation,
savepoint dialect, access mode AND per-transaction lock timeout.
odbc_transaction_commit (int txnId )
→ int
odbc_transaction_rollback (int txnId )
→ int
odbc_validate_connection_string (Pointer <Utf8 > connStr , Pointer <Uint8 > errorBuffer , int errorBufferLen )
→ int
odbc_xa_commit_one_phase (int xaId )
→ int
odbc_xa_commit_prepared (int xaId )
→ int
odbc_xa_end (int xaId )
→ int
odbc_xa_prepare (int xaId )
→ int
odbc_xa_recover_count (int connId )
→ int
odbc_xa_recover_get (int index , Pointer <Int32 > outFormatId , Pointer <Uint8 > gtridBuf , int gtridBufLen , Pointer <Uint32 > outGtridLen , Pointer <Uint8 > bqualBuf , int bqualBufLen , Pointer <Uint32 > outBqualLen )
→ int
odbc_xa_resume_prepared (int connId , int formatId , Pointer <Uint8 > gtridPtr , int gtridLen , Pointer <Uint8 > bqualPtr , int bqualLen )
→ int
odbc_xa_rollback_active (int xaId )
→ int
odbc_xa_rollback_prepared (int xaId )
→ int
odbc_xa_start (int connId , int formatId , Pointer <Uint8 > gtridPtr , int gtridLen , Pointer <Uint8 > bqualPtr , int bqualLen )
→ int
toString ()
→ String
A string representation of this object.
inherited