type ¶

Type definitions for the package.

Classes:

Name	Description
`DBAccess`	Enumeration of access modes for FirebirdSQL connections.
`CompletedTransaction`	Represents a completed transaction in a database.
`ExecuteError`	Exception raised when an error occurs during the transaction execution.

Attributes:

Name	Type	Description
`FBTypes`		Type alias for the possible types of data returned by a FirebirdSQL query.
`Dataset`		Type alias for a list of dictionaries representing a dataset.

FBTypes `module-attribute` ¶

FBTypes = str | float | datetime | None

Type alias for the possible types of data returned by a FirebirdSQL query.

Dataset = list[dict[str, FBTypes]]

Type alias for a list of dictionaries representing a dataset.

Bases: IntEnum

Enumeration of access modes for FirebirdSQL connections.

Attributes:

Name	Type	Description
`READ_ONLY`		Read-only access mode.
`READ_WRITE`		Read-write access mode.

Represents a completed transaction in a database.

Attributes:

Name	Type	Description
`host`	`str`	The host address of the server.
`port`	`int`	The port number of the server.
`db`	`str`	The database where the transaction was executed.
`user`	`str`	The user who executed the transaction.
`access`	`str`	The access mode used for the transaction.
`returncode`	`int`	The return code of the transaction execution.
`exception`	`str`	The exception message if the transaction failed.
`query`	`str`	The SQL query executed in the transaction.
`params`	`tuple`	The parameters used in the SQL query.
`time`	`float`	The number of seconds it took to execute the transaction.
`data`	`Dataset`	The data returned by the transaction, represented as a list of dictionaries.

Exception raised when an error occurs during the transaction execution.