=================== Interbase Reference =================== .. module:: interbase :synopsis: Python Database API 2.0 Compliant driver for InterBase Module globals ============== .. data:: __version__ Current driver version, string. .. data:: apilevel String constant stating the supported DB API level (2.0). .. data:: threadsafety Integer constant stating the level of thread safety the interface supports. Curretly `1` = Threads may share the module, but not connections. .. data:: paramstyle String constant stating the type of parameter marker formatting expected by the interface. `'qmark'` = Question mark style, e.g. '...WHERE name=?' .. data:: DESCRIPTION_NAME .. data:: DESCRIPTION_TYPE_CODE .. data:: DESCRIPTION_DISPLAY_SIZE .. data:: DESCRIPTION_INTERNAL_SIZE .. data:: DESCRIPTION_PRECISION .. data:: DESCRIPTION_SCALE .. data:: DESCRIPTION_NULL_OK Helper constants for work with :attr:`Cursor.description` content. .. data:: ISOLATION_LEVEL_READ_COMMITED_LEGACY TPB for R/W WAIT READ COMMITTED NO RECORD VERSION transaction. .. data:: ISOLATION_LEVEL_READ_COMMITED TPB for R/W WAIT READ COMMITTED RECORD VERSION transaction. .. data:: ISOLATION_LEVEL_REPEATABLE_READ .. data:: ISOLATION_LEVEL_SNAPSHOT TPB's for R/W WAIT SNAPSHOT transaction. .. data:: ISOLATION_LEVEL_SERIALIZABLE .. data:: ISOLATION_LEVEL_SNAPSHOT_TABLE_STABILITY TPB's for R/W WAIT SNAPSHOT TABLE STABILITY transaction. .. data:: ISOLATION_LEVEL_READ_COMMITED_RO TPB for R/O WAIT READ COMMITTED RECORD VERSION transaction. .. data:: MAX_BLOB_SEGMENT_SIZE .. data:: charset_map Python dictionary that maps InterBase character set names (key) to Python character sets (value). Exceptions ========== .. autoexception:: Warning :show-inheritance: .. autoexception:: Error :show-inheritance: .. autoexception:: InterfaceError :show-inheritance: .. autoexception:: DatabaseError :show-inheritance: .. autoexception:: DataError :show-inheritance: .. autoexception:: OperationalError :show-inheritance: .. autoexception:: IntegrityError :show-inheritance: .. autoexception:: InternalError :show-inheritance: .. autoexception:: ProgrammingError :show-inheritance: .. autoexception:: NotSupportedError :show-inheritance: .. autoexception:: TransactionConflict :show-inheritance: This is the exception inheritance layout:: StandardError |__Warning |__Error |__InterfaceError |__DatabaseError |__DataError |__OperationalError |__IntegrityError |__InternalError |__ProgrammingError |__NotSupportedError Functions ========= .. autofunction:: connect .. autofunction:: create_database .. autofunction:: load_api Classes ======= Connection ---------- .. autoclass:: Connection :member-order: groupwise :members: :inherited-members: .. autoclass:: ConnectionWithSchema :member-order: groupwise :members: :undoc-members: .. note:: For list of methods see :class:`interbase.schema.Schema`. Cursor ------ .. autoclass:: Cursor :member-order: groupwise :members: :inherited-members: :undoc-members: Transaction ----------- .. autoclass:: Transaction :member-order: groupwise :members: :inherited-members: :undoc-members: PreparedStatement ----------------- .. autoclass:: PreparedStatement :member-order: groupwise :members: :inherited-members: :undoc-members: ConnectionGroup --------------- .. autoclass:: ConnectionGroup :member-order: groupwise :members: :inherited-members: :undoc-members: TransactionContext ------------------ .. autoclass:: TransactionContext :member-order: groupwise :members: :inherited-members: :undoc-members: EventConduit ------------ .. autoclass:: EventConduit :member-order: groupwise :members: :inherited-members: :undoc-members: BlobReader ---------- .. autoclass:: BlobReader :member-order: groupwise :members: :inherited-members: :undoc-members: TPB --- .. autoclass:: TPB :member-order: groupwise :members: :undoc-members: TableReservation ---------------- .. autoclass:: TableReservation :member-order: groupwise :members: :inherited-members: :undoc-members: Internally used classes exposed to driver users =============================================== .. module:: interbase.ibcore :synopsis: Implementation of InterBase driver RowMapping ---------- .. autoclass:: _RowMapping :member-order: groupwise :members: :inherited-members: :undoc-members: EventBlock ---------- .. autoclass:: EventBlock :member-order: groupwise :members: :inherited-members: :undoc-members: .. _services_api: Services ======== .. module:: interbase.services :synopsis: Submodule for work with InterBase Services Module globals -------------- .. data:: SHUT_LEGACY .. data:: SHUT_NORMAL .. data:: SHUT_MULTI .. data:: SHUT_SINGLE .. data:: SHUT_FULL These constants are to be passed as the `shutdown_mode` parameter to :meth:`Connection.shutdown` and :meth:`Connection.bring_online`. .. data:: SHUT_FORCE .. data:: SHUT_DENY_NEW_TRANSACTIONS .. data:: SHUT_DENY_NEW_ATTACHMENTS These constants are to be passed as the `shutdown_method` parameter to :meth:`Connection.shutdown` .. data:: WRITE_FORCED .. data:: WRITE_BUFFERED These constants are to be passed as the `mode` parameter to :meth:`Connection.setWriteMode` .. data:: ACCESS_READ_WRITE .. data:: ACCESS_READ_ONLY These constants are to be passed as the `mode` parameter to :meth:`Connection.setAccessMode` .. data:: CAPABILITY_MULTI_CLIENT .. data:: CAPABILITY_REMOTE_HOP .. data:: CAPABILITY_SERVER_CONFIG .. data:: CAPABILITY_QUOTED_FILENAME .. data:: CAPABILITY_NO_SERVER_SHUTDOWN These constants are return values of :meth:`Connection.get_server_capabilities` Functions --------- .. autofunction:: connect Connection ---------- .. autoclass:: Connection :member-order: groupwise :members: :inherited-members: :undoc-members: User ---- .. autoclass:: User :member-order: groupwise :members: :inherited-members: :undoc-members: Database schema =============== .. module:: interbase.schema :synopsis: Submodule for work with database metadata (schema) Functions --------- .. autofunction:: get_grants .. autofunction:: isKeyword Schema ------ .. autoclass:: Schema :member-order: groupwise :members: :inherited-members: :undoc-members: BaseSchemaItem -------------- .. autoclass:: BaseSchemaItem :member-order: groupwise :members: :inherited-members: :undoc-members: Collation --------- .. autoclass:: Collation :member-order: groupwise :members: :inherited-members: :undoc-members: CharacterSet ------------ .. autoclass:: CharacterSet :member-order: groupwise :members: :inherited-members: :undoc-members: DatabaseException ----------------- .. autoclass:: DatabaseException :member-order: groupwise :members: :inherited-members: :undoc-members: Index ----- .. autoclass:: Index :member-order: groupwise :members: :inherited-members: :undoc-members: TableColumn ----------- .. autoclass:: TableColumn :member-order: groupwise :members: :inherited-members: :undoc-members: ViewColumn ---------- .. autoclass:: ViewColumn :member-order: groupwise :members: :inherited-members: :undoc-members: Domain ------ .. autoclass:: Domain :member-order: groupwise :members: :inherited-members: :undoc-members: Dependency ---------- .. autoclass:: Dependency :member-order: groupwise :members: :inherited-members: :undoc-members: Constraint ---------- .. autoclass:: Constraint :member-order: groupwise :members: :inherited-members: :undoc-members: Table ----- .. autoclass:: Table :member-order: groupwise :members: :inherited-members: :undoc-members: View ---- .. autoclass:: View :member-order: groupwise :members: :inherited-members: :undoc-members: Trigger ------- .. autoclass:: Trigger :member-order: groupwise :members: :inherited-members: :undoc-members: ProcedureParameter ------------------ .. autoclass:: ProcedureParameter :member-order: groupwise :members: :inherited-members: :undoc-members: Procedure --------- .. autoclass:: Procedure :member-order: groupwise :members: :inherited-members: :undoc-members: Role ---- .. autoclass:: Role :member-order: groupwise :members: :inherited-members: :undoc-members: FunctionArgument ---------------- .. autoclass:: FunctionArgument :member-order: groupwise :members: :inherited-members: :undoc-members: Function -------- .. autoclass:: Function :member-order: groupwise :members: :inherited-members: :undoc-members: DatabaseFile ------------ .. autoclass:: DatabaseFile :member-order: groupwise :members: :inherited-members: :undoc-members: Shadow ------ .. autoclass:: Shadow :member-order: groupwise :members: :inherited-members: :undoc-members: Privilege ------------- .. autoclass:: Privilege :member-order: groupwise :members: :inherited-members: :undoc-members: SchemaVisitor ------------- .. autoclass:: SchemaVisitor :member-order: groupwise :members: :inherited-members: :undoc-members: Utilities ========= .. module:: interbase.utils :synopsis: Submodule with various classes and functions Functions --------- .. autofunction:: update_meta .. autofunction:: iter_class_properties .. autofunction:: iter_class_variables .. autofunction:: embed_attributes LateBindingProperty ------------------- .. autoclass:: LateBindingProperty :member-order: groupwise :members: Iterator -------- .. autoclass:: Iterator :member-order: groupwise :members: __iter__, next, __next__ :inherited-members: :undoc-members: EmbeddedProperty ---------------- .. autoclass:: EmbeddedProperty :member-order: groupwise :members: EmbeddedAttribute ----------------- .. autoclass:: EmbeddedAttribute :member-order: groupwise :members: .. module:: interbase.blr :synopsis: Python ctypes interface to InterBase client library (BLR) .. module:: interbase.ibase :synopsis: Python ctypes interface to InterBase client library ctypes interface to InterBase client library ============================================ :ref:`ctypes ` interface to `gds.so/dylib` and `gds32/ibclient64.dll` is defined in submodule :mod:`interbase.ibase` and :mod:`interbase.blr`. .. autoclass:: ibclient_API :member-order: groupwise :members: