Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pyo3 = { version = "0.29", features = ["abi3-py311"] }
# binding pins exact engine tags; the engine PACKAGE is corvid-db —
# bare `corvid` is an unrelated crates.io crate — its LIB ident is
# corvid, so `use corvid::…` is unchanged).
corvid-db = { git = "https://github.com/corvid-db/corvid.git", tag = "v0.3.3" }
corvid-db = { git = "https://github.com/corvid-db/corvid.git", tag = "v0.3.4" }

[dev-dependencies]
# Test-only: the variant-inventory snapshot test (src/error.rs)
Expand Down
6 changes: 3 additions & 3 deletions docs/PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ variants are additive later, decided by the FFI bench).
| --- | --- |
| The pyo3 crate (engine-binding layer AND idiom layer — see §3) | `src/*.rs` — `DbPy`/`CollectionPy`/`QueryPy`, value mapping, error mapping, predicates |
| The public package | `python/corvid/__init__.py` re-exports `corvid._native`; `__init__.pyi` + `py.typed` carry the full typing |
| The golden-suite port | `tests/test_golden.py` driving `tests/golden/*.txt` (vendored byte-identical from the v0.3.3 release — the pinned engine tag; the same fixtures the C smoke suite and corvid-node run) |
| The golden-suite port | `tests/test_golden.py` driving `tests/golden/*.txt` (vendored byte-identical from the v0.3.4 release — the pinned engine tag; the same fixtures the C smoke suite and corvid-node run) |
| Packaging | `pyproject.toml` (maturin, one cp311-abi3 wheel per platform), README (install-pending note), LICENSE (MIT), `.gitignore` |
| CI | `.github/workflows/ci.yml` — surface gate + lint + golden suite × 4 platform legs (linux-x64/arm64, macos-arm64, windows-x64) × {3.14, 3.13, 3.12, 3.11} + `maturin build` smoke |

Expand All @@ -35,7 +35,7 @@ totals test pre-scans all files for exactly 267).
Two architectures were on the table:

1. **(chosen)** A Rust pyo3 crate that links the engine crate directly
(`corvid-db = { git = "https://github.com/corvid-db/corvid.git", tag = "v0.3.3" }`
(`corvid-db = { git = "https://github.com/corvid-db/corvid.git", tag = "v0.3.4" }`
— the engine package is `corvid-db` with lib ident `corvid`; bare
`corvid` on crates.io is an unrelated crate) and exposes the OOP
surface through native pyo3 classes, built into a Python extension
Expand Down Expand Up @@ -222,4 +222,4 @@ Documented corners:
| Variadic `and_`/`or_` (trailing underscores) | Python keywords; mirrors the JS binding's variadic `and`/`or` |
| Counter + Arc exclusivity for `compact` | mirrors the ABI §4.13 gate exactly; pinned by admin.txt |
| pyo3 0.29, maturin 1.x | current crates.io stable lines |
| Vendored golden fixtures (byte-identical to the v0.3.3 tag — the pinned engine version) | stable text; the suite must run offline and per-PR (verified identical to `crates/corvid-ffi/golden/`) |
| Vendored golden fixtures (byte-identical to the v0.3.4 tag — the pinned engine version) | stable text; the suite must run offline and per-PR (verified identical to `crates/corvid-ffi/golden/`) |
4 changes: 4 additions & 0 deletions docs/SURFACE.tsv
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,10 @@ corvid::QueryBuilder::run SELECT shaping MAPPED Query.run golden:queries.txt:QVE
corvid::Db Lifecycle MAPPED Db golden:admin.txt:FILEDB
corvid::Db::open Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
corvid::Db::open_in_memory Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
corvid::Db::open_with_backend Lifecycle N/A N/A wasm-only backend seam (redb StorageBackend over custom storage): no C-ABI/native equivalent; browser-binding machinery, not constructible here
corvid::Db::collection Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
corvid::Db::backup Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
corvid::Db::backup_with_backend Lifecycle N/A N/A wasm-only backend seam (redb StorageBackend over custom storage): no C-ABI/native equivalent; browser-binding machinery, not constructible here
corvid::Db::bulk Lifecycle N/A N/A put_many covers the bulk fast path (FFI.md §9); Db::bulk not exposed
corvid::Db::compact Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
corvid::Db::collections Lifecycle MAPPED Db.open/open_memory/collection/collections/backup/compact golden:admin.txt (COLLECTIONS/BACKUP/COMPACT)
Expand All @@ -148,12 +150,14 @@ corvid::db::Page SELECT shaping MAPPED Collection.page / Page golden:mutations.t
corvid::Store Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::open Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::open_in_memory Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::open_with_backend Lifecycle N/A N/A wasm-only backend seam (redb StorageBackend over custom storage): no C-ABI/native equivalent; browser-binding machinery, not constructible here
corvid::Store::set_relaxed_durability Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::begin_bulk Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::flush Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::compact Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::next_auto_id Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::backup Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::backup_with_backend Lifecycle N/A N/A wasm-only backend seam (redb StorageBackend over custom storage): no C-ABI/native equivalent; browser-binding machinery, not constructible here
corvid::Store::transaction Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::read Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
corvid::Store::put Lifecycle N/A N/A engine low-level byte KV (Store/WriteBatch/ReadBatch); the v1 binding is typed-document only (FFI.md ruling 1)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "maturin"

[project]
name = "corvid-python"
version = "0.3.3"
version = "0.3.4"
description = "Python binding for the corvid embedded database — the engine compiled in via pyo3, exposed as idiomatic OOP"
readme = "README.md"
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion scripts/surface-gate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ SURFACE="$ROOT/docs/SURFACE.tsv"
ENGINE_REPO="corvid-db/corvid"

# The committed N/A baseline for THIS binding (see (c) above).
NA_BASELINE=155
NA_BASELINE=159

# ---- locate the engine pin ------------------------------------------------
pin=""
Expand Down