ob-snowflake 0.1.0__py3-none-any.whl

ob_snowflake/__init__.py

@@ -0,0 +1,127 @@
+"""ob-snowflake — OrionBelt Semantic Layer driver for Snowflake (PEP 249 DB-API 2.0).
+
+Requires the OrionBelt REST API running in single-model mode (MODEL_FILE set).
+OBML queries are compiled to SQL via ``POST /v1/query/sql``.
+
+Usage::
+
+    import ob_snowflake
+
+    conn = ob_snowflake.connect(
+        account="xy12345.eu-west-1",
+        user="me",
+        password="secret",
+        database="MYDB",
+        warehouse="COMPUTE_WH",
+    )
+    with conn.cursor() as cur:
+        cur.execute("select:\\n  dimensions:\\n    - Region\\n  measures:\\n    - Revenue")
+        print(cur.fetchall())
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import snowflake.connector
+
+from ob_snowflake.connection import Connection
+from ob_snowflake.exceptions import (
+    DataError,
+    DatabaseError,
+    Error,
+    IntegrityError,
+    InterfaceError,
+    InternalError,
+    NotSupportedError,
+    OperationalError,
+    ProgrammingError,
+    Warning,
+)
+
+# PEP 249 module-level constants
+apilevel = "2.0"
+threadsafety = 1  # threads may share the module but not connections
+paramstyle = "pyformat"  # snowflake-connector-python uses %(name)s and %s
+
+
+def connect(
+    account: str,
+    *,
+    user: str | None = None,
+    password: str | None = None,
+    database: str | None = None,
+    schema: str | None = None,
+    warehouse: str | None = None,
+    role: str | None = None,
+    authenticator: str | None = None,
+    # OrionBelt parameters
+    ob_api_url: str = "http://localhost:8000",
+    ob_timeout: int = 30,
+) -> Connection:
+    """Open a Snowflake connection with OBML support.
+
+    Parameters
+    ----------
+    account : str
+        Snowflake account identifier (e.g. ``xy12345.eu-west-1``).
+    user : str, optional
+        Username.
+    password : str, optional
+        Password.
+    database : str, optional
+        Default database.
+    schema : str, optional
+        Default schema.
+    warehouse : str, optional
+        Virtual warehouse.
+    role : str, optional
+        Snowflake role.
+    authenticator : str, optional
+        Authentication method (e.g. ``"externalbrowser"`` for SSO).
+    ob_api_url : str
+        OrionBelt REST API URL (must be running in single-model mode).
+    ob_timeout : int
+        HTTP timeout in seconds for OBML compilation.
+    """
+    connect_kwargs: dict[str, Any] = {"account": account}
+    if user is not None:
+        connect_kwargs["user"] = user
+    if password is not None:
+        connect_kwargs["password"] = password
+    if database is not None:
+        connect_kwargs["database"] = database
+    if schema is not None:
+        connect_kwargs["schema"] = schema
+    if warehouse is not None:
+        connect_kwargs["warehouse"] = warehouse
+    if role is not None:
+        connect_kwargs["role"] = role
+    if authenticator is not None:
+        connect_kwargs["authenticator"] = authenticator
+
+    native = snowflake.connector.connect(**connect_kwargs)
+    return Connection(
+        native,
+        ob_api_url=ob_api_url,
+        ob_timeout=ob_timeout,
+    )
+
+
+__all__ = [
+    "apilevel",
+    "threadsafety",
+    "paramstyle",
+    "connect",
+    "Connection",
+    "Warning",
+    "Error",
+    "InterfaceError",
+    "DatabaseError",
+    "DataError",
+    "OperationalError",
+    "IntegrityError",
+    "InternalError",
+    "ProgrammingError",
+    "NotSupportedError",
+]

ob_snowflake/compiler.py

@@ -0,0 +1,8 @@
+"""OrionBelt compilation bridge — delegates to ob-driver-core."""
+
+from __future__ import annotations
+
+from ob_driver_core.compiler import compile_obml
+from ob_driver_core.detection import is_obml, parse_obml
+
+__all__ = ["compile_obml", "is_obml", "parse_obml"]

ob_snowflake/connection.py

@@ -0,0 +1,64 @@
+"""PEP 249 Connection wrapping ``snowflake.connector.connection.SnowflakeConnection``."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ob_snowflake.cursor import Cursor
+from ob_snowflake.exceptions import ProgrammingError
+
+
+class Connection:
+    """DB-API 2.0 connection that wraps a native Snowflake connector connection.
+
+    OBML queries are compiled to SQL via the OrionBelt REST API
+    (single-model mode, ``/v1/query/sql`` shortcut).
+    """
+
+    def __init__(
+        self,
+        native: Any,
+        *,
+        ob_api_url: str = "http://localhost:8000",
+        ob_timeout: int = 30,
+    ) -> None:
+        self._native = native
+        self._closed = False
+        self._ob_api_url = ob_api_url
+        self._ob_timeout = ob_timeout
+
+    def _check_open(self) -> None:
+        if self._closed:
+            raise ProgrammingError("Connection is closed.")
+
+    def cursor(self) -> Cursor:
+        """Return a new Cursor for this connection."""
+        self._check_open()
+        native_cursor = self._native.cursor()
+        return Cursor(
+            native_cursor,
+            ob_api_url=self._ob_api_url,
+            ob_timeout=self._ob_timeout,
+        )
+
+    def commit(self) -> None:
+        """Commit the current transaction."""
+        self._check_open()
+        self._native.commit()
+
+    def rollback(self) -> None:
+        """Rollback the current transaction."""
+        self._check_open()
+        self._native.rollback()
+
+    def close(self) -> None:
+        """Close the connection."""
+        if not self._closed:
+            self._native.close()
+            self._closed = True
+
+    def __enter__(self) -> Connection:
+        return self
+
+    def __exit__(self, *exc: object) -> None:
+        self.close()

ob_snowflake/cursor.py

@@ -0,0 +1,149 @@
+"""PEP 249 Cursor with OBML interception for Snowflake."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ob_snowflake.compiler import compile_obml, is_obml, parse_obml
+from ob_snowflake.exceptions import NotSupportedError, ProgrammingError
+from ob_snowflake.type_codes import SF_TYPE_MAP, STRING
+
+
+class Cursor:
+    """DB-API 2.0 cursor that intercepts OBML YAML queries.
+
+    If the query is OBML, it is compiled to Snowflake SQL via the OrionBelt
+    REST API before execution. Plain SQL is passed through unchanged.
+    """
+
+    arraysize: int = 1
+
+    def __init__(
+        self,
+        native: Any,
+        *,
+        ob_api_url: str = "http://localhost:8000",
+        ob_timeout: int = 30,
+    ) -> None:
+        self._native = native
+        self._closed = False
+        self._ob_api_url = ob_api_url
+        self._ob_timeout = ob_timeout
+
+    @property
+    def description(
+        self,
+    ) -> tuple[tuple[str, Any, None, None, None, None, None], ...] | None:
+        """PEP 249 cursor description — 7-item tuples per column."""
+        native_desc = self._native.description
+        if native_desc is None:
+            return None
+        cols: list[tuple[str, Any, None, None, None, None, None]] = []
+        for col in native_desc:
+            name = col.name
+            type_id = col.type_code
+            type_code = SF_TYPE_MAP.get(type_id, STRING)
+            cols.append((name, type_code, None, None, None, None, None))
+        return tuple(cols)
+
+    @property
+    def rowcount(self) -> int:
+        return self._native.rowcount
+
+    def _check_open(self) -> None:
+        if self._closed:
+            raise ProgrammingError("Cursor is closed.")
+
+    def execute(self, operation: str, parameters: Any = None) -> Cursor:
+        """Execute a query — OBML YAML or plain SQL."""
+        self._check_open()
+        sql = self._resolve_sql(operation)
+        if parameters is not None:
+            self._native.execute(sql, parameters)
+        else:
+            self._native.execute(sql)
+        return self
+
+    def executemany(self, operation: str, seq_of_parameters: Any) -> None:
+        """Execute against all parameter sequences.
+
+        OBML queries are not supported with executemany — raises NotSupportedError.
+        """
+        self._check_open()
+        if is_obml(operation):
+            raise NotSupportedError("executemany() is not supported for OBML queries.")
+        for params in seq_of_parameters:
+            self._native.execute(operation, params)
+
+    def _resolve_sql(self, operation: str) -> str:
+        """Compile OBML to SQL or return plain SQL unchanged."""
+        if not is_obml(operation):
+            return operation
+        obml = parse_obml(operation)
+        return compile_obml(
+            obml,
+            dialect="snowflake",
+            ob_api_url=self._ob_api_url,
+            ob_timeout=self._ob_timeout,
+        )
+
+    def fetchone(self) -> tuple[Any, ...] | None:
+        """Fetch the next row."""
+        self._check_open()
+        row = self._native.fetchone()
+        return tuple(row) if row is not None else None
+
+    def fetchmany(self, size: int | None = None) -> list[tuple[Any, ...]]:
+        """Fetch the next *size* rows."""
+        self._check_open()
+        n = size if size is not None else self.arraysize
+        rows = self._native.fetchmany(n)
+        return [tuple(r) for r in rows]
+
+    def fetchall(self) -> list[tuple[Any, ...]]:
+        """Fetch all remaining rows."""
+        self._check_open()
+        rows = self._native.fetchall()
+        return [tuple(r) for r in rows]
+
+    def fetch_arrow_table(self) -> Any:
+        """Fetch all remaining rows as a PyArrow Table.
+
+        Snowflake connector returns Arrow natively (zero-copy from the
+        internal result format).  Significantly more memory-efficient
+        than materialising Python row objects via ``fetchall()``.
+        """
+        self._check_open()
+        return self._native.fetch_arrow_all()
+
+    def close(self) -> None:
+        """Close the cursor."""
+        if not self._closed:
+            self._native.close()
+            self._closed = True
+
+    def setinputsizes(self, sizes: Any) -> None:
+        """No-op — required by PEP 249."""
+
+    def setoutputsize(self, size: int, column: int | None = None) -> None:
+        """No-op — required by PEP 249."""
+
+    @property
+    def lastrowid(self) -> None:
+        """Snowflake does not expose lastrowid via connector cursor."""
+        return None
+
+    def __enter__(self) -> Cursor:
+        return self
+
+    def __exit__(self, *exc: object) -> None:
+        self.close()
+
+    def __iter__(self) -> Cursor:
+        return self
+
+    def __next__(self) -> tuple[Any, ...]:
+        row = self.fetchone()
+        if row is None:
+            raise StopIteration
+        return row

ob_snowflake/exceptions.py

@@ -0,0 +1,32 @@
+"""PEP 249 exceptions — re-exported from ob-driver-core for convenience.
+
+Allows users to do: ``from ob_snowflake.exceptions import ProgrammingError``
+"""
+
+from __future__ import annotations
+
+from ob_driver_core.exceptions import (
+    DataError,
+    DatabaseError,
+    Error,
+    IntegrityError,
+    InterfaceError,
+    InternalError,
+    NotSupportedError,
+    OperationalError,
+    ProgrammingError,
+    Warning,
+)
+
+__all__ = [
+    "Warning",
+    "Error",
+    "InterfaceError",
+    "DatabaseError",
+    "DataError",
+    "OperationalError",
+    "IntegrityError",
+    "InternalError",
+    "ProgrammingError",
+    "NotSupportedError",
+]

ob_snowflake/type_codes.py

@@ -0,0 +1,29 @@
+"""PEP 249 type objects — re-exported from ob-driver-core plus Snowflake type mapping.
+
+snowflake-connector-python cursor.description returns integer type IDs as type_code.
+The SF_TYPE_MAP maps Snowflake field type IDs to PEP 249 type objects.
+"""
+
+from __future__ import annotations
+
+from ob_driver_core.type_codes import BINARY, DATETIME, NUMBER, ROWID, STRING
+
+__all__ = ["STRING", "BINARY", "NUMBER", "DATETIME", "ROWID", "SF_TYPE_MAP"]
+
+# Snowflake type IDs from snowflake.connector.constants.FIELD_ID_TO_NAME
+SF_TYPE_MAP: dict[int, object] = {
+    0: NUMBER,    # FIXED (NUMBER/INT/DECIMAL)
+    1: NUMBER,    # REAL (FLOAT)
+    2: STRING,    # TEXT (VARCHAR/STRING)
+    3: DATETIME,  # DATE
+    4: DATETIME,  # TIMESTAMP_NTZ
+    5: STRING,    # VARIANT
+    6: DATETIME,  # TIMESTAMP_LTZ
+    7: DATETIME,  # TIMESTAMP_TZ
+    8: DATETIME,  # TIMESTAMP (alias)
+    9: STRING,    # OBJECT
+    10: STRING,   # ARRAY
+    11: BINARY,   # BINARY
+    12: DATETIME, # TIME
+    13: STRING,   # BOOLEAN
+}

ob_snowflake-0.1.0.dist-info/METADATA

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: ob-snowflake
+Version: 0.1.0
+Summary: OrionBelt Semantic Layer driver for Snowflake (DB-API 2.0)
+Author-email: Ralf Becher <info@orionbelt.ai>
+License: BSL-1.1
+License-File: LICENSE
+Keywords: db-api,obml,orionbelt,semantic-layer,snowflake
+Requires-Python: >=3.12
+Requires-Dist: ob-driver-core>=0.1
+Requires-Dist: snowflake-connector-python>=3.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: sqlalchemy
+Requires-Dist: sqlalchemy>=2.0; extra == 'sqlalchemy'
+Description-Content-Type: text/markdown
+
+# ob-snowflake
+
+OrionBelt Semantic Layer driver for Snowflake (DB-API 2.0)
+
+Part of the [OrionBelt Semantic Layer](https://github.com/ralfbecher/orionbelt-semantic-layer) project.
+
+## Installation
+
+```bash
+pip install ob-snowflake
+```
+
+## License
+
+BSL-1.1 — see [LICENSE](LICENSE) for details.

ob_snowflake-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+ob_snowflake/__init__.py,sha256=lCb1hwtBk9vGzFjkdbMRXFd_jensJGjKk6_QOvWvLIE,3333
+ob_snowflake/compiler.py,sha256=WTYZzdsJJiOxgIDS3NpDOpk_SG7_0weT4el-xuuBGsE,264
+ob_snowflake/connection.py,sha256=Ywa64ikP_kLpD3vkHoHRcsdl0IIT_GinAy85b-O3kLA,1752
+ob_snowflake/cursor.py,sha256=Kddm9wSTYhrT2VdmQREiQ1HY1KJt0gW1BbeJ1g9MB-o,4819
+ob_snowflake/exceptions.py,sha256=W3j7EReU7_WQTvsgj3AFKlDg_qn7A6Vq3Z7rvrhzJqY,639
+ob_snowflake/type_codes.py,sha256=b3CKjv3nPbvlXNapC0apoFA1k0beiR1yzFe4o1dXBtg,1001
+ob_snowflake-0.1.0.dist-info/METADATA,sha256=I1ND8CsFPZeNgtrrwgImIRlFrdpNdP7JwPlMdcmq_CA,1031
+ob_snowflake-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+ob_snowflake-0.1.0.dist-info/entry_points.txt,sha256=Gsa_3yDu5LANV6IPHeEwVc5VyE16tj2xq7KUTe2oEiM,77
+ob_snowflake-0.1.0.dist-info/licenses/LICENSE,sha256=t-vr73N5s2w6yxpCnwo5r_QuB5_u6FuEovAYMjlfe7E,3378
+ob_snowflake-0.1.0.dist-info/RECORD,,

ob_snowflake-0.1.0.dist-info/WHEEL

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

ob_snowflake-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[sqlalchemy.dialects]
+ob.snowflake = ob_snowflake.dialect:OBSnowflakeDialect

ob_snowflake-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,70 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             RALFORION d.o.o.
+Licensed Work:        OrionBelt Semantic Layer 1.0
+                      The Licensed Work is (c) 2025 RALFORION d.o.o.
+Additional Use Grant: You may use the Licensed Work for any purpose,
+                      including production use, PROVIDED THAT you may
+                      not embed OrionBelt in a commercial product or
+                      provide it as part of a commercial service
+                      without purchasing a commercial license from
+                      the Licensor. Contact licensing@ralforion.com
+                      for commercial licensing inquiries.
+Change Date:          2030-03-16
+Change License:       Apache License, Version 2.0
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor of MariaDB's Business Source
+License Trademark Policy available at https://mariadb.com/bsl11/.