Expand description
Language-neutral contracts used by the RadixDB Rust ORM facade.
This crate deliberately has no dependency on the server, storage engine, TCP transport, or generated Rust models. Other SDKs can implement the same versioned JSON and SQL fixtures without reproducing engine internals.
Structs§
- Alter
Table Builder - Assignment
- Case
Branch - Column
- Column
Definition - Column
Descriptor - Column
Ref - Common
Table Expression - Compiled
Statement - Constraint
Descriptor - Create
Table AsBuilder - Create
Table Builder - Database
Descriptor - DdlBuilder
- Delete
- Delete
Builder - Descriptor
Envelope - Dynamic
Column - Dynamic
Entity - Dynamic
Record - Dynamic
Reference - Runtime counterpart of
Reference<T>for descriptor-driven clients. It carries only a validated target key; it never owns or loads a row. - Explain
- Expr
- Field
State - Form
Field Descriptor - Generated
Query - Generated
Rust - Generated
Value Decode Error - Index
Definition - Index
Descriptor - Insert
- Insert
Builder - IrDocument
- Migration
Preview - Named
Window - Order
- OrderBy
- Projection
- Query
Builder - Reference
- Reference
Definition - Reference
Selector - Result
Column Descriptor - Schema
Changed - Select
- SetArm
- SqlRenderer
- Table
Descriptor - Table
Form Descriptor - Typed
Column - Typed
Key - A generated one-column PRIMARY KEY or UNIQUE NOT NULL descriptor.
- Typed
Navigation - Statically rooted read-only navigation path. Each additional
field()appends one schema-validated reference edge; the server remains the final authority for catalog compatibility and rejects stale generated paths. - Update
- Update
Builder - Upsert
- View
Descriptor - Window
Frame - Window
Specification
Enums§
- Alter
Table Action - Binary
Operator - Builder
Error - Builder
Execution Error - Builder
Json Error - Builder
SqlError - Catalog
Operation - Codegen
Error - Constraint
Definition - Constraint
Definition Ir - Data
Type Descriptor - DdlOperation
- Descriptor
Error - Descriptor
Kind - Editor
Kind - Expression
- Field
Value - Float
Special - Float
Value - Foreign
KeyAction Descriptor - Generated
Record Error - Grouping
- Index
Method - IrError
- IrKind
- Join
Kind - Migration
Preview Error - Null
Placement - Operation
- Record
Error - Record
Mutation - Relation
- Render
Error - SetOperator
- Sort
Direction - Transaction
Operation - Typed
Value - Typed
Value Error - Unary
Operator - Window
Frame Bound - Window
Frame Unit
Constants§
- GUI_
TABLE_ FORM_ JSON_ SCHEMA - ORM_
CONFORMANCE_ FIXTURES - ORM_
CONFORMANCE_ MANIFEST - ORM_
IR_ JSON_ SCHEMA - ORM_
IR_ VERSION - SCHEMA_
DESCRIPTOR_ JSON_ SCHEMA - SCHEMA_
DESCRIPTOR_ VERSION
Traits§
- Async
OrmGenerated Query Session - Async
OrmGenerated Record Session - Async counterpart used by transport clients without introducing a runtime dependency into the language-neutral ORM crate.
- Async
OrmRecord Session - Async
OrmSession - Async execution boundary over the caller-owned connection/session.
- Generated
Entity - Generated
Record - Runtime bridge implemented by deterministic generated record types.
Execution remains transport-owned; generated code only converts between
its typed fields and the canonical
DynamicRecord. - Generated
Value - OrmBuilder
- OrmGenerated
Query Session - OrmGenerated
Record Session - Transport-owned execution for deterministic generated records.
- OrmRecord
Session - Transport-specific
RETURNING *hydration while preserving one session. - OrmSession
- Synchronous execution boundary shared by embedded and TCP sessions.
Functions§
- canonical_
fingerprint - check
- cte
- decode_
generated_ field - Decode one canonical dynamic field into a generated Rust field while preserving omitted/NULL/clean state exactly.
- decode_
generated_ reference_ field - ensure_
schema_ fingerprint - generate_
rust_ database - parse_
decimal_ literal - primary_
key - reference
- table
- table_
as - unique
- validate_
reference_ target - values_
relation
Type Aliases§
- OrmFuture
- Runtime-neutral owned future used by async ORM session traits.