FDB Reference

Module globals

fdb.__version__

Current driver version, string.

fdb.apilevel

String constant stating the supported DB API level (2.0).

fdb.threadsafety

Integer constant stating the level of thread safety the interface supports.

Curretly 1 = Threads may share the module, but not connections.

fdb.paramstyle

String constant stating the type of parameter marker formatting expected by the interface.

‘qmark’ = Question mark style, e.g. ‘...WHERE name=?’

fdb.DESCRIPTION_NAME
fdb.DESCRIPTION_TYPE_CODE
fdb.DESCRIPTION_DISPLAY_SIZE
fdb.DESCRIPTION_INTERNAL_SIZE
fdb.DESCRIPTION_PRECISION
fdb.DESCRIPTION_SCALE
fdb.DESCRIPTION_NULL_OK

Helper constants for work with Cursor.description content.

Exceptions

This is the exception inheritance layout:

StandardError
|__Warning
|__Error
   |__InterfaceError
   |__DatabaseError
      |__DataError
      |__OperationalError
      |__IntegrityError
      |__InternalError
      |__ProgrammingError
      |__NotSupportedError

Functions

Connection

Cursor

Transaction

PreparedStatement

ConnectionGroup

EventConduit

BlobReader

TPB

TableReservation

Internally used classes exposed to driver users

RowMapping

Services

Module globals

fdb.services.SHUT_NORMAL
fdb.services.SHUT_MULTI
fdb.services.SHUT_SINGLE
fdb.services.SHUT_FULL

These constants are to be passed as the shutdown_mode parameter to Connection.shutdown()

fdb.services.SHUT_FORCE
fdb.services.SHUT_DENY_NEW_TRANSACTIONS
fdb.services.SHUT_DENY_NEW_ATTACHMENTS

These constants are to be passed as the shutdown_method parameter to Connection.shutdown()

fdb.services.WRITE_FORCED
fdb.services.WRITE_BUFFERED

These constants are to be passed as the mode parameter to Connection.setWriteMode()

fdb.services.ACCESS_READ_WRITE
fdb.services.ACCESS_READ_ONLY

These constants are to be passed as the mode parameter to Connection.setAccessMode()

fdb.services.CAPABILITY_MULTI_CLIENT
fdb.services.CAPABILITY_REMOTE_HOP
fdb.services.CAPABILITY_SERVER_CONFIG
fdb.services.CAPABILITY_QUOTED_FILENAME
fdb.services.CAPABILITY_NO_SERVER_SHUTDOWN

These constants are return values of Connection.get_server_capabilities()

Functions

Connection

User

ctypes interface to Firebird client library

ctypes interface to fbclient.so/dll is defined in submodule fdb.ibase.