ob-mysql 0.1.0__tar.gz

ob_mysql-0.1.0/.gitignore

@@ -0,0 +1,35 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+dist/
+build/
+*.egg-info/
+*.egg
+.eggs/
+.venv/
+venv/
+.env
+*.db
+*.duckdb
+*.sqlite3
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+htmlcov/
+.coverage
+.coverage.*
+*.log
+.DS_Store
+.claude/
+security/
+infra/
+site/
+scripts/
+.mcpregistry_github_token
+.mcpregistry_registry_token
+_*/
+blog/
+review*
+design/
+examples/test*

ob_mysql-0.1.0/CLAUDE.md

@@ -0,0 +1,87 @@
+# ob-mysql — OrionBelt Semantic Layer Driver for MySQL
+
+## Purpose
+
+PEP 249 DB-API 2.0 driver wrapping `mysql-connector-python >= 8.0` that intercepts OBML YAML
+queries, compiles them to MySQL SQL via the OrionBelt REST API (standalone mode), and executes
+them natively.
+
+Unlike the postgres driver (which uses ADBC for native Arrow), this driver fetches rows via
+`mysql-connector-python` tuples and converts to PyArrow Tables on demand in `fetch_arrow_table()`.
+
+**OB dialect string:** `"mysql"`
+**Author:** Ralf Becher / RALFORION d.o.o. (info@orionbelt.ai)
+**License:** Apache 2.0
+
+---
+
+## Module Map
+
+| File | Responsibility |
+|---|---|
+| `__init__.py` | PEP 249 connect() + module constants |
+| `connection.py` | Connection class |
+| `cursor.py` | Cursor class — OBML detection + execution + Arrow conversion |
+| `compiler.py` | Re-export from ob-driver-core (OBML detection + REST compilation) |
+| `exceptions.py` | PEP 249 exception hierarchy (re-export from ob-driver-core) |
+| `type_codes.py` | PEP 249 type objects + MySQL field type mapping |
+
+---
+
+## connect() Parameters
+
+### MySQL-specific
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| host | str | localhost | MySQL host |
+| port | int | 3306 | MySQL port |
+| database | str | — | Database name |
+| user | str | None | Username |
+| password | str | None | Password |
+| ssl_ca | str | None | Path to CA cert |
+| ssl_cert | str | None | Path to client cert |
+| ssl_key | str | None | Path to client key |
+| charset | str | utf8mb4 | Character set |
+
+### OrionBelt parameters (same across all vendors)
+| Parameter | Default | Description |
+|---|---|---|
+| ob_api_url | http://localhost:8000 | OB REST API URL (must be running in single-model mode) |
+| ob_timeout | 30 | HTTP timeout in seconds |
+
+---
+
+## Vendor-Specific Notes
+
+- `mysql-connector-python` uses `%s` (format) paramstyle
+- No official Apache ADBC MySQL driver exists. A third-party option
+  ([Columnar `adbc-drivers/mysql`](https://github.com/columnar-com/adbc-drivers), Apache-2.0,
+  Oct 2025) is available but installed via `dbc install mysql`, not a standalone PyPI package.
+  Current approach uses `mysql-connector-python` with emulated `fetch_arrow_table()` for stability.
+  Re-evaluate if a first-party ADBC driver becomes available or Columnar publishes to PyPI.
+- `commit()` and `rollback()` are meaningful — MySQL uses real transactions
+- Default charset is `utf8mb4` for full Unicode support
+- MySQL 8.0+ required (CTE support)
+- `group_concat_max_len` may need increasing for large LISTAGG results
+
+---
+
+## Type System
+
+`mysql-connector-python` cursor.description returns field type constants as integers.
+`MYSQL_TYPE_MAP` maps common MySQL field types to PEP 249 type objects:
+- 0=DECIMAL, 1=TINY, 3=LONG, 4=FLOAT, 5=DOUBLE, 8=LONGLONG → NUMBER
+- 7=TIMESTAMP, 10=DATE, 11=TIME, 12=DATETIME → DATETIME
+- 15=VARCHAR, 253=VAR_STRING, 254=STRING → STRING
+- 249-252=BLOB variants → BINARY
+
+---
+
+## Dependencies
+
+```toml
+[project.dependencies]
+mysql-connector-python = ">=8.0"
+pyarrow = ">=16.0"
+ob-driver-core = ">=0.1"
+```

ob_mysql-0.1.0/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/.

ob_mysql-0.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: ob-mysql
+Version: 0.1.0
+Summary: OrionBelt Semantic Layer driver for MySQL 8.0+ (DB-API 2.0)
+Author-email: Ralf Becher <info@orionbelt.ai>
+License: BSL-1.1
+License-File: LICENSE
+Keywords: db-api,mysql,obml,orionbelt,semantic-layer
+Requires-Python: >=3.12
+Requires-Dist: mysql-connector-python>=8.0
+Requires-Dist: ob-driver-core>=0.1
+Requires-Dist: pyarrow>=16.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-mysql
+
+OrionBelt Semantic Layer driver for MySQL 8.0+ (DB-API 2.0)
+
+Part of the [OrionBelt Semantic Layer](https://github.com/ralfbecher/orionbelt-semantic-layer) project.
+
+## Installation
+
+```bash
+pip install ob-mysql
+```
+
+## License
+
+BSL-1.1 — see [LICENSE](LICENSE) for details.

ob_mysql-0.1.0/README.md

@@ -0,0 +1,15 @@
+# ob-mysql
+
+OrionBelt Semantic Layer driver for MySQL 8.0+ (DB-API 2.0)
+
+Part of the [OrionBelt Semantic Layer](https://github.com/ralfbecher/orionbelt-semantic-layer) project.
+
+## Installation
+
+```bash
+pip install ob-mysql
+```
+
+## License
+
+BSL-1.1 — see [LICENSE](LICENSE) for details.

ob_mysql-0.1.0/pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "ob-mysql"
+version = "0.1.0"
+description = "OrionBelt Semantic Layer driver for MySQL 8.0+ (DB-API 2.0)"
+license = { text = "BSL-1.1" }
+readme = "README.md"
+authors = [{ name = "Ralf Becher", email = "info@orionbelt.ai" }]
+keywords = ["mysql", "semantic-layer", "obml", "db-api", "orionbelt"]
+requires-python = ">=3.12"
+dependencies = [
+    "ob-driver-core>=0.1",
+    "mysql-connector-python>=8.0",
+    "pyarrow>=16.0",
+]
+
+[project.optional-dependencies]
+sqlalchemy = ["sqlalchemy>=2.0"]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "mypy>=1.10",
+    "ruff>=0.4",
+    "respx>=0.21",
+]
+
+[project.entry-points."sqlalchemy.dialects"]
+"ob.mysql" = "ob_mysql.dialect:OBMySQLDialect"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/ob_mysql"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "ANN"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+files = ["src/ob_mysql"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+markers = ["integration: requires live DB + OB API"]
+addopts = "-m 'not integration'"

ob_mysql-0.1.0/src/ob_mysql/__init__.py

@@ -0,0 +1,133 @@
+"""ob-mysql — OrionBelt Semantic Layer driver for MySQL 8.0+ (PEP 249 DB-API 2.0).
+
+Uses ``mysql-connector-python`` for database access.  OBML queries are compiled
+to MySQL SQL via the OrionBelt REST API running in single-model mode.
+
+``fetch_arrow_table()`` is emulated by fetching rows and converting to a
+PyArrow Table (no native Arrow support in mysql-connector-python).
+
+Usage::
+
+    import ob_mysql
+
+    conn = ob_mysql.connect(database="mydb", user="me", password="secret")
+    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 mysql.connector  # type: ignore[import-untyped]
+
+from ob_mysql.connection import Connection
+from ob_mysql.exceptions import (
+    DatabaseError,
+    DataError,
+    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 = "format"  # mysql-connector-python uses %s placeholders
+
+
+def connect(
+    dsn: str | None = None,
+    *,
+    host: str = "localhost",
+    port: int = 3306,
+    database: str = "mysql",
+    user: str | None = None,
+    password: str | None = None,
+    ssl_ca: str | None = None,
+    ssl_cert: str | None = None,
+    ssl_key: str | None = None,
+    charset: str = "utf8mb4",
+    # OrionBelt parameters
+    ob_api_url: str = "http://localhost:8000",
+    ob_timeout: int = 30,
+) -> Connection:
+    """Open a MySQL connection with OBML support.
+
+    Parameters
+    ----------
+    dsn : str, optional
+        Not used for MySQL — provided for API consistency with other drivers.
+    host : str
+        MySQL host (default: ``localhost``).
+    port : int
+        MySQL port (default: ``3306``).
+    database : str
+        Database name (default: ``mysql``).
+    user : str, optional
+        Username.
+    password : str, optional
+        Password.
+    ssl_ca : str, optional
+        Path to CA certificate file.
+    ssl_cert : str, optional
+        Path to client certificate file.
+    ssl_key : str, optional
+        Path to client key file.
+    charset : str
+        Character set (default: ``utf8mb4`` for full Unicode support).
+    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.
+    """
+    kwargs: dict[str, Any] = {
+        "host": host,
+        "port": port,
+        "database": database,
+        "charset": charset,
+    }
+    if user is not None:
+        kwargs["user"] = user
+    if password is not None:
+        kwargs["password"] = password
+
+    # SSL configuration — only add non-None values
+    if ssl_ca:
+        kwargs["ssl_ca"] = ssl_ca
+    if ssl_cert:
+        kwargs["ssl_cert"] = ssl_cert
+    if ssl_key:
+        kwargs["ssl_key"] = ssl_key
+
+    native = mysql.connector.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_mysql-0.1.0/src/ob_mysql/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_mysql-0.1.0/src/ob_mysql/connection.py

@@ -0,0 +1,65 @@
+"""PEP 249 Connection wrapping ``mysql.connector.connection``."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ob_mysql.cursor import Cursor
+from ob_mysql.exceptions import ProgrammingError
+
+
+class Connection:
+    """DB-API 2.0 connection that wraps a mysql-connector-python connection.
+
+    OBML queries are compiled to MySQL SQL via the OrionBelt REST API.
+    ``fetch_arrow_table()`` is emulated by fetching rows and converting
+    to a PyArrow Table (mysql-connector-python has no native Arrow support).
+    """
+
+    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_mysql-0.1.0/src/ob_mysql/cursor.py

@@ -0,0 +1,173 @@
+"""PEP 249 Cursor with OBML interception for MySQL.
+
+Uses ``mysql-connector-python`` for database access.  Unlike the ADBC-based
+PostgreSQL driver, ``fetch_arrow_table()`` is emulated by fetching all rows
+via ``fetchall()`` and converting to a PyArrow Table using column metadata.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ob_mysql.compiler import compile_obml, is_obml, parse_obml
+from ob_mysql.exceptions import NotSupportedError, ProgrammingError
+from ob_mysql.type_codes import MYSQL_TYPE_MAP, STRING
+
+
+class Cursor:
+    """DB-API 2.0 cursor that intercepts OBML YAML queries.
+
+    If the query is OBML, it is compiled to MySQL SQL via the OrionBelt
+    REST API before execution. Plain SQL is passed through unchanged.
+
+    ``fetch_arrow_table()`` converts row results to a PyArrow Table.
+    """
+
+    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[0]
+            type_code = col[1]
+            mapped = MYSQL_TYPE_MAP.get(type_code, STRING) if isinstance(type_code, int) else STRING
+            cols.append((name, mapped, None, None, None, None, None))
+        return tuple(cols)
+
+    @property
+    def rowcount(self) -> int:
+        return self._native.rowcount  # type: ignore[no-any-return]
+
+    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="mysql",
+            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.
+
+        mysql-connector-python has no native Arrow support, so this method
+        fetches all rows via ``fetchall()`` and converts them to a PyArrow
+        Table using column names from ``description``.
+        """
+        import pyarrow as pa
+
+        self._check_open()
+        rows = self._native.fetchall()
+        desc = self._native.description or []
+        col_names = [col[0] for col in desc]
+
+        if not rows:
+            # Return empty table with correct schema
+            arrays = [pa.array([], type=pa.utf8()) for _ in col_names]
+            return pa.table(dict(zip(col_names, arrays, strict=True)))
+
+        # Transpose rows to columns and let PyArrow infer types
+        columns: dict[str, list[Any]] = {name: [] for name in col_names}
+        for row in rows:
+            for i, name in enumerate(col_names):
+                columns[name].append(row[i])
+
+        return pa.table(columns)
+
+    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) -> int | None:
+        """Return the last inserted row ID."""
+        return self._native.lastrowid  # type: ignore[no-any-return]
+
+    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_mysql-0.1.0/src/ob_mysql/exceptions.py

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

ob_mysql-0.1.0/src/ob_mysql/type_codes.py

@@ -0,0 +1,47 @@
+"""PEP 249 type objects — re-exported from ob-driver-core plus MySQL field type mapping.
+
+mysql-connector-python cursor.description returns integer field type constants.
+The MYSQL_TYPE_MAP maps common field types to PEP 249 type objects.
+
+MySQL field type constants:
+https://dev.mysql.com/doc/dev/mysql-server/latest/field__types_8h.html
+"""
+
+from __future__ import annotations
+
+from ob_driver_core.type_codes import BINARY, DATETIME, NUMBER, ROWID, STRING
+
+__all__ = ["STRING", "BINARY", "NUMBER", "DATETIME", "ROWID", "MYSQL_TYPE_MAP"]
+
+# Common MySQL field type IDs from the wire protocol
+MYSQL_TYPE_MAP: dict[int, object] = {
+    # Numeric types
+    0: NUMBER,  # DECIMAL
+    1: NUMBER,  # TINY (tinyint)
+    2: NUMBER,  # SHORT (smallint)
+    3: NUMBER,  # LONG (int)
+    4: NUMBER,  # FLOAT
+    5: NUMBER,  # DOUBLE
+    8: NUMBER,  # LONGLONG (bigint)
+    9: NUMBER,  # INT24 (mediumint)
+    16: NUMBER,  # BIT
+    246: NUMBER,  # NEWDECIMAL
+    # Date/time types
+    7: DATETIME,  # TIMESTAMP
+    10: DATETIME,  # DATE
+    11: DATETIME,  # TIME
+    12: DATETIME,  # DATETIME
+    13: DATETIME,  # YEAR
+    14: DATETIME,  # NEWDATE
+    # String types
+    6: STRING,  # NULL
+    15: STRING,  # VARCHAR
+    245: STRING,  # JSON
+    253: STRING,  # VAR_STRING
+    254: STRING,  # STRING
+    # Binary types
+    249: BINARY,  # TINY_BLOB
+    250: BINARY,  # MEDIUM_BLOB
+    251: BINARY,  # LONG_BLOB
+    252: BINARY,  # BLOB
+}

ob_mysql-0.1.0/tests/test_driver.py

@@ -0,0 +1,406 @@
+"""Unit tests for the ob-mysql DB-API 2.0 driver.
+
+All tests mock mysql.connector — no live MySQL needed.
+OBML tests additionally mock the REST API call to ``/v1/query/sql``.
+"""
+
+from __future__ import annotations
+
+from collections import namedtuple
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+import ob_mysql
+from ob_mysql.connection import Connection
+from ob_mysql.exceptions import NotSupportedError, ProgrammingError
+from ob_mysql.type_codes import DATETIME, NUMBER, STRING
+
+# ---------------------------------------------------------------------------
+# Helper to build a mock mysql.connector connection
+# ---------------------------------------------------------------------------
+
+# mysql-connector description columns
+MysqlColumn = namedtuple(
+    "Column",
+    ["name", "type_code", "display_size", "internal_size", "precision", "scale", "null_ok"],
+)
+
+
+def _make_mock_native() -> MagicMock:
+    """Return a mock mysql.connector connection."""
+    mock_conn = MagicMock()
+    mock_cursor = MagicMock()
+    mock_conn.cursor.return_value = mock_cursor
+    # Default: no results
+    mock_cursor.description = None
+    mock_cursor.rowcount = -1
+    mock_cursor.fetchone.return_value = None
+    mock_cursor.fetchall.return_value = []
+    mock_cursor.fetchmany.return_value = []
+    mock_cursor.lastrowid = None
+    return mock_conn
+
+
+def _mock_api_response(sql: str) -> MagicMock:
+    """Create a mock httpx response returning the given SQL."""
+    resp = MagicMock()
+    resp.is_success = True
+    resp.json.return_value = {"sql": sql}
+    return resp
+
+
+# ---------------------------------------------------------------------------
+# PEP 249 module-level constants
+# ---------------------------------------------------------------------------
+
+
+def test_apilevel() -> None:
+    assert ob_mysql.apilevel == "2.0"
+
+
+def test_threadsafety() -> None:
+    assert ob_mysql.threadsafety == 1
+
+
+def test_paramstyle() -> None:
+    assert ob_mysql.paramstyle == "format"
+
+
+# ---------------------------------------------------------------------------
+# connect()
+# ---------------------------------------------------------------------------
+
+
+def test_connect_returns_connection() -> None:
+    with patch("mysql.connector.connect") as mock_connect:
+        mock_connect.return_value = _make_mock_native()
+        conn = ob_mysql.connect(database="testdb", user="testuser")
+        assert isinstance(conn, Connection)
+        mock_connect.assert_called_once()
+        kwargs = mock_connect.call_args.kwargs
+        assert kwargs["database"] == "testdb"
+        assert kwargs["user"] == "testuser"
+
+
+def test_connect_default_port() -> None:
+    with patch("mysql.connector.connect") as mock_connect:
+        mock_connect.return_value = _make_mock_native()
+        ob_mysql.connect()
+        kwargs = mock_connect.call_args.kwargs
+        assert kwargs["port"] == 3306
+
+
+def test_connect_default_charset() -> None:
+    with patch("mysql.connector.connect") as mock_connect:
+        mock_connect.return_value = _make_mock_native()
+        ob_mysql.connect()
+        kwargs = mock_connect.call_args.kwargs
+        assert kwargs["charset"] == "utf8mb4"
+
+
+def test_connect_context_manager() -> None:
+    with patch("mysql.connector.connect") as mock_connect:
+        mock_native = _make_mock_native()
+        mock_connect.return_value = mock_native
+        with ob_mysql.connect() as conn:
+            assert isinstance(conn, Connection)
+        mock_native.close.assert_called_once()
+
+
+# ---------------------------------------------------------------------------
+# Connection
+# ---------------------------------------------------------------------------
+
+
+def test_connection_close_is_idempotent() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    conn.close()
+    conn.close()  # should not raise
+    mock_native.close.assert_called_once()
+
+
+def test_connection_cursor_after_close_raises() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    conn.close()
+    with pytest.raises(ProgrammingError, match="closed"):
+        conn.cursor()
+
+
+def test_connection_commit() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    conn.commit()
+    mock_native.commit.assert_called_once()
+
+
+def test_connection_rollback() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    conn.rollback()
+    mock_native.rollback.assert_called_once()
+
+
+# ---------------------------------------------------------------------------
+# Cursor — plain SQL
+# ---------------------------------------------------------------------------
+
+
+def test_cursor_execute_calls_native() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    with conn.cursor() as cur:
+        cur.execute("SELECT 1")
+        mock_native.cursor().execute.assert_called_once_with("SELECT 1")
+
+
+def test_cursor_execute_with_params() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    with conn.cursor() as cur:
+        cur.execute("SELECT %s + %s", [3, 4])
+        mock_native.cursor().execute.assert_called_once_with("SELECT %s + %s", [3, 4])
+
+
+def test_cursor_execute_returns_self() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    with conn.cursor() as cur:
+        result = cur.execute("SELECT 1")
+        assert result is cur
+
+
+def test_cursor_description() -> None:
+    mock_native = _make_mock_native()
+    mock_cursor = mock_native.cursor()
+    mock_cursor.description = [
+        MysqlColumn("num", 3, None, None, None, None, None),  # LONG → NUMBER
+        MysqlColumn("txt", 253, None, None, None, None, None),  # VAR_STRING → STRING
+        MysqlColumn("dt", 12, None, None, None, None, None),  # DATETIME → DATETIME
+    ]
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    desc = cur.description
+    assert desc is not None
+    assert len(desc) == 3
+    assert all(len(col) == 7 for col in desc)
+    assert desc[0][0] == "num"
+    assert desc[0][1] == NUMBER
+    assert desc[1][0] == "txt"
+    assert desc[1][1] == STRING
+    assert desc[2][0] == "dt"
+    assert desc[2][1] == DATETIME
+
+
+def test_cursor_description_none_before_execute() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().description = None
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    assert cur.description is None
+
+
+def test_cursor_fetchone() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().fetchone.return_value = (42,)
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    row = cur.fetchone()
+    assert row == (42,)
+
+
+def test_cursor_fetchone_exhausted() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().fetchone.return_value = None
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    assert cur.fetchone() is None
+
+
+def test_cursor_fetchall() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().fetchall.return_value = [(1, "a"), (2, "b"), (3, "c")]
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    rows = cur.fetchall()
+    assert len(rows) == 3
+    assert rows[0] == (1, "a")
+
+
+def test_cursor_fetchmany() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().fetchmany.return_value = [(1,), (2,), (3,)]
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    batch = cur.fetchmany(3)
+    assert len(batch) == 3
+    mock_native.cursor().fetchmany.assert_called_with(3)
+
+
+def test_cursor_iteration() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().fetchone.side_effect = [(0,), (1,), (2,), None]
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    rows = list(cur)
+    assert len(rows) == 3
+    assert rows[0] == (0,)
+
+
+def test_cursor_close_then_fetch_raises() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    cur.close()
+    with pytest.raises(ProgrammingError, match="closed"):
+        cur.fetchone()
+
+
+def test_cursor_executemany_plain_sql() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    cur.executemany("INSERT INTO t VALUES (%s, %s)", [(1, "a"), (2, "b")])
+    assert mock_native.cursor().execute.call_count == 2
+
+
+def test_cursor_executemany_obml_raises() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    obml = "select:\n  dimensions:\n    - Region\n  measures:\n    - Revenue\n"
+    with pytest.raises(NotSupportedError, match="executemany"):
+        cur.executemany(obml, [])
+
+
+def test_cursor_setinputsizes_noop() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    cur.setinputsizes([])  # should not raise
+
+
+def test_cursor_setoutputsize_noop() -> None:
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    cur.setoutputsize(1000)  # should not raise
+
+
+def test_cursor_lastrowid() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().lastrowid = 42
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    assert cur.lastrowid == 42
+
+
+def test_cursor_rowcount() -> None:
+    mock_native = _make_mock_native()
+    mock_native.cursor().rowcount = 5
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    assert cur.rowcount == 5
+
+
+# ---------------------------------------------------------------------------
+# Cursor — OBML queries (mocked REST API)
+# ---------------------------------------------------------------------------
+
+
+def test_obml_compile_and_execute() -> None:
+    """OBML query is compiled via REST API then executed on MySQL."""
+    mock_native = _make_mock_native()
+    compiled_sql = "SELECT `region`, SUM(`amount`) AS `revenue` FROM `orders` GROUP BY `region`"
+    mock_native.cursor().description = [
+        MysqlColumn("region", 253, None, None, None, None, None),
+        MysqlColumn("revenue", 5, None, None, None, None, None),
+    ]
+    mock_native.cursor().fetchall.return_value = [
+        ("EMEA", 300.0),
+        ("APAC", 150.0),
+        ("AMER", 550.0),
+    ]
+    conn = Connection(mock_native)
+    with patch("httpx.post", return_value=_mock_api_response(compiled_sql)):
+        with conn.cursor() as cur:
+            cur.execute("select:\n  dimensions:\n    - Region\n  measures:\n    - Revenue\n")
+            rows = cur.fetchall()
+            assert len(rows) == 3
+            # Verify the compiled SQL was passed to native cursor
+            mock_native.cursor().execute.assert_called_once_with(compiled_sql)
+
+
+def test_obml_rest_dialect_is_mysql() -> None:
+    """REST API is called with dialect=mysql."""
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    compiled_sql = "SELECT 1"
+    with patch("httpx.post", return_value=_mock_api_response(compiled_sql)) as mock_post:
+        with conn.cursor() as cur:
+            cur.execute("select:\n  measures:\n    - Revenue\n")
+            url = mock_post.call_args.args[0]
+            assert "/v1/query/sql" in url
+            assert mock_post.call_args.kwargs["params"] == {"dialect": "mysql"}
+
+
+def test_obml_custom_api_url() -> None:
+    """Custom ob_api_url is forwarded to the REST call."""
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native, ob_api_url="http://my-api:9000")
+    compiled_sql = "SELECT 1"
+    with patch("httpx.post", return_value=_mock_api_response(compiled_sql)) as mock_post:
+        with conn.cursor() as cur:
+            cur.execute("select:\n  measures:\n    - Revenue\n")
+            url = mock_post.call_args.args[0]
+            assert url == "http://my-api:9000/v1/query/sql"
+
+
+def test_plain_sql_passthrough() -> None:
+    """Plain SQL is passed through without OBML compilation — no REST call."""
+    mock_native = _make_mock_native()
+    conn = Connection(mock_native)
+    with patch("httpx.post") as mock_post, conn.cursor() as cur:
+        cur.execute("SELECT COUNT(*) FROM orders")
+        mock_post.assert_not_called()
+        mock_native.cursor().execute.assert_called_once_with("SELECT COUNT(*) FROM orders")
+
+
+# ---------------------------------------------------------------------------
+# fetch_arrow_table()
+# ---------------------------------------------------------------------------
+
+
+def test_fetch_arrow_table() -> None:
+    """fetch_arrow_table() converts rows to PyArrow Table."""
+    mock_native = _make_mock_native()
+    mock_cursor = mock_native.cursor()
+    mock_cursor.description = [
+        MysqlColumn("id", 3, None, None, None, None, None),
+        MysqlColumn("name", 253, None, None, None, None, None),
+    ]
+    mock_cursor.fetchall.return_value = [(1, "Alice"), (2, "Bob")]
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    table = cur.fetch_arrow_table()
+    assert table.num_rows == 2
+    assert table.num_columns == 2
+    assert table.column_names == ["id", "name"]
+
+
+def test_fetch_arrow_table_empty() -> None:
+    """fetch_arrow_table() returns empty table with correct columns."""
+    mock_native = _make_mock_native()
+    mock_cursor = mock_native.cursor()
+    mock_cursor.description = [
+        MysqlColumn("id", 3, None, None, None, None, None),
+        MysqlColumn("name", 253, None, None, None, None, None),
+    ]
+    mock_cursor.fetchall.return_value = []
+    conn = Connection(mock_native)
+    cur = conn.cursor()
+    table = cur.fetch_arrow_table()
+    assert table.num_rows == 0
+    assert table.column_names == ["id", "name"]

ob_mysql-0.1.0/tests/test_yaml_detection.py

@@ -0,0 +1,34 @@
+"""Unit tests for OBML YAML detection — no external services required."""
+
+import pytest
+
+from ob_mysql.compiler import is_obml, parse_obml
+
+
+@pytest.mark.parametrize(
+    ("query", "expected"),
+    [
+        ("select:\n  dimensions:\n    - Region\n  measures:\n    - Revenue\n", True),
+        ("select:\n  measures:\n    - Revenue\n", True),
+        ("select:\n  dimensions:\n    - Country\n", True),
+        ("SELECT:\n  dimensions:\n    - X\n", True),
+        ("   select:\n  dimensions:\n    - X\n", True),
+        ("SELECT * FROM orders", False),
+        ("SELECT id\nFROM customers WHERE id = 1", False),
+        ("", False),
+        ("model:\n  name: test\n", False),
+        ("select:\n  filters:\n    - x = 1\n", False),
+        ("select:\n  - [unclosed", False),
+        ("select:\n  - dimension1\n", False),
+    ],
+)
+def test_obml_detection(query: str, expected: bool) -> None:
+    assert is_obml(query) == expected
+
+
+def test_parse_obml_returns_dict() -> None:
+    q = "select:\n  dimensions:\n    - Region\n  measures:\n    - Revenue\nlimit: 100\n"
+    result = parse_obml(q)
+    assert result["select"]["dimensions"] == ["Region"]
+    assert result["select"]["measures"] == ["Revenue"]
+    assert result["limit"] == 100