release-readme: the root README written last, honestly — crate family table with per-engine honest postures (ADR-016 compile-time identity, deployment.md as the boundary), mem-carried usage sketch compile-checked and executed against the real API, contract-suite pointer (three engines, one pinned contract), license note; LICENSE-MIT + LICENSE-APACHE per the family pattern (substrate notice untouched per ADR-018); CHANGELOG seeded with the 0.1.0 contract-v1 entry; per-crate readme wiring decided + landed (pointer-style per-crate readmes, readme fields wired on the four published crates); honesty trace list in task Notes; task -> completed

This commit is contained in:
glm-5.3-flash committed 2026-10-11 01:32:33 +00:00
1 parent f5e0e8e199
commit 260fb31707
13 files changed
+599 -2

No files matched your search

+1
View File
@@ -4,6 +4,7 @@ version.workspace = true
edition.workspace = true
license.workspace = true
repository.workspace = true
readme = "README.md"
[dependencies]
alkstore = { version = "0.1", path = "../alkstore" }
+25
View File
@@ -0,0 +1,25 @@
# alkstore-postgres
The Postgres engine of the [alkstore](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
family: the core contract implemented on tokio-postgres +
deadpool-postgres, natively async (no blocking bridge, no
`spawn_blocking` seam), with a hand-rolled LISTEN forwarder.
```rust
let store = alkstore_postgres::open(&dsn, alkstore_postgres::PgOpts::default()).await?;
```
**Engine posture — multi-host native.** Connections are per-process
state; nothing assumes a shared host. Connection budget: `max_size`
pooled connections **+ 1 non-pooled listener connection per LISTEN-ing
process** (pooled connections cannot carry LISTEN) — size the server
for the sum. v1 TLS is effectively unavailable: the engine hardwires
`NoTls` on every connection path, so network confidentiality must come
from the deployment topology. Queue/stream/lock/schedule tables live
in one engine-owned PostgreSQL schema (default `alkstore`,
per-engine option).
See the [family README](https://git.alk.dev/alkdev/alkstore/blob/main/README.md)
for the interface and the deployment matrix, and the
[Postgres engine spec](https://git.alk.dev/alkdev/alkstore/blob/main/docs/architecture/engine-postgres.md)
for the driver's details.