Skip to main content

Crate rushdb_types

Crate rushdb_types 

Source
Expand description

Canonical value model, identifiers, key layout, encodings, and the maintained-key constants shared by storage, LMPG, and the query engine.

This crate defines the vocabulary every other crate agrees on: tenant and record/relationship identities, the order-preserving scalar encoding used by occurrence values and range scans, and the byte-exact key constructors (for example keys::occ_key and keys::presence_key). Keeping the key layout here is what lets a persisted database remain readable across engine versions.

Re-exports§

pub use error::TypesError;

Modules§

command
Replicated command batches, mutations and preconditions.
command_codec
Binary codec of command::CommitBatch for the WAL, outcome payloads and replication. The one binary encoding of a CommitBatch (SD-7.3): WAL command envelopes, retry-outcome payloads and replication records all carry these bytes.
datetime
Canonical date/datetime parsing and formatting helpers. Canonical Date/Datetime handling backed by Chrono’s ISO-8601 calendar implementation. RushDB stores instants as UTC epoch milliseconds.
encoding
Order-preserving byte encodings for the scalar value model.
error
Error type shared by the canonical type layer.
hash
Stable hashing helpers and hash domains.
ids
Tenant, record, relationship and dense-ordinal identifiers.
index
Declared secondary indexes. Declared secondary indexes: the client chooses what is fast.
keys
Byte-exact key constructors for the tenant keyspace.
model
Logical types, catalog state, cardinality and nullability.
names
Name tokens and spelling similarity for labels and properties. Names of labels and properties compared the way people misspell them: tokens split on case and separators with plural endings dropped, then a spelling score. Shared by the catalog’s name suggestions and SQL’s “did you mean” errors.
occurrence
Occurrence rows, headers and property/embedding metadata.
security
Canonical tenant policy payloads for authorization. Canonical tenant policy payload shared by admission, replay and readers.
stats
Planner value-distribution summaries (estimates, never results). Planner value-distribution summaries: estimates only, never query results.
value
Scalar value model and JSON conversion helpers.
value_match
Matching a search text against stored values. Matching a search text against stored values: contains, prefix, exact and similar (near spellings), and dates written in another layout. The wire form is rushdb_protocol::ValueSearch; this is the engine’s side of it, shared by the value dictionaries, the facet scan and the cross-property value search.

Type Aliases§

Result
Convenience alias for a std::result::Result over TypesError.