sqlalchemy-firebird-async 0.1.0__py2.py3-none-any.whl

sqlalchemy_firebird_async/fdb.py

@@ -0,0 +1,115 @@
+import asyncio
+from functools import partial
+
+from sqlalchemy.util.concurrency import await_only
+
+
+class AsyncCursor:
+    def __init__(self, sync_cursor, loop):
+        self._sync_cursor = sync_cursor
+        self._loop = loop
+
+    def execute(self, operation, parameters=None):
+        if parameters is None:
+            func = partial(self._sync_cursor.execute, operation)
+        else:
+            func = partial(self._sync_cursor.execute, operation, parameters)
+        await_only(self._loop.run_in_executor(None, func))
+        return self
+
+    def executemany(self, operation, seq_of_parameters):
+        func = partial(self._sync_cursor.executemany, operation, seq_of_parameters)
+        await_only(self._loop.run_in_executor(None, func))
+        return self
+
+    def fetchone(self):
+        return await_only(self._loop.run_in_executor(None, self._sync_cursor.fetchone))
+
+    def fetchmany(self, size=None):
+        if size is None:
+            return await_only(self._loop.run_in_executor(None, self._sync_cursor.fetchmany))
+        func = partial(self._sync_cursor.fetchmany, size)
+        return await_only(self._loop.run_in_executor(None, func))
+
+    def fetchall(self):
+        return await_only(self._loop.run_in_executor(None, self._sync_cursor.fetchall))
+
+    def close(self):
+        return await_only(self._loop.run_in_executor(None, self._sync_cursor.close))
+
+    def __getattr__(self, name):
+        return getattr(self._sync_cursor, name)
+
+
+class AsyncConnection:
+    def __init__(self, sync_connection, loop):
+        self._sync_connection = sync_connection
+        self._loop = loop
+
+    def cursor(self):
+        return AsyncCursor(self._sync_connection.cursor(), self._loop)
+
+    def commit(self):
+        await_only(self._loop.run_in_executor(None, self._sync_connection.commit))
+
+    def rollback(self):
+        await_only(self._loop.run_in_executor(None, self._sync_connection.rollback))
+
+    def close(self):
+        await_only(self._loop.run_in_executor(None, self._sync_connection.close))
+
+    def __getattr__(self, name):
+        return getattr(self._sync_connection, name)
+
+
+class AsyncDBAPI:
+    def __init__(self, sync_dbapi):
+        self._sync_dbapi = sync_dbapi
+        self.paramstyle = getattr(sync_dbapi, "paramstyle", "qmark")
+        self.apilevel = getattr(sync_dbapi, "apilevel", "2.0")
+        self.threadsafety = getattr(sync_dbapi, "threadsafety", 0)
+        for attr in (
+            "Warning",
+            "Error",
+            "InterfaceError",
+            "DatabaseError",
+            "DataError",
+            "OperationalError",
+            "IntegrityError",
+            "InternalError",
+            "ProgrammingError",
+            "NotSupportedError",
+        ):
+            if hasattr(sync_dbapi, attr):
+                setattr(self, attr, getattr(sync_dbapi, attr))
+
+    def connect(self, *args, **kwargs):
+        async_creator_fn = kwargs.pop("async_creator_fn", None)
+        loop = asyncio.get_running_loop()
+        if async_creator_fn is not None:
+            sync_conn = await_only(async_creator_fn(*args, **kwargs))
+        else:
+            func = partial(self._sync_dbapi.connect, *args, **kwargs)
+            sync_conn = await_only(loop.run_in_executor(None, func))
+        return AsyncConnection(sync_conn, loop)
+
+from sqlalchemy.pool import AsyncAdaptedQueuePool
+import sqlalchemy_firebird.fdb as fdb
+
+
+class AsyncFDBDialect(fdb.FBDialect_fdb):
+    name = "firebird.fdb_async"
+    driver = "fdb_async"
+    is_async = True
+    supports_statement_cache = False
+    poolclass = AsyncAdaptedQueuePool
+
+    @classmethod
+    def import_dbapi(cls):
+        import fdb as sync_fdb
+
+        return AsyncDBAPI(sync_fdb)
+
+    @classmethod
+    def dbapi(cls):
+        return cls.import_dbapi()

sqlalchemy_firebird_async/firebirdsql.py

@@ -0,0 +1,184 @@
+import asyncio
+
+from sqlalchemy import util
+from sqlalchemy.pool import AsyncAdaptedQueuePool
+from sqlalchemy.util.concurrency import await_only
+
+import firebirdsql
+import firebirdsql.aio as aio
+import sqlalchemy_firebird.fdb as fdb
+
+
+def _await_if_needed(value):
+    if asyncio.iscoroutine(value):
+        try:
+            return await_only(value)
+        except StopAsyncIteration:
+            return None
+    return value
+
+
+class AsyncPyfbCursor:
+    def __init__(self, async_cursor):
+        self._async_cursor = async_cursor
+
+    def execute(self, operation, parameters=None):
+        if parameters is None:
+            _await_if_needed(self._async_cursor.execute(operation))
+        else:
+            _await_if_needed(self._async_cursor.execute(operation, parameters))
+        return self
+
+    def executemany(self, operation, seq_of_parameters):
+        _await_if_needed(self._async_cursor.executemany(operation, seq_of_parameters))
+        return self
+
+    def fetchone(self):
+        return _await_if_needed(self._async_cursor.fetchone())
+
+    def fetchmany(self, size=None):
+        # firebirdsql fetchmany signature is fetchmany(self, size=None)
+        # but if size is passed it must be used.
+        return _await_if_needed(self._async_cursor.fetchmany(size))
+
+    def fetchall(self):
+        return _await_if_needed(self._async_cursor.fetchall())
+
+    def close(self):
+        return _await_if_needed(self._async_cursor.close())
+
+    async def _async_soft_close(self):
+        # SQLAlchemy 2.0 calls this.
+        pass
+
+    def __getattr__(self, name):
+        return getattr(self._async_cursor, name)
+
+
+class AsyncPyfbConnection:
+    def __init__(self, async_connection):
+        self._async_connection = async_connection
+
+    def cursor(self):
+        return AsyncPyfbCursor(self._async_connection.cursor())
+
+    def commit(self):
+        _await_if_needed(self._async_connection.commit())
+
+    def rollback(self):
+        _await_if_needed(self._async_connection.rollback())
+
+    def close(self):
+        try:
+            return _await_if_needed(self._async_connection.close())
+        except BlockingIOError:
+            sock = getattr(self._async_connection, "sock", None)
+            raw_sock = getattr(sock, "_sock", None)
+            if raw_sock is not None:
+                try:
+                    raw_sock.setblocking(True)
+                except Exception:
+                    pass
+            try:
+                return self._async_connection.close()
+            except Exception:
+                if raw_sock is not None:
+                    try:
+                        raw_sock.close()
+                    except Exception:
+                        pass
+                return None
+
+    def __getattr__(self, name):
+        return getattr(self._async_connection, name)
+
+
+class AsyncPyfbDBAPI:
+    def __init__(self):
+        self.paramstyle = getattr(firebirdsql, "paramstyle", "qmark")
+        self.apilevel = getattr(firebirdsql, "apilevel", "2.0")
+        self.threadsafety = getattr(firebirdsql, "threadsafety", 0)
+        for attr in (
+            "Warning",
+            "Error",
+            "InterfaceError",
+            "DatabaseError",
+            "DataError",
+            "OperationalError",
+            "IntegrityError",
+            "InternalError",
+            "ProgrammingError",
+            "NotSupportedError",
+        ):
+            if hasattr(firebirdsql, attr):
+                setattr(self, attr, getattr(firebirdsql, attr))
+
+    def connect(self, *args, **kwargs):
+        async_creator_fn = kwargs.pop("async_creator_fn", None)
+        if async_creator_fn is None:
+            async_creator_fn = aio.connect
+        async_connection = await_only(async_creator_fn(*args, **kwargs))
+        return AsyncPyfbConnection(async_connection)
+
+    def Binary(self, value):
+        return firebirdsql.Binary(value)
+
+
+class AsyncFirebirdSQLDialect(fdb.FBDialect_fdb):
+    name = "firebird.firebirdsql_async"
+    driver = "firebirdsql_async"
+    is_async = True
+    supports_statement_cache = False
+    poolclass = AsyncAdaptedQueuePool
+
+    @classmethod
+    def import_dbapi(cls):
+        return AsyncPyfbDBAPI()
+
+    @classmethod
+    def dbapi(cls):
+        return cls.import_dbapi()
+
+    def create_connect_args(self, url):
+        opts = url.translate_connect_args(username="user")
+        opts.update(url.query)
+        util.coerce_kw_type(opts, "port", int)
+        return ([], opts)
+
+    def _get_server_version_info(self, connection):
+        try:
+            # We must use exec_driver_sql and await the result because scalar() 
+            # on async connection returns a coroutine.
+            # But wait, 'connection' passed here is likely an AsyncAdapt_dbapi_connection
+            # wrapper which mimics sync interface but executes via greenlet_spawn?
+            # Or is it a raw connection?
+            # In asyncio dialect, _get_server_version_info is called in a sync context.
+            
+            # Let's try standard way, but safe:
+            res = connection.exec_driver_sql(
+                "select rdb$get_context('SYSTEM','ENGINE_VERSION') from rdb$database"
+            )
+            # res.scalar() is a coroutine if we are in async mode?
+            # Actually, exec_driver_sql on AsyncConnection returns a CursorResult that
+            # has sync-like interface if used inside run_sync, but here we are inside dialect method.
+            
+            # Safe way:
+            val = res.scalar()
+            if asyncio.iscoroutine(val):
+                version_str = await_only(val)
+            else:
+                version_str = val
+                
+        except Exception:
+            return (0, 0)
+            
+        if not version_str:
+            return (0, 0)
+            
+        parts = str(version_str).split(".")
+        try:
+            major = int(parts[0])
+            minor = int(parts[1]) if len(parts) > 1 else 0
+            return (major, minor)
+        except (ValueError, IndexError):
+            return (0, 0)

sqlalchemy_firebird_async-0.1.0.dist-info/METADATA

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: sqlalchemy-firebird-async
+Version: 0.1.0
+Summary: Asyncio support for Firebird in SQLAlchemy
+Project-URL: Homepage, https://github.com/attid/sqlalchemy-firebird-async
+Author-email: Igor Tolstov <attid0@gmail.com>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Database
+Requires-Dist: greenlet!=0.4.17
+Requires-Dist: sqlalchemy-firebird>=2.0.0
+Requires-Dist: sqlalchemy>=2.0.0
+Provides-Extra: all
+Requires-Dist: fdb>=2.0; extra == 'all'
+Requires-Dist: firebirdsql>=1.0; extra == 'all'
+Provides-Extra: fdb
+Requires-Dist: fdb>=2.0; extra == 'fdb'
+Provides-Extra: firebirdsql
+Requires-Dist: firebirdsql>=1.0; extra == 'firebirdsql'
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.21; extra == 'test'
+Requires-Dist: pytest>=7.0; extra == 'test'
+Requires-Dist: testcontainers>=3.7.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# sqlalchemy-firebird-async
+
+![Python Version](https://img.shields.io/pypi/pyversions/sqlalchemy-firebird-async)
+![License](https://img.shields.io/pypi/l/sqlalchemy-firebird-async)
+![Status](https://img.shields.io/pypi/status/sqlalchemy-firebird-async)
+
+**Asynchronous Firebird dialect for SQLAlchemy.**
+
+This library provides proper `asyncio` support for Firebird databases in SQLAlchemy 2.0+, allowing you to write fully asynchronous code using modern Python patterns.
+
+It supports two underlying drivers:
+1. **`fdb`** (Recommended) - Runs the official C-based driver in a thread pool. Fast and stable.
+2. **`firebirdsql`** - Pure Python asyncio driver. Currently experimental due to upstream issues.
+
+## 📦 Installation
+
+Install using pip:
+
+```bash
+# Recommended: Install with the FDB driver (Threaded, Fast)
+pip install "sqlalchemy-firebird-async[fdb]"
+
+# Install with pure python driver (Experimental)
+pip install "sqlalchemy-firebird-async[firebirdsql]"
+# Note: For correct async behavior with firebirdsql, you might need a patched version:
+# pip install git+https://github.com/attid/pyfirebirdsql.git
+```
+
+## 🚀 Quick Start
+
+### 1. Using FDB Driver (Recommended)
+
+This dialect runs the official `fdb` driver in a thread pool (`run_in_executor`). While not "truly" async at the socket level, it provides the best performance and stability currently available for Firebird in Python.
+
+**URL Scheme:** `firebird+fdb_async://`
+
+```python
+import asyncio
+from sqlalchemy.ext.asyncio import create_async_engine, async_sessionmaker
+from sqlalchemy import text
+
+async def main():
+    # Format: firebird+fdb_async://user:password@host:port/path/to/db
+    # Note: For Linux, ensure the path is absolute (e.g. //firebird/data/...)
+    dsn = "firebird+fdb_async://sysdba:masterkey@localhost:3050//firebird/data/employee.fdb"
+    
+    engine = create_async_engine(dsn, echo=True)
+
+    async with engine.begin() as conn:
+        result = await conn.execute(text("SELECT rdb$get_context('SYSTEM', 'ENGINE_VERSION') FROM rdb$database"))
+        version = result.scalar()
+        print(f"Firebird Version: {version}")
+
+    # Using AsyncSession
+    async_session = async_sessionmaker(engine, expire_on_commit=False)
+    async with async_session() as session:
+        result = await session.execute(text("SELECT count(*) FROM rdb$relations"))
+        print(f"Total tables: {result.scalar()}")
+
+    await engine.dispose()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### 2. Using Native Async Driver (firebirdsql)
+
+**Warning:** The upstream `firebirdsql` driver currently has issues with `asyncio` compatibility (bugs causing crashes or incorrect behavior).
+A patched fork is available at [attid/pyfirebirdsql](https://github.com/attid/pyfirebirdsql.git), which fixes the async logic but currently exhibits significantly lower performance (approx. 4x slower than fdb).
+
+**URL Scheme:** `firebird+firebirdsql_async://`
+
+```python
+engine = create_async_engine(
+    "firebird+firebirdsql_async://sysdba:masterkey@localhost:3050//firebird/data/employee.fdb"
+)
+```
+
+## 📊 Performance Comparison
+
+We compared both drivers executing 5000 queries in 8 concurrent tasks (4 raw SQL + 4 ORM).
+
+| Metric | **fdb (Threaded)** 🏆 | **firebirdsql (Patched)** | Difference |
+| :--- | :--- | :--- | :--- |
+| **Total Time** | **4.53s** | 116.20s | ~25x slower |
+| **Avg Query Time (ORM)** | **2.54s** | 114.43s | ~45x slower |
+| **Avg Query Time (Raw)** | **4.44s** | 116.14s | ~26x slower |
+| **Parallel Ratio** | 6.16x | 7.94x | - |
+
+*Benchmark details: 8 concurrent workers, 5000 rows each, total 40k rows.*
+
+As seen above, `fdb` in a thread pool is significantly faster for high-load scenarios.
+
+## 🔌 Connection String Guide
+
+| Driver | Protocol | URL Scheme |
+| :--- | :--- | :--- |
+| **fdb** (Recommended) | TCP/IP | `firebird+fdb_async://user:pass@host:port/db_path` |
+| **firebirdsql** | TCP/IP | `firebird+firebirdsql_async://user:pass@host:port/db_path` |
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## 📄 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

sqlalchemy_firebird_async-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+sqlalchemy_firebird_async/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlalchemy_firebird_async/fdb.py,sha256=YXBaYKX2lC3IFmfWAztwJbgZ4JsgCtFkr3rdS1jOih4,3750
+sqlalchemy_firebird_async/firebirdsql.py,sha256=oS_XE5FaebHj8A40YbiUDT5jtZWbKolO-Cjlc2pmLA0,6000
+sqlalchemy_firebird_async-0.1.0.dist-info/METADATA,sha256=2XjsYvOsinFxbvPPx2jSVhkiuQYCQhE9ptGxnA9yyJw,5208
+sqlalchemy_firebird_async-0.1.0.dist-info/WHEEL,sha256=aha0VrrYvgDJ3Xxl3db_g_MDIW-ZexDdrc_m-Hk8YY4,105
+sqlalchemy_firebird_async-0.1.0.dist-info/entry_points.txt,sha256=d6F6P0ai6bqVvRPqUJ5W0jLwHDNqLig_fDAadw4kpME,180
+sqlalchemy_firebird_async-0.1.0.dist-info/licenses/LICENSE,sha256=ESYyLizI0WWtxMeS7rGVcX3ivMezm-HOd5WdeOh-9oU,1056
+sqlalchemy_firebird_async-0.1.0.dist-info/RECORD,,

sqlalchemy_firebird_async-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

sqlalchemy_firebird_async-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[sqlalchemy.dialects]
+firebird.fdb_async = sqlalchemy_firebird_async.fdb:AsyncFDBDialect
+firebird.firebirdsql_async = sqlalchemy_firebird_async.firebirdsql:AsyncFirebirdSQLDialect

sqlalchemy_firebird_async-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.