openframe-adapters-db-cockroachdb 0.1.0__tar.gz

openframe_adapters_db_cockroachdb-0.1.0/.gitignore

@@ -0,0 +1,222 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Miscellaneous
+.DS_Store
+.claude/

openframe_adapters_db_cockroachdb-0.1.0/PKG-INFO

@@ -0,0 +1,340 @@
+Metadata-Version: 2.5
+Name: openframe-adapters-db-cockroachdb
+Version: 0.1.0
+Summary: OpenFrame Microservice Suite — CockroachDB database adapter.
+Project-URL: Homepage, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Documentation, https://furious-meteors.github.io/openframe-adapters/
+Project-URL: Repository, https://github.com/Furious-Meteors/openframe-adapters
+Project-URL: Changelog, https://github.com/Furious-Meteors/openframe-adapters/blob/production/.github/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/Furious-Meteors/openframe-adapters/issues
+Author-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+Maintainer-email: Furious Meteors Engineering <engineering@furiousmeteors.dev>
+License: MIT
+Keywords: asyncpg,cockroachdb,hexagonal,microservice,openframe
+Requires-Python: >=3.11
+Requires-Dist: asyncpg>=0.29
+Requires-Dist: openframe-core<4,>=3.3
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openframe-adapters-db-cockroachdb
+
+CockroachDB database adapter for the **OpenFrame Microservice Suite**.
+
+Part of the `openframe-adapters` monorepo. Implements `BaseRepository[T]` and
+`HealthCheck` from `openframe-core` using `asyncpg` — the same driver used by
+`openframe-adapters-db-postgres`, because CockroachDB speaks the PostgreSQL
+wire protocol. This package is an adaptation of the Postgres adapter, not a
+from-scratch build; see "CockroachDB vs. Postgres differences" below for
+everything that is genuinely different.
+
+---
+
+## Installation
+
+```bash
+pip install openframe-adapters-db-cockroachdb
+```
+
+Required env var:
+
+```
+COCKROACHDB_URL=postgresql://user:password@host:26257/dbname
+```
+
+Note the scheme is still `postgresql://` — asyncpg only speaks the wire
+protocol, it has no notion of "CockroachDB" as a distinct backend. Point the
+URL at your CockroachDB node or load balancer exactly as you would a
+Postgres primary.
+
+---
+
+## Quick start
+
+### Raw dict mode
+
+```python
+from openframe.adapters.db.cockroachdb import CockroachdbSettings, CockroachdbRepository
+
+settings = CockroachdbSettings()  # reads COCKROACHDB_URL from env
+repo = CockroachdbRepository(settings, table="items", id_column="id")
+
+item = await repo.get("abc-123")          # dict | None
+items, total = await repo.list(10, 0)     # ([dict, ...], int)
+created = await repo.create({"name": "x"})
+updated = await repo.update({"id": "abc-123", "name": "y"})
+deleted = await repo.delete("abc-123")    # bool
+```
+
+### Typed domain mode
+
+```python
+from dataclasses import dataclass
+from openframe.adapters.db.cockroachdb import CockroachdbSettings, CockroachdbRepository
+
+@dataclass
+class Item:
+    id: str
+    name: str
+
+class ItemRepository(CockroachdbRepository[Item]):
+    _table = "items"
+    _id_column = "id"
+
+    def _row_to_entity(self, row) -> Item:
+        return Item(**dict(row))
+
+    def _entity_to_row(self, entity: Item) -> dict:
+        return {"id": entity.id, "name": entity.name}
+
+settings = CockroachdbSettings()
+repo = ItemRepository(settings)
+item: Item | None = await repo.get("abc-123")
+```
+
+---
+
+## Wiring into an application
+
+For a real service, wire `CockroachdbPlugin` (the `BasePort`-satisfying
+plugin class) through `ApplicationBootstrap.compose()` from `openframe-core`.
+This gives you proper lifecycle management — `initialize()` / `health()` /
+`shutdown()` — for free, instead of constructing `CockroachdbRepository`
+directly and managing the pool yourself:
+
+```python
+from openframe.core.runtime import ApplicationBootstrap
+from openframe.core.ports import Capability
+from openframe.adapters.db.cockroachdb import CockroachdbPlugin, CockroachdbSettings
+
+settings = CockroachdbSettings()  # reads COCKROACHDB_URL from env
+plugin = CockroachdbPlugin(settings, table="items", id_column="id")
+
+async with ApplicationBootstrap.compose(plugin) as app:
+    repo = app.get(Capability.PERSISTENCE)   # -> CockroachdbRepository
+    item = await repo.get("abc-123")
+# pool is closed automatically on exit (plugin.shutdown() ran)
+```
+
+`compose()` calls `plugin.initialize()` on entry and `plugin.shutdown()` on
+exit, so the pool is created, health-checked, and torn down without any
+manual lifecycle code. Requires `openframe-core>=3.3`.
+
+Reach for a subclassed `ApplicationBootstrap` (with a `configure()` method)
+only when you need per-port `config=`/`init_timeout=` or conditional
+registration order; use `app.registry` as an escape hatch for anything
+neither tier covers. The `CockroachdbRepository(settings)` construction
+shown above under "Quick start" remains valid for tests, scripts, or any
+context that doesn't need plugin lifecycle management.
+
+---
+
+## Raw driver access for niche features
+
+The adapter never hides asyncpg. Access it directly for anything the port
+does not cover:
+
+```python
+from openframe.adapters.db.cockroachdb import get_cockroachdb_pool
+
+class OrderRepository(CockroachdbRepository[Order]):
+    _table     = "orders"
+    _id_column = "id"
+
+    async def bulk_upsert(self, orders: list[Order]) -> None:
+        pool = await get_cockroachdb_pool(self._settings)
+        async with pool.acquire() as conn:
+            async with conn.transaction():
+                for o in orders:
+                    await conn.execute(
+                        "UPSERT INTO orders (id, total) VALUES ($1, $2)",
+                        o.id, o.total,
+                    )
+```
+
+---
+
+## CockroachDB vs. Postgres differences
+
+CockroachDB speaks the same wire protocol as Postgres, so connection
+pooling, the asyncpg exception hierarchy used for connection-vs-query
+classification, and health checks (`SELECT 1`) are all identical to the
+Postgres adapter. Two real differences matter at the schema/transaction
+boundary:
+
+### No `SERIAL`/`BIGSERIAL`
+
+CockroachDB does not implement Postgres's `SERIAL`/`BIGSERIAL`
+auto-increment column types the same way. If your schema uses `SERIAL`
+against a real CockroachDB cluster, it likely will not behave as you
+expect. The idiomatic CockroachDB primary-key patterns are:
+
+```sql
+-- UUID primary key (recommended default)
+id UUID PRIMARY KEY DEFAULT gen_random_uuid()
+
+-- or, if you want an integer key
+id INT PRIMARY KEY DEFAULT unique_rowid()
+```
+
+This adapter does not translate or rewrite DDL — it only issues the DML
+your repository methods construct against whatever schema already exists.
+Design your `CREATE TABLE` statements with CockroachDB's own primary-key
+conventions, not a copy-pasted Postgres schema.
+
+### CockroachDB transaction retries (SQLSTATE 40001)
+
+CockroachDB always runs at `SERIALIZABLE` isolation (there is no lower
+isolation level to opt into). Under contention this can produce a
+retryable "transaction retry error" — SQLSTATE `40001`, with
+`restart transaction` in the error message — that requires the **client**
+to retry the *entire* transaction, not just the failing statement.
+
+This adapter's basic CRUD methods (`get`/`list`/`create`/`update`/`delete`)
+each execute as an implicit single-statement transaction, so this class of
+error is rare in practice for simple single-statement operations — there is
+no multi-statement transaction for CockroachDB to need to restart.
+
+However, if you use this package's "raw driver access" pattern (above) to
+run your **own** explicit multi-statement transaction via
+`conn.transaction()`, you are responsible for retrying it on SQLSTATE
+`40001`:
+
+```python
+import asyncpg
+
+async def transfer_funds(pool, from_id: str, to_id: str, amount: int) -> None:
+    for attempt in range(5):
+        try:
+            async with pool.acquire() as conn:
+                async with conn.transaction():
+                    await conn.execute(
+                        "UPDATE accounts SET balance = balance - $1 WHERE id = $2",
+                        amount, from_id,
+                    )
+                    await conn.execute(
+                        "UPDATE accounts SET balance = balance + $1 WHERE id = $2",
+                        amount, to_id,
+                    )
+            return
+        except asyncpg.PostgresError as exc:
+            if getattr(exc, "sqlstate", None) == "40001":
+                continue  # retry the whole transaction
+            raise
+    raise RuntimeError("transfer_funds: exhausted retries on SQLSTATE 40001")
+```
+
+This adapter deliberately does **not** implement automatic retry inside its
+own CRUD methods — that would be a surprising, undocumented behavior change
+from how the Postgres adapter behaves for the same driver calls. The
+difference is documented here so callers doing their own multi-statement
+transactions know it exists and can implement the retry loop themselves.
+
+Everything else about this adapter — connection pooling, asyncpg exception
+classification, health checks — is unchanged from the Postgres adapter.
+
+---
+
+## Configuration
+
+All settings are read from environment variables.
+
+| Env var | Type | Default | Description |
+|---|---|---|---|
+| `COCKROACHDB_URL` | `str` | **required** | Full asyncpg DSN (`postgresql://` scheme) pointed at a CockroachDB cluster |
+| `POOL_SIZE` | `int` | `10` | Pool min/max size |
+| `POOL_MAX_INACTIVE_CONN_LIFETIME` | `float` | `300.0` | Idle connection TTL (s) |
+| `POOL_COMMAND_TIMEOUT` | `float` | `60.0` | Per-statement timeout (s) |
+| `POOL_MAX_QUERIES` | `int` | `50000` | Queries per connection before recycle |
+| `CONNECTION_TIMEOUT` | `float` | `30.0` | Pool creation timeout (s) |
+| `OPERATION_TIMEOUT` | `float` | `10.0` | Per-operation timeout (s) |
+| `MAX_RETRIES` | `int` | `3` | Max retry attempts |
+
+---
+
+## Health checks
+
+`CockroachdbRepository` implements the `HealthCheck` protocol from `openframe-core`.
+
+```python
+health = await repo.health()   # PluginHealth snapshot — the sole health check, never raises
+```
+
+---
+
+## Exception hierarchy
+
+All exceptions are `AdapterError` subclasses from `openframe.core.exceptions`.
+Raw `asyncpg` exceptions never escape the adapter.
+
+| Situation | Exception |
+|---|---|
+| Cannot connect to CockroachDB | `AdapterConnectionError` |
+| Invalid `COCKROACHDB_URL` catalog | `AdapterConfigurationError` |
+| Query failed (constraint, syntax, SQLSTATE 40001, etc.) | `AdapterQueryError` |
+| Entity not found | `AdapterNotFoundError` |
+| Operation exceeded timeout | `AdapterTimeoutError` |
+
+A CockroachDB SQLSTATE `40001` transaction-retry error surfaces as
+`AdapterQueryError` like any other in-band query failure — see "CockroachDB
+transaction retries" above for why this adapter does not retry it
+automatically, and how to retry it yourself for explicit multi-statement
+transactions.
+
+---
+
+## Development
+
+```bash
+# from the package directory
+pip install -e ".[dev]"
+python -m pytest tests/ -v
+```
+
+---
+
+## Protocol conformance
+
+```python
+from openframe.core.ports import BaseRepository
+from openframe.core.health import HealthCheck
+
+repo = CockroachdbRepository(settings, table="items", id_column="id")
+assert isinstance(repo, BaseRepository)   # True — structural check
+assert isinstance(repo, HealthCheck)      # True — structural check
+```
+
+No inheritance from either Protocol is required or used.
+
+---
+
+## Resilience — circuit breaking under sustained failure
+
+`openframe-core>=3.4` ships `openframe.core.resilience.CircuitBreakerProxy` —
+wrap the repository to short-circuit calls after repeated failures instead
+of blocking every caller until `operation_timeout` during a sustained
+outage. No adapter code changes are needed to support this — it composes
+from the outside exactly like `TracingProxy`:
+
+```python
+from openframe.core.resilience import CircuitBreakerProxy
+from openframe.core.tracing import TracingProxy
+
+repo = CircuitBreakerProxy(
+    TracingProxy(app.get(Capability.PERSISTENCE).get_repository(), prefix="repository.item"),
+    failure_threshold=5,
+    reset_timeout=30.0,
+)
+```
+
+Wrap the traced repository, not the reverse — a short-circuited call never
+reaches the adapter, so it shouldn't produce a misleading adapter span.
+
+---
+
+## License
+
+MIT