firebirdsql-run 2.0.0a0

Firebirdsql wrapper inspired by subprocess.run

firebirdsql-run

Firebirdsql wrapper inspired by subprocess.run

Installation

pip install firebirdsql-run

Examples

• Execute a transaction

result = execute(query="SELECT * FROM table", db="database")
print(result.data)  # Output: List of dictionaries containing the query results

• Execute a transaction with custom parameters and an existing connection

conn = connection(db="/path/to/database.fdb")
result = execute("INSERT INTO customers (name, age) VALUES (?, ?)", params=("John", 25), use_conn=conn)
print(result.returncode)  # Output: 0 (success)
conn.close()

Representation of a completed transaction

• Table

maker	model	type
B	1121	PC
A	1232	PC

• Success example

CompletedTransaction(
    host="127.0.0.1",
    db="database",
    user="TWUSER",
    access="READ_ONLY",
    returncode=0,
    exception="",
    query="SELECT * FROM table",
    params=(),
    data=[
        {"maker": "B", "model": 1121, "type": "PC"},
        {"maker": "A", "model": 1232, "type": "PC"},
    ],
)

• Error example

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=(),
    data=[],
)

Env variables

FIREBIRD_KEY=

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