=====================
Main driver namespace
=====================

.. module:: firebird.driver
    :synopsis: Python 3+ Database API 2.0 Compliant driver for Firebird 3+

Constants
=========

.. autodata:: __VERSION__
   :no-value:


Imports from sub-modules
========================

config
------

.. py:currentmodule:: firebird.driver.config

Globals: `driver_config`

core
----

.. py:currentmodule:: firebird.driver.core

Functions:
    `connect()`, `create_database()`, `connect_server()`, `transaction()` and `tpb()`

Translation dictionaries:
    `CHARSET_MAP`

Classes:
    `DistributedTransactionManager`, `Connection`, `Cursor`, `Server` and `TPB`

types
-----

.. py:currentmodule:: firebird.driver.types

Exceptions:
    `Warning`, `Error`, `InterfaceError`, `DatabaseError`, `DataError`,
    `OperationalError`, `IntegrityError`, `InternalError`, `ProgrammingError`
    and `NotSupportedError`

Enums:
    `NetProtocol`, `DirectoryCode`, `PageSize`, `DBKeyScope`, `DbInfoCode`, `Features`,
    `TraInfoCode`, `ReplicaMode`, `StmtInfoCode`, `TraInfoIsolation`,
    `TraInfoReadCommitted`, `TraInfoAccess`, `TraIsolation`, `TraReadCommitted`,
    `TraLockResolution`, `TraAccessMode`, `TableShareMode`, `TableAccessMode`, `Isolation`,
    `DefaultAction`, `StatementType`, `BlobType`, `DbAccessMode`, `DbSpaceReservation`,
    `DbWriteMode`, `ShutdownMode`, `OnlineMode`, `ShutdownMethod`, `CancelType`,
    `DecfloatRound` and `DecfloatTraps`

Sentinels:
     `~firebird.driver.core.TIMEOUT`

Flags:
    `ServerCapability`, `SrvRepairFlag`, `SrvStatFlag`, `SrvBackupFlag`,
    `SrvRestoreFlag`, `SrvNBackupFlag`, `ConnectionFlag` and `EncryptionFlag`

Globals and other objects required by Python DB API 2.0:
    `apilevel`, `threadsafety`, `paramstyle`, `Date`, `Time`, `Timestamp`,
    `DateFromTicks`, `TimeFromTicks`, `TimestampFromTicks`, `STRING`, `BINARY`,
    `NUMBER`, `DATETIME` and `ROWID`

Helper constants:
    `DESCRIPTION_NAME`, `DESCRIPTION_TYPE_CODE`, `DESCRIPTION_DISPLAY_SIZE`,
    `DESCRIPTION_INTERNAL_SIZE`, `DESCRIPTION_PRECISION`, `DESCRIPTION_SCALE`
    and `DESCRIPTION_NULL_OK`

Helper functions:
    `get_timezone()`

fbapi
-----

.. py:currentmodule:: firebird.driver.fbapi

Functions `load_api()` and `get_api()`.