TestOdbcBindings class

OdbcBindings subclass with injectable capability flags and FFI stubs.

Inheritance
Annotations
  • @visibleForTesting

Constructors

TestOdbcBindings({DynamicLibrary? library, TestOdbcBindingsCapabilities capabilities = const TestOdbcBindingsCapabilities(), TestOdbcBindingsOverrides overrides = const TestOdbcBindingsOverrides()})

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
supportsAsyncExecuteApi bool
no setteroverride
supportsAsyncExecuteParamsApi bool
no setteroverride
supportsAsyncExecuteParamsOptionsApi bool
True when odbc_execute_async_params_options is exported (async columnar).
no setterinherited
supportsAsyncMultiResultStream bool
True when both multi-result streaming start FFIs and the existing async-poll FFI are available.
no setterinherited
supportsAsyncStreamApi bool
no setteroverride
supportsAuditApi bool
no setteroverride
supportsCapabilitiesApi bool
True when the v3.0 capability FFIs are available (UPSERT / RETURNING / session init builders).
no setterinherited
supportsConnectionDbmsInfoApi bool
True when the loaded native library exposes the v2.1 live DBMS introspection FFI (odbc_get_connection_dbms_info).
no setterinherited
supportsDriverCapabilitiesApi bool
no setteroverride
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 setteroverride
supportsExecQueryParamsOptions bool
no setterinherited
supportsMetadataCacheApi bool
no setterinherited
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 setterinherited
supportsPoolCreateWithOptions bool
no setteroverride
supportsStructuredErrorForConnection bool
no setterinherited
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 setteroverride
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 setteroverride
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 setteroverride

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
inherited
odbc_async_cancel(int requestId) int?
override
odbc_async_free(int requestId) int?
override
odbc_async_get_result(int requestId, Pointer<Uint8> outBuf, int bufLen, Pointer<Uint32> outWritten) int?
inherited
odbc_async_poll(int requestId, Pointer<Int32> outStatus) int?
override
odbc_audit_clear() int
override
odbc_audit_enable(int enabled) int
override
odbc_audit_get_events(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten, int limit) int
override
odbc_audit_get_status(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
override
odbc_build_upsert_sql(Pointer<Utf8> connStr, Pointer<Utf8> table, Pointer<Utf8> payloadJson, Pointer<Uint8> outBuf, int bufLen, Pointer<Uint32> outWritten) int
inherited
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
inherited
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
inherited
odbc_cancel(int stmtId) int
inherited
odbc_catalog_columns(int connId, Pointer<Utf8> table, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_catalog_foreign_keys(int connId, Pointer<Utf8> table, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_catalog_indexes(int connId, Pointer<Utf8> table, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_catalog_primary_keys(int connId, Pointer<Utf8> table, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_catalog_tables(int connId, Pointer<Utf8> catalog, Pointer<Utf8> schema, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_catalog_type_info(int connId, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_clear_all_statements() int
inherited
odbc_clear_statement_cache() int
inherited
odbc_close_statement(int stmtId) int
inherited
odbc_connect(Pointer<Utf8> connStr) int
override
odbc_connect_with_timeout(Pointer<Utf8> connStr, int timeoutMs) int
override
odbc_detect_driver(Pointer<Utf8> connStr, Pointer<Int8> outBuf, int bufferLen) int
inherited
odbc_disconnect(int connId) int
override
odbc_exec_query(int connId, Pointer<Utf8> sql, Pointer<Uint8> outBuf, int bufLen, Pointer<Uint32> outWritten) int
inherited
odbc_exec_query_multi(int connId, Pointer<Utf8> sql, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_exec_query_multi_params(int connId, Pointer<Utf8> sql, Pointer<Uint8>? paramsBuffer, int paramsLen, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
override
odbc_exec_query_params(int connId, Pointer<Utf8> sql, Pointer<Uint8>? paramsBuffer, int paramsLen, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_exec_query_params_options(int connId, Pointer<Utf8> sql, Pointer<Uint8>? paramsBuffer, int paramsLen, int resultEncoding, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_execute(int stmtId, Pointer<Uint8>? paramsBuffer, int paramsLen, int timeoutOverrideMs, int fetchSize, Pointer<Uint8> outBuffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_execute_async(int connId, Pointer<Utf8> sql) int?
override
odbc_execute_async_params(int connId, Pointer<Utf8> sql, Pointer<Uint8> paramsBuffer, int paramsLen) int?
inherited
odbc_execute_async_params_options(int connId, Pointer<Utf8> sql, Pointer<Uint8> paramsBuffer, int paramsLen, int resultEncoding) int?
inherited
odbc_get_cache_metrics(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_get_connection_dbms_info(int connId, Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_get_driver_capabilities(Pointer<Utf8> connStr, Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
override
odbc_get_error(Pointer<Int8> buffer, int bufferLen) int
override
odbc_get_metrics(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
override
odbc_get_session_init_sql(Pointer<Utf8> connStr, Pointer<Utf8>? optionsJson, Pointer<Uint8> outBuf, int bufLen, Pointer<Uint32> outWritten) int
inherited
odbc_get_structured_error(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_get_structured_error_for_connection(int connId, Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int?
inherited
odbc_get_version(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_init() int
override
odbc_metadata_cache_clear() int
inherited
odbc_metadata_cache_enable(int maxEntries, int ttlSeconds) int
inherited
odbc_metadata_cache_stats(Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
inherited
odbc_pool_close(int poolId) int
override
odbc_pool_create(Pointer<Utf8> connStr, int maxSize) int
override
odbc_pool_create_with_options(Pointer<Utf8> connStr, int maxSize, Pointer<Utf8>? optionsJson) int
override
odbc_pool_get_connection(int poolId) int
override
odbc_pool_get_state(int poolId, Pointer<Uint32> outSize, Pointer<Uint32> outIdle) int
override
odbc_pool_get_state_json(int poolId, Pointer<Uint8> buffer, int bufferLen, Pointer<Uint32> outWritten) int
override
odbc_pool_health_check(int poolId) int
override
odbc_pool_release_connection(int connectionId) int
override
odbc_pool_set_size(int poolId, int newMaxSize) int
override
odbc_prepare(int connId, Pointer<Utf8> sql, int timeoutMs) int
override
odbc_savepoint_create(int txnId, Pointer<Utf8> name) int
override
odbc_savepoint_release(int txnId, Pointer<Utf8> name) int
override
odbc_savepoint_rollback(int txnId, Pointer<Utf8> name) int
override
odbc_set_log_level(int level) int
inherited
odbc_stream_cancel(int streamId) int
inherited
odbc_stream_close(int streamId) int
override
odbc_stream_fetch(int streamId, Pointer<Uint8> outBuf, int bufLen, Pointer<Uint32> outWritten, Pointer<Uint8> hasMore) int
override
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.
inherited
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.
inherited
odbc_stream_poll_async(int streamId, Pointer<Int32> outStatus) int?
override
odbc_stream_start(int connId, Pointer<Utf8> sql, int chunkSize) int
override
odbc_stream_start_async(int connId, Pointer<Utf8> sql, int fetchSize, int chunkSize) int?
override
odbc_stream_start_batched(int connId, Pointer<Utf8> sql, int fetchSize, int chunkSize) int
override
odbc_transaction_begin(int connId, int isolationLevel, [int savepointDialect = 0]) int
override
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).
override
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.
override
odbc_transaction_commit(int txnId) int
override
odbc_transaction_rollback(int txnId) int
override
odbc_validate_connection_string(Pointer<Utf8> connStr, Pointer<Uint8> errorBuffer, int errorBufferLen) int
override
odbc_xa_commit_one_phase(int xaId) int
inherited
odbc_xa_commit_prepared(int xaId) int
inherited
odbc_xa_end(int xaId) int
inherited
odbc_xa_prepare(int xaId) int
inherited
odbc_xa_recover_count(int connId) int
override
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
override
odbc_xa_resume_prepared(int connId, int formatId, Pointer<Uint8> gtridPtr, int gtridLen, Pointer<Uint8> bqualPtr, int bqualLen) int
inherited
odbc_xa_rollback_active(int xaId) int
inherited
odbc_xa_rollback_prepared(int xaId) int
inherited
odbc_xa_start(int connId, int formatId, Pointer<Uint8> gtridPtr, int gtridLen, Pointer<Uint8> bqualPtr, int bqualLen) int
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited