firebird.driver.fbapi¶

This module contains low-level ctypes interface to Firebird client library (fbclient.so/dll).

Constants¶

Type codes¶

SQL_TEXT
SQL_VARYING
SQL_SHORT

SQL_LONG
SQL_FLOAT
SQL_DOUBLE

SQL_D_FLOAT
SQL_TIMESTAMP
SQL_BLOB

SQL_ARRAY
SQL_QUAD
SQL_TYPE_TIME

SQL_TYPE_DATE
SQL_INT64
SQL_BOOLEAN

SQL_NULL
SUBTYPE_NUMERIC
SUBTYPE_DECIMAL

Internal type codes (for example used by ARRAY descriptor)¶

blr_text
blr_text2
blr_short
blr_long
blr_quad
blr_float

blr_double
blr_d_float
blr_timestamp
blr_varying
blr_varying2
blr_blob

blr_cstring
blr_cstring2
blr_blob_id
blr_sql_date
blr_sql_time

blr_int64
blr_blob2
blr_domain_name
blr_domain_name2
blr_not_nullable

blr_column_name
blr_column_name2
blr_bool
blr_dec64
blr_dec128

blr_dec_fixed
blr_sql_time_tz
blr_timestamp_tz
blr_ex_time_tz
blr_ex_timestamp_tz

Types¶

firebird.driver.fbapi.Int¶: alias of c_int

firebird.driver.fbapi.IntPtr¶: alias of LP_c_int

firebird.driver.fbapi.Int64¶: alias of c_long

firebird.driver.fbapi.Int64Ptr¶: alias of LP_c_long

firebird.driver.fbapi.QWord¶: alias of c_ulong

firebird.driver.fbapi.STRING¶: alias of c_char_p

firebird.driver.fbapi.ISC_LONG¶: alias of c_int

firebird.driver.fbapi.ISC_LONG_PTR¶: alias of LP_c_int

firebird.driver.fbapi.ISC_ULONG¶: alias of c_uint

firebird.driver.fbapi.ISC_SHORT¶: alias of c_short

firebird.driver.fbapi.ISC_USHORT¶: alias of c_ushort

firebird.driver.fbapi.ISC_UCHAR¶: alias of c_ubyte

firebird.driver.fbapi.ISC_INT64¶: alias of c_long

firebird.driver.fbapi.ISC_UINT64¶: alias of c_ulong

firebird.driver.fbapi.ISC_DATE¶: alias of c_int

firebird.driver.fbapi.ISC_TIME¶: alias of c_uint

firebird.driver.fbapi.FB_DEC16¶: alias of c_ulong

firebird.driver.fbapi.FB_DEC16Ptr¶: alias of LP_c_ulong

firebird.driver.fbapi.FB_DEC34¶: alias of c_ulong_Array_2

firebird.driver.fbapi.FB_DEC34Ptr¶: alias of LP_c_ulong_Array_2

firebird.driver.fbapi.FB_I128¶: alias of c_ulong_Array_2

firebird.driver.fbapi.FB_I128Ptr¶: alias of LP_c_ulong_Array_2

class firebird.driver.fbapi.ISC_QUAD[source]¶

high¶: Structure/Union member

low¶: Structure/Union member

firebird.driver.fbapi.ISC_QUAD_PTR¶: alias of LP_ISC_QUAD

firebird.driver.fbapi.FB_API_HANDLE¶: alias of c_uint

firebird.driver.fbapi.FB_API_HANDLE_PTR¶: alias of LP_c_uint

firebird.driver.fbapi.ISC_STATUS¶: alias of c_long

firebird.driver.fbapi.ISC_STATUS_PTR¶: alias of LP_c_long

firebird.driver.fbapi.ISC_STATUS_ARRAY¶: alias of c_long_Array_20

firebird.driver.fbapi.ISC_STATUS_ARRAY_PTR¶: alias of LP_c_long_Array_20

class firebird.driver.fbapi.ISC_ARRAY_BOUND[source]¶

array_bound_lower¶: Structure/Union member

array_bound_upper¶: Structure/Union member

class firebird.driver.fbapi.ISC_ARRAY_DESC[source]¶

array_desc_bounds¶: Structure/Union member

array_desc_dimensions¶: Structure/Union member

array_desc_dtype¶: Structure/Union member

array_desc_field_name¶: Structure/Union member

array_desc_flags¶: Structure/Union member

array_desc_length¶: Structure/Union member

array_desc_relation_name¶: Structure/Union member

array_desc_scale¶: Structure/Union member

firebird.driver.fbapi.ISC_ARRAY_DESC_PTR¶: alias of LP_ISC_ARRAY_DESC

firebird.driver.fbapi.RESULT_VECTOR¶: alias of c_uint_Array_15

class firebird.driver.fbapi.ISC_TIME_TZ[source]¶

time_zone¶: Structure/Union member

utc_time¶: Structure/Union member

class firebird.driver.fbapi.ISC_TIME_TZ_EX[source]¶

ext_offset¶: Structure/Union member

time_zone¶: Structure/Union member

utc_time¶: Structure/Union member

class firebird.driver.fbapi.ISC_TIMESTAMP[source]¶

timestamp_date¶: Structure/Union member

timestamp_time¶: Structure/Union member

class firebird.driver.fbapi.ISC_TIMESTAMP_TZ[source]¶

time_zone¶: Structure/Union member

utc_timestamp¶: Structure/Union member

class firebird.driver.fbapi.ISC_TIMESTAMP_TZ_EX[source]¶

ext_offset¶: Structure/Union member

time_zone¶: Structure/Union member

utc_timestamp¶: Structure/Union member

class firebird.driver.fbapi.TraceCounts[source]¶

Trace counters for table

counters¶: Structure/Union member

relation_id¶: Structure/Union member

relation_name¶: Structure/Union member

class firebird.driver.fbapi.PerformanceInfo[source]¶

Performance info

count¶: Structure/Union member

counters¶: Structure/Union member

records_fetched¶: Structure/Union member

tables¶: Structure/Union member

time¶: Structure/Union member

Variables¶

firebird.driver.fbapi.err_encoding¶: Encoding used to decode error messages from Firebird.

Functions¶

firebird.driver.fbapi.has_api() → bool[source]¶

Reaturns True if Firebird API is already loaded.

Return type:: bool

firebird.driver.fbapi.load_api(filename: None | str | Path = None) → None[source]¶

Initializes bindings to Firebird Client Library unless they are already initialized. Called automatically by get_api().

Parameters:

filename (None | str | Path) – Path to Firebird Client Library.
specified (When it's not) –
library. (driver does its best to locate appropriate client) –

Returns:

FirebirdAPI instance.

Return type:

None

Hooks:: Event HookType.HOOK_API_LOADED: Executed after api is initialized. Hook routine must have signature: hook_func(api). Any value returned by hook is ignored.

firebird.driver.fbapi.get_api() → FirebirdAPI[source]¶

Returns Firebird API. Loads the API if needed.

Return type:: FirebirdAPI

Classes¶

class firebird.driver.fbapi.FirebirdAPI(filename: Path = None)[source]¶

Bases: object

Firebird Client API interface object. Loads Firebird Client Library and exposes fb_get_master_interface(). Uses ctypes for bindings.

Parameters:: filename (:py:class:~pathlib.Path) – Firebird client library to be loaded. If it’s not provided, the driver uses find_library() to locate the library.

client_library¶

Loaded Firebird client library ctypes handler

Type:: :py:class:~ctypes.ctypes.CDLL

client_library_name¶

Path to loaded Firebird client library

Type:: :py:class:~pathlib.Path

master¶

Firebird API IMaster interface

Type:: iMaster

util¶

Firebird API IUtil interface

Type:: iUtil

fb_get_master_interface()¶

This function is used to obtain primary Firebird interface, required to access all the rest of interfaces. Has no parameters and always succeeds.

Returns:: iMaster

fb_get_database_handle()¶

Helper function that returns database handle for specified IAttachment interface.

Parameters:

status (:py:class:ISC_STATUS_PTR) – :ISC status
db_handle (:py:class:FB_API_HANDLE_PTR) – database handle
att (iAttachment) – attachment

Returns:

ISC_STATUS

fb_get_transaction_handle()¶

Helper function that returns database handle for specified ITransaction interface.

Parameters:

status (:py:class:ISC_STATUS_PTR) – ISC status
tra_handle (:py:class:FB_API_HANDLE_PTR) – Transaction handle
att (iTransaction) – Transaction

Returns:

ISC_STATUS

fb_interpret()¶

Helper function that fills buffer with text for errors noted in ISC status.

Parameters:

buffer (:py:class:STRING) – Buffer for message
buf_size (int) – Buffer size
status_ptr – Pointer to ISC_STATUS_PTR

Returns:

ISC_LONG

fb_sqlstate()¶

Helper function that returns SQLSTATE for ISC_STATUS.

Parameters:: status (:py:class:ISC_STATUS_PTR) – ISC status
Returns:: STRING - 5 characters of SQLSTATE

isc_sqlcode()¶

Helper function that returns SQLCODE for ISC_STATUS.

Parameters:: status (:py:class:ISC_STATUS_PTR) – ISC status
Returns:: ISC_LONG

isc_array_lookup_bounds()¶: Old API function.

isc_array_put_slice()¶: Old API function.

isc_array_get_slice()¶: Old API function.

isc_que_events()¶: Old API function.

isc_event_counts()¶: Old API function.

isc_cancel_events()¶: Old API function.

isc_compile_request()¶: Old API function.

isc_start_request()¶: Old API function.

isc_release_request()¶: Old API function.

isc_receive()¶: Old API function.

isc_start_and_send()¶: Old API function.

isc_send()¶: Old API function.

isc_open_blob2()¶: Old API function.

isc_blob_info()¶: Old API function.

isc_create_blob2()¶: Old API function.

isc_get_segment()¶: Old API function.

isc_put_segment()¶: Old API function.

isc_close_blob()¶: Old API function.

isc_event_block(event_buffer: bytes, result_buffer: bytes, *args) → int[source]¶

Convenience wrapper for isc_event_block() API function. Injects variable number of parameters into C_isc_event_block call.

Parameters:

event_buffer (bytes) –
result_buffer (bytes) –

Return type:

int

client_library: CDLL¶: Firebird client library

client_library_name: Path¶: Firebird client library name

fb_get_database_handle¶: Firebird API

fb_get_master_interface¶: Firebird API

fb_get_transaction_handle¶: Firebird API

fb_interpret¶: Firebird API

fb_shutdown_callback¶: Firebird API

fb_sqlstate¶: Firebird API

isc_array_get_slice¶: Firebird API

isc_array_lookup_bounds¶: Firebird API

isc_array_put_slice¶: Firebird API

isc_blob_info¶: Firebird API

isc_cancel_events¶: Firebird API

isc_close_blob¶: Firebird API

isc_compile_request¶: Firebird API

isc_create_blob2¶: Firebird API

isc_event_counts¶: Firebird API

isc_get_segment¶: Firebird API

isc_open_blob2¶: Firebird API

isc_put_segment¶: Firebird API

isc_que_events¶: Firebird API

isc_receive¶: Firebird API

isc_release_request¶: Firebird API

isc_send¶: Firebird API

isc_sqlcode¶: Firebird API

isc_start_and_send¶: Firebird API

isc_start_request¶: Firebird API

Firebird API Interface definitions¶

class firebird.driver.fbapi.IVersioned_VTable[source]¶

Interface virtual method table

dummy¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IVersioned_struct[source]¶

Fiebird Interface data structure

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IReferenceCounted_VTable[source]¶

IReferenceCounted virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IReferenceCounted_struct[source]¶

IReferenceCounted data structure

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IDisposable_VTable[source]¶

IDisposable virtual method table

dispose¶: Structure/Union member

dummy¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IDisposable_struct[source]¶

IDisposable data structure

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IStatus_VTable[source]¶

IStatus VTable

clone¶: Structure/Union member

dispose¶: Structure/Union member

dummy¶: Structure/Union member

getErrors¶: Structure/Union member

getState¶: Structure/Union member

getWarnings¶: Structure/Union member

init¶: Structure/Union member

setErrors¶: Structure/Union member

setErrors2¶: Structure/Union member

setWarnings¶: Structure/Union member

setWarnings2¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IStatus_struct[source]¶

IStatus interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IMaster_VTable[source]¶

IMaster virtual method table

dummy¶: Structure/Union member

getConfigManager¶: Structure/Union member

getDispatcher¶: Structure/Union member

getDtc¶: Structure/Union member

getMetadataBuilder¶: Structure/Union member

getPluginManager¶: Structure/Union member

getProcessExiting¶: Structure/Union member

getStatus¶: Structure/Union member

getTimerControl¶: Structure/Union member

getUtilInterface¶: Structure/Union member

registerAttachment¶: Structure/Union member

registerTransaction¶: Structure/Union member

serverMode¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IMaster_struct[source]¶

IMaster interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IPluginBase_VTable[source]¶

IPluginBase virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

getOwner¶: Structure/Union member

release¶: Structure/Union member

setOwner¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IPluginBase_struct[source]¶

IPluginBase interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IPluginSet_VTable[source]¶: IPluginSet virtual method table

class firebird.driver.fbapi.IPluginSet_struct[source]¶

IPluginSet interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IConfigEntry_VTable[source]¶

IConfigEntry virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

getBoolValue¶: Structure/Union member

getIntValue¶: Structure/Union member

getName¶: Structure/Union member

getSubConfig¶: Structure/Union member

getValue¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IConfigEntry_struct[source]¶

IConfigEntry interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IConfig_VTable[source]¶

IConfig virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

find¶: Structure/Union member

findPos¶: Structure/Union member

findValue¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IConfig_struct[source]¶

IConfig interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IFirebirdConf_VTable[source]¶

IFirebirdConf virtual method table

addRef¶: Structure/Union member

asBoolean¶: Structure/Union member

asInteger¶: Structure/Union member

asString¶: Structure/Union member

dummy¶: Structure/Union member

getKey¶: Structure/Union member

getVersion¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IFirebirdConf_struct[source]¶

IFirebirdConf interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IPluginManager_VTable[source]¶: IPluginManager virtual method table

class firebird.driver.fbapi.IPluginManager_struct[source]¶

IPluginManager interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IConfigManager_VTable[source]¶

IConfigManager virtual method table

dummy¶: Structure/Union member

getDatabaseConf¶: Structure/Union member

getDefaultSecurityDb¶: Structure/Union member

getDirectory¶: Structure/Union member

getFirebirdConf¶: Structure/Union member

getInstallDirectory¶: Structure/Union member

getPluginConfig¶: Structure/Union member

getRootDirectory¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IConfigManager_struct[source]¶

IConfigManager interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IEventCallback_VTable[source]¶

IEventCallback virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

eventCallbackFunction¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IEventCallback_struct[source]¶

IEventCallback interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IBlob_VTable[source]¶

IBlob virtual method table

addRef¶: Structure/Union member

cancel¶: Structure/Union member

close¶: Structure/Union member

deprecatedCancel¶: Structure/Union member

deprecatedClose¶: Structure/Union member

dummy¶: Structure/Union member

getInfo¶: Structure/Union member

getSegment¶: Structure/Union member

putSegment¶: Structure/Union member

release¶: Structure/Union member

seek¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IBlob_struct[source]¶

IBlob interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.ITransaction_VTable[source]¶

ITransaction virtual method table

addRef¶: Structure/Union member

commit¶: Structure/Union member

commitRetaining¶: Structure/Union member

deprecatedCommit¶: Structure/Union member

deprecatedDisconnect¶: Structure/Union member

deprecatedRollback¶: Structure/Union member

disconnect¶: Structure/Union member

dummy¶: Structure/Union member

enterDtc¶: Structure/Union member

getInfo¶: Structure/Union member

join¶: Structure/Union member

prepare¶: Structure/Union member

release¶: Structure/Union member

rollback¶: Structure/Union member

rollbackRetaining¶: Structure/Union member

validate¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.ITransaction_struct[source]¶

ITransaction interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IMessageMetadata_VTable[source]¶

IMessageMetadata virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

getAlias¶: Structure/Union member

getAlignedLength¶: Structure/Union member

getAlignment¶: Structure/Union member

getBuilder¶: Structure/Union member

getCharSet¶: Structure/Union member

getCount¶: Structure/Union member

getField¶: Structure/Union member

getLength¶: Structure/Union member

getMessageLength¶: Structure/Union member

getNullOffset¶: Structure/Union member

getOffset¶: Structure/Union member

getOwner¶: Structure/Union member

getRelation¶: Structure/Union member

getScale¶: Structure/Union member

getSubType¶: Structure/Union member

getType¶: Structure/Union member

isNullable¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IMessageMetadata_struct[source]¶

IMessageMetadata interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IMetadataBuilder_VTable[source]¶

IMetadataBuilder virtual method table

addField¶: Structure/Union member

addRef¶: Structure/Union member

dummy¶: Structure/Union member

getMetadata¶: Structure/Union member

moveNameToIndex¶: Structure/Union member

release¶: Structure/Union member

remove¶: Structure/Union member

setAlias¶: Structure/Union member

setCharSet¶: Structure/Union member

setField¶: Structure/Union member

setLength¶: Structure/Union member

setOwner¶: Structure/Union member

setRelation¶: Structure/Union member

setScale¶: Structure/Union member

setSubType¶: Structure/Union member

setType¶: Structure/Union member

truncate¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IMetadataBuilder_struct[source]¶

IMetadataBuilder interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IResultSet_VTable[source]¶

IResultSet virtual method table

addRef¶: Structure/Union member

close¶: Structure/Union member

deprecatedClose¶: Structure/Union member

dummy¶: Structure/Union member

fetchAbsolute¶: Structure/Union member

fetchFirst¶: Structure/Union member

fetchLast¶: Structure/Union member

fetchNext¶: Structure/Union member

fetchPrior¶: Structure/Union member

fetchRelative¶: Structure/Union member

getInfo¶: Structure/Union member

getMetadata¶: Structure/Union member

isBof¶: Structure/Union member

isEof¶: Structure/Union member

release¶: Structure/Union member

setDelayedOutputFormat¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IResultSet_struct[source]¶

IResultSet interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IStatement_VTable[source]¶

IStatement virtual method table

addRef¶: Structure/Union member

createBatch¶: Structure/Union member

deprecatedFree¶: Structure/Union member

dummy¶: Structure/Union member

execute¶: Structure/Union member

free¶: Structure/Union member

getAffectedRecords¶: Structure/Union member

getFlags¶: Structure/Union member

getInfo¶: Structure/Union member

getInputMetadata¶: Structure/Union member

getOutputMetadata¶: Structure/Union member

getPlan¶: Structure/Union member

getTimeout¶: Structure/Union member

getType¶: Structure/Union member

openCursor¶: Structure/Union member

release¶: Structure/Union member

setCursorName¶: Structure/Union member

setTimeout¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IStatement_struct[source]¶

IStatement interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IBatch_VTable[source]¶

IBatch virtual method table

add¶: Structure/Union member

addBlob¶: Structure/Union member

addBlobStream¶: Structure/Union member

addRef¶: Structure/Union member

appendBlobData¶: Structure/Union member

cancel¶: Structure/Union member

close¶: Structure/Union member

deprecatedClose¶: Structure/Union member

dummy¶: Structure/Union member

execute¶: Structure/Union member

getBlobAlignment¶: Structure/Union member

getInfo¶: Structure/Union member

getMetadata¶: Structure/Union member

registerBlob¶: Structure/Union member

release¶: Structure/Union member

setDefaultBpb¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IBatch_struct[source]¶

IBatch interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IBatchCompletionState_VTable[source]¶

IBatchCompletionState virtual method table

dispose¶: Structure/Union member

dummy¶: Structure/Union member

findError¶: Structure/Union member

getSize¶: Structure/Union member

getState¶: Structure/Union member

getStatus¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IBatchCompletionState_struct[source]¶

IBatchCompletionState interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IRequest_VTable[source]¶

IRequest virtual method table

addRef¶: Structure/Union member

deprecatedFree¶: Structure/Union member

dummy¶: Structure/Union member

free¶: Structure/Union member

getInfo¶: Structure/Union member

receive¶: Structure/Union member

release¶: Structure/Union member

send¶: Structure/Union member

start¶: Structure/Union member

startAndSend¶: Structure/Union member

unwind¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IRequest_struct[source]¶

IRequest interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IEvents_VTable[source]¶

IEvents virtual method table

addRef¶: Structure/Union member

cancel¶: Structure/Union member

deprecatedCancel¶: Structure/Union member

dummy¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IEvents_struct[source]¶

IEvents interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IAttachment_VTable[source]¶

IAttachment virtual method table

addRef¶: Structure/Union member

cancelOperation¶: Structure/Union member

compileRequest¶: Structure/Union member

createBatch¶: Structure/Union member

createBlob¶: Structure/Union member

createReplicator¶: Structure/Union member

deprecatedDetach¶: Structure/Union member

deprecatedDropDatabase¶: Structure/Union member

detach¶: Structure/Union member

dropDatabase¶: Structure/Union member

dummy¶: Structure/Union member

execute¶: Structure/Union member

executeDyn¶: Structure/Union member

getIdleTimeout¶: Structure/Union member

getInfo¶: Structure/Union member

getSlice¶: Structure/Union member

getStatementTimeout¶: Structure/Union member

openBlob¶: Structure/Union member

openCursor¶: Structure/Union member

ping¶: Structure/Union member

prepare¶: Structure/Union member

putSlice¶: Structure/Union member

queEvents¶: Structure/Union member

reconnectTransaction¶: Structure/Union member

release¶: Structure/Union member

setIdleTimeout¶: Structure/Union member

setStatementTimeout¶: Structure/Union member

startTransaction¶: Structure/Union member

transactRequest¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IAttachment_struct[source]¶

IAttachment interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IService_VTable[source]¶

IService virtual method table

addRef¶: Structure/Union member

cancel¶: Structure/Union member

deprecatedDetach¶: Structure/Union member

detach¶: Structure/Union member

dummy¶: Structure/Union member

query¶: Structure/Union member

release¶: Structure/Union member

start¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IService_struct[source]¶

IService interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IProvider_VTable[source]¶

IProvider virtual method table

addRef¶: Structure/Union member

attachDatabase¶: Structure/Union member

attachServiceManager¶: Structure/Union member

createDatabase¶: Structure/Union member

dummy¶: Structure/Union member

getOwner¶: Structure/Union member

release¶: Structure/Union member

setDbCryptCallback¶: Structure/Union member

setOwner¶: Structure/Union member

shutdown¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IProvider_struct[source]¶

IProvider interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IDtcStart_VTable[source]¶

IDtcStart virtual method table

addAttachment¶: Structure/Union member

addWithTpb¶: Structure/Union member

dispose¶: Structure/Union member

dummy¶: Structure/Union member

start¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IDtcStart_struct[source]¶

IDtcStart interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IDtc_VTable[source]¶

IDtc virtual method table

dummy¶: Structure/Union member

join¶: Structure/Union member

startBuilder¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IDtc_struct[source]¶

IDtc interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.ICryptKeyCallback_VTable[source]¶

ICryptKeyCallback virtual method table

callback¶: Structure/Union member

dummy¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.ICryptKeyCallback_struct[source]¶

ICryptKeyCallback interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.ITimer_VTable[source]¶

ITimer virtual method table

addRef¶: Structure/Union member

dummy¶: Structure/Union member

handler¶: Structure/Union member

release¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.ITimer_struct[source]¶

ITimer interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.ITimerControl_VTable[source]¶

ITimerControl virtual method table

dummy¶: Structure/Union member

start¶: Structure/Union member

stop¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.ITimerControl_struct[source]¶

ITimerControl interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IVersionCallback_VTable[source]¶

IVersionCallback virtual method table

callback¶: Structure/Union member

dummy¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IVersionCallback_struct[source]¶

IVersionCallback interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IUtil_VTable[source]¶

IUtil virtual method table

decodeDate¶: Structure/Union member

decodeTime¶: Structure/Union member

decodeTimeStampTz¶: Structure/Union member

decodeTimeStampTzEx¶: Structure/Union member

decodeTimeTz¶: Structure/Union member

decodeTimeTzEx¶: Structure/Union member

dummy¶: Structure/Union member

dumpBlob¶: Structure/Union member

encodeDate¶: Structure/Union member

encodeTime¶: Structure/Union member

encodeTimeStampTz¶: Structure/Union member

encodeTimeTz¶: Structure/Union member

executeCreateDatabase¶: Structure/Union member

formatStatus¶: Structure/Union member

getClientVersion¶: Structure/Union member

getDecFloat16¶: Structure/Union member

getDecFloat34¶: Structure/Union member

getFbVersion¶: Structure/Union member

getInt128¶: Structure/Union member

getPerfCounters¶: Structure/Union member

getXpbBuilder¶: Structure/Union member

loadBlob¶: Structure/Union member

setOffsets¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IUtil_struct[source]¶

IUtil interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IOffsetsCallback_VTable[source]¶

IOffsetsCallback virtual method table

dummy¶: Structure/Union member

setOffset¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IOffsetsCallback_struct[source]¶

IOffsetsCallback interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IXpbBuilder_VTable[source]¶

IXpbBuilder virtual method table

clear¶: Structure/Union member

dispose¶: Structure/Union member

dummy¶: Structure/Union member

findFirst¶: Structure/Union member

findNext¶: Structure/Union member

getBigInt¶: Structure/Union member

getBuffer¶: Structure/Union member

getBufferLength¶: Structure/Union member

getBytes¶: Structure/Union member

getInt¶: Structure/Union member

getLength¶: Structure/Union member

getString¶: Structure/Union member

getTag¶: Structure/Union member

insertBigInt¶: Structure/Union member

insertBytes¶: Structure/Union member

insertInt¶: Structure/Union member

insertString¶: Structure/Union member

insertTag¶: Structure/Union member

isEof¶: Structure/Union member

moveNext¶: Structure/Union member

removeCurrent¶: Structure/Union member

rewind¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IXpbBuilder_struct[source]¶

IXpbBuilder interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IDecFloat16_VTable[source]¶

IDecFloat16 virtual method table

dummy¶: Structure/Union member

fromBcd¶: Structure/Union member

fromString¶: Structure/Union member

toBcd¶: Structure/Union member

toString¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IDecFloat16_struct[source]¶

IDecFloat16 interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IDecFloat34_VTable[source]¶

IDecFloat34 virtual method table

dummy¶: Structure/Union member

fromBcd¶: Structure/Union member

fromString¶: Structure/Union member

toBcd¶: Structure/Union member

toString¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IDecFloat34_struct[source]¶

IDecFloat34 interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member

class firebird.driver.fbapi.IInt128_VTable[source]¶

IInt128 virtual method table

dummy¶: Structure/Union member

fromString¶: Structure/Union member

toString¶: Structure/Union member

version¶: Structure/Union member

class firebird.driver.fbapi.IInt128_struct[source]¶

IInt128 interface

dummy¶: Structure/Union member

vtable¶: Structure/Union member