Expand description
§my-lsm-db
Eine kleine, eingebettete LSM-Key-Value-Datenbank mit typisierter Entitäts-Schicht, optimistischer Nebenläufigkeit (CAS), Transaktionen, Composite-Indexen, Queries/Aggregationen sowie dateibasiertem Backup/Restore.
§Welche API soll ich nutzen?
entity::EntityStoreist die empfohlene High-Level-API: typisierte Entitäten, Collections, Indizes, Queries, CAS und Transaktionen. Einstieg hier.Databaseist die Low-Level-KV-Engine (rohe Byte-Keys/Values, Compaction, Manifest-Introspektion). Die meisten Anwendungen benötigen sie nicht.
§Schnelleinstieg
Siehe das intro-Beispiel (cargo run --example intro) und
CHANGELOG.md.
§Format & Kompatibilität
Die On-Disk-Format-Version ist 1. Jeder v1.x-Release liest Datenbanken,
die von einem beliebigen v1.x- (sowie Legacy-v1-)Binary geschrieben
wurden. Ein künftiges Format 2 wird mit
error::Error::UnsupportedFormatVersion abgewiesen und erfordert ein
explizites Migrationswerkzeug. Details in CHANGELOG.md
(Abschnitt Compatibility Policy).
Modules§
- codec
- Typed Value Codec — ein eindeutiges, versionierbares Binärformat für
Entitäts-Werte. Format:
[type tag u8][payload]. - compaction
- entity
- Entity-Layer über der KV-Engine.
- error
- index
- Secondary Indexes über der KV-Engine.
- iterator
- keycodec
- Binäres Key-Encoding für Entity-Keys. Kein String-Kleben — ein echtes, length-/type-sicheres Format, damit Keys auch bei Sonderzeichen in IDs eindeutig bleiben.
- lsmql
- LSMQL — eine kleine, read-only Query Language über
my-lsm-db. - manifest
- memtable
- ordering
- Order-preserving Encoding für Index-Werte.
- query
- Query-Schicht über der Entity-/Index-Layer (v0.5).
- schema
- Persistente Field-/Collection-Registry.
- sstable
- version
- DB-weiter Format-Versionierungsvertrag (v0.9).
- wal
Structs§
- Database
- Low-Level-KV-Engine (nicht die empfohlene Anwendungs-API).
- DbOptions
View - Kopie der wirksamen Compaction-/Engine-Optionen.
- Direct
Mutator - Mutator direkt auf der committeten Engine (nicht-transaktionaler Pfad).
- Manifest
Summary - Strukturelle Zusammenfassung des Manifests (Snapshot, nicht mutierend).
- Options
- Konfiguration der Datenbank.
- Segment
Info - Eine Segment-Information aus dem Manifest (Snapshot, nicht mutierend).
- Table
Info - Detail-Informationen zu einer physischen Tabelle.
Constants§
- DEFAULT_
L0_ COMPACT_ THRESHOLD - Ab wie vielen Tabellen in Level 0 kompaktiert wird.
- DEFAULT_
MEMTABLE_ LIMIT - Standard-Größe der MemTable, bei der geflusht wird.
- DEFAULT_
SEGMENT_ MAX_ RECORDS - Standard-Record-Obergrenze pro L1-Segment (Split-Regel §11.2 der Design-Spez: deterministisch, keine Größensteuerung). Größenordnung im Bereich des MemTable-Limits.
Traits§
- Mutator
- Abstraktion über eine KV-Sicht für Reads + Writes. Einerseits die direkte
(committete) Engine (
DirectMutator), andererseits eine Transaktions-Sicht mit Pending-Overlay (TxMutator). So teilen sich nicht-transaktionale und transaktionale Pfade dieselbe Entity-/Index-Logik.
Type Aliases§
- Scan
Stream - Sortierter, lazy Scan-Stream über eine Mutator-Sicht.