firebirdsql-run

Firebirdsql wrapper inspired by subprocess.run

Installation • Examples • Env Variables

Installation

uv add firebirdsql-run

Examples

Execute a query with read-only access:

from firebirdsql_run import DBAccess, execute

# Execute a query with read-only access.
result = execute(query="SELECT * FROM table", db="database", access=DBAccess.READ_ONLY)

# Output: List of dictionaries containing the query results.
print(result.data)

Execute a query with parameters and log the result:

# Execute a query with parameters.
result = execute(query="INSERT INTO customers (name, age) VALUES (?, ?)", params=("John", 25))

# Log the result.
if result.returncode != 0:
    logger.error(result)
else:
    logger.info(result)

Execute a query using the existing connection:

# Create a connection object.
conn = connection(db="database", access=DBAccess.READ_ONLY)
# Execute a query using the existing connection.
result = execute(query="SELECT * FROM table", use_conn=conn)
# Close the connection.
conn.close()

# Output: Named tuple representing the completed transaction.
print(result)

An example of a successful transaction:

>>> print(result)
CompletedTransaction(
    host="127.0.0.1",
    db="database",
    user="TWUSER",
    access="READ_ONLY",
    returncode=0,
    exception="",
    query="SELECT * FROM table",
    params=(),
    time=0.001,
    data=[
        {'id': 1, 'name': 'John Doe', 'department': 'Sales'},
        {'id': 2, 'name': 'Jane Smith', 'department': 'Sales'},
    ],
)

An example of a failed transaction:

>>> print(result)
CompletedTransaction(
    host="127.0.0.1",
    db="database",
    user="TWUSER",
    access="READ_ONLY",
    returncode=1,
    exception="Dynamic SQL Error\nSQL error code = -204\nTable unknown\ntable\nAt line 1, column 15\n",
    query="SELECT * FROM table",
    params=(),
    time=0.001,
    data=[],
)

Env Variables

FIREBIRD_KEY=

The FIREBIRD_KEY environment variable can be overridden with the functions argument passwd.

Metadata

Release files for firebirdsql-run 1.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for firebirdsql-run 1.2.2
File	Size	Uploaded
firebirdsql_run-1.2.2.tar.gz	90.4 kB	Oct 11, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for firebirdsql-run 1.2.2
File	Interpreter	ABI	Platform	Reset
firebirdsql_run-1.2.2-py3-none-any.whl 6.5 kB Oct 11, 2026	Python 3	none	any	Details

Total release size: 96.9 kB

Release files / firebirdsql_run-1.2.2.tar.gz

Download URL	firebirdsql_run-1.2.2.tar.gz
Size	90.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`60cc7ecc762cc5f422b4741d3b252b35f42f71ffe60766be389c1ef8ab40b138`
BLAKE2b-256 checksum How to use checksums	`6a361a10c740247bba5bbcaca4fda5a2bb4a78764fd59309e277b1f2018e4966`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/deadnews/firebirdsql-run
Publishing commit: github.com/deadnews/firebirdsql-run/tree/f1c7e439543653e92125979974d0c7665ee794ef

Workflow

Publishing configuration: github.com/deadnews/firebirdsql-run/blob/f1c7e439543653e92125979974d0c7665ee794ef/.github/workflows/main.yml
Publishing logs: github.com/deadnews/firebirdsql-run/actions/runs/38121966905/attempts/1

Artifact

Subject: firebirdsql_run-1.2.2.tar.gz
SHA-256 checksum: 60cc7ecc762cc5f422b4741d3b252b35f42f71ffe60766be389c1ef8ab40b138 Verifying attestations

Release files / firebirdsql_run-1.2.2-py3-none-any.whl

Download URL	firebirdsql_run-1.2.2-py3-none-any.whl
Size	6.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`128e280ddd49bdad5e9d0f13051291faee8d662a899a283f6ef97350c02fdd96`
BLAKE2b-256 checksum How to use checksums	`676a742b5580b77f1d8cd74a97c6bd92231cc38ea032192052c8fe57cf248f71`
Upload date	Oct 11, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/deadnews/firebirdsql-run
Publishing commit: github.com/deadnews/firebirdsql-run/tree/f1c7e439543653e92125979974d0c7665ee794ef

Workflow

Publishing configuration: github.com/deadnews/firebirdsql-run/blob/f1c7e439543653e92125979974d0c7665ee794ef/.github/workflows/main.yml
Publishing logs: github.com/deadnews/firebirdsql-run/actions/runs/38121966905/attempts/1

Artifact

Subject: firebirdsql_run-1.2.2-py3-none-any.whl
SHA-256 checksum: 128e280ddd49bdad5e9d0f13051291faee8d662a899a283f6ef97350c02fdd96 Verifying attestations