Expand description
Shared TypeDB execution engine for generated TypeBridge clients.
Public application model construction lives in generated type-bridge
packages. This crate exposes connection, query, transaction, and verified
runtime-projection execution; handwritten model traits, derives, registries,
descriptors, managers, and schema authoring are not package-root APIs.
Re-exports§
pub use error::ClassifiedCommitError;pub use error::CommitFailureCertainty;pub use error::OrmError;pub use error::Result;pub use expr::Agg;pub use expr::AggResult;pub use expr::Expr;pub use expr::GroupByResult;pub use expr::SortDir;pub use filter::Filter;pub use hooks::CrudOperation;pub use hooks::HookContext;pub use hooks::HookError;pub use hooks::HookRunner;pub use hooks::LifecycleHook;pub use hooks::PreHookResult;pub use hooks::TypeKind;pub use projected_batch::ProjectedBatch;pub use projected_batch::ProjectedBatchOperation;pub use projected_batch::ProjectedBatchResourceMeasure;pub use projected_batch::ProjectedBatchRow;pub use projected_codec::ProjectedCodecError;pub use projected_codec::ProjectedCodecValue;pub use projected_codec::ProjectedStructValue;pub use projected_codec::materialize_record;pub use projected_codec::record_from_attribute;pub use projected_codec::record_from_create;pub use projected_codec::record_from_reference;pub use projected_codec::record_from_snapshot;pub use projected_codec::record_from_struct;pub use projected_crud::ProjectedCrudExecutor;pub use projected_model::MAX_PROJECTED_MODEL_BYTES;pub use projected_model::MAX_PROJECTED_MODEL_MEMBERS;pub use projected_model::ProjectedAttributeValue;pub use projected_model::ProjectedCreate;pub use projected_model::ProjectedReference;pub use projected_model::ProjectedRolePlayer;pub use projected_model::ProjectedThing;pub use projected_model::validate_projected_create_member_count;pub use projected_model::validate_projected_hydrated_member_count;pub use provider_runtime::ProviderRuntimeOwner;pub use query::EntityQuery;pub use query::GroupByEntityQuery;pub use query::GroupByRelationQuery;pub use query::RelationQuery;pub use query_v2_model_remote::ClaimedRemoteModelReplyV2;pub use query_v2_model_remote::PendingRemoteModelQueryV2;pub use query_v2_model_remote::RemoteModelQueryV2Error;pub use query_v2_model_remote::prepare_remote_model_query_v2;pub use runtime_projection::InstalledRuntimeProjection;pub use session::DirectTls;Deprecated pub use session::backend::AnswerCancellation;pub use session::DirectConnectionPolicy;pub use session::Database;pub use session::DatabaseConnectionAuthority;pub use session::GivenColumnType;pub use session::GivenRowsSpec;pub use session::GivenValue;pub use session::OwnedTransaction;pub use session::ProxyEndpoint;pub use session::ProxyHttpTransport;pub use session::TlsPolicy;pub use session::Transaction;Deprecated pub use session::TransactionContext;pub use session::TxType;pub use session::require_legacy_writer_open;pub use session::require_legacy_writer_open_in_transaction;pub use session::database_exists;pub use session::database_exists_secure;pub use session::delete_database_secure;pub use session::ensure_database_exists;pub use session::ensure_database_exists_secure;pub use value::AttributeValue;pub use match_request::*;
Modules§
- error
- Unified error types for the ORM crate.
- expr
- Expression system for building typed queries.
- filter
- Query filters for entity lookups.
- hooks
- Lifecycle hook system for CRUD operations.
- match_
request - Canonical, provider-neutral typed match request and result contract.
- migration_
assertion - TypeDB lowering and bounded execution for validated migration assertions.
- projected_
batch - Immutable binding-neutral projected mutation batches and provider-free policy checks.
- projected_
codec - Canonical projected-record adapters over exact installed ORM authority.
- projected_
crud - Exact single-model CRUD over a verified generated runtime projection.
- projected_
model - Immutable binding-neutral values for exact generated-model execution.
- provider_
runtime - Tokio runtime ownership for synchronous language bindings.
- query
- Chainable query builders for entities and relations.
- query_
v2 - Deterministic TypeQL lowering for validated V2 query plans.
- query_
v2_ builder - Shared incremental authoring state machine for canonical V2 query plans.
- query_
v2_ prepared - Prepared-plan execution facade for idiomatic binding projections.
- query_
v2_ remote - Remote execution of validated query plans over the versioned envelope.
- runtime_
projection - Provider descriptors derived one-way from a trusted runtime projection.
- session
- Session layer for TypeDB connectivity.
- value
- Typed attribute values corresponding to TypeDB value types.
Structs§
- Claimed
Remote Model Reply V2 - The sole claimed reply slot for one adapted model request.
- Connect
Options - Connection-time options for the version-gated TypeDB runtime.
- Dynamic
Aggregate - Runtime aggregate requested by a language binding.
- Dynamic
Entity Identity - Identity-only evidence for one concrete entity discovered under a root type.
- Dynamic
Entity Row - Dynamic entity row hydrated from a fetch document.
- Dynamic
Relation Identity - Owned identity-only evidence for a concrete relation discovered under a root relation.
- Dynamic
Relation Row - Runtime relation row hydrated from a fetch document.
- Dynamic
Role Player - Dynamic role player hydrated from relation fetch output or provided for relation insert.
- Dynamic
Role Player Input - Runtime role player reference used for dynamic relation inserts.
- Generated
Manager Lookup - One compatibility lookup resolved against generated field names.
- Pending
Remote Model Query V2 - One adapted model request and its request-bound one-shot decoder.
- Projected
Batch Executor - Binding-neutral atomic executor for
ProjectedBatch. - Projected
Manager Filter - One persistent, exact-model, generated-field filter.
- Projected
Manager Filter Executor - Binding-neutral executor for exact generated-manager filters.
- Projected
Manager Filter Resource Measure - Allocation-free resource measure for one immutable manager filter.
- Proxy
Query Connection - A connection to a TypeBridge server: its verified advertisement, the schema authority requests are prepared under, the answer-limit ceiling, and the built-in HTTP route unless the caller owns the exchange.
- Query
Execution Deadline - One absolute monotonic deadline shared by every stage of one query terminal.
- Query
Execution Limit OutOf Range - One answer-policy value above its supported maximum.
- Query
Execution Resource Limits - The answer policy of one query terminal, the same on every transport.
- Secure
Connect Options - Connection options for the typed TLS transport surface.
- Unknown
Enum Value - A spelling rejected by one core enum parser.
Enums§
- Answer
Transport - The transport an answer policy runs on, which decides its defaults.
- Dynamic
Comparison Op - Runtime comparison operator requested by a language binding.
- Dynamic
Expr - Runtime expression tree requested by a language binding.
- Dynamic
Sort - Runtime sort requested by a language binding.
- Enum
Kind - One closed enum a binding accepts as text.
- Manager
Lookup - One generated-manager filter lookup (
field__lookup=value). - Owner
Lookup - One generated owner lookup (
Model.has(attribute, value, lookup=...)). - Projected
Batch Result - Result of one homogeneous projected mutation batch.
- Projected
Manager Comparison - One closed scalar comparison admitted by an exact generated-manager filter.
- Query
Execution Limits Error - Why a set of named answer-policy values was refused.
- Query
Target - Where one terminal runs.
- Query
Target Error - Why a terminal failed on its target.
- Remote
Model Query V2Error - A model-query remote failure retains its native structured error family.
- Secure
Connect Error - Error returned by typed secure connection and lifecycle entry points.
- TlsMode
- Canonical TLS policy for secure TypeDB connections.
- Value
Type - TypeDB value type enum for type-safe metadata.
Constants§
- DEFAULT_
DIRECT_ QUERY_ ATTRIBUTE_ VALUES - Direct-session default hydrated/projected attribute-value count.
- DEFAULT_
DIRECT_ QUERY_ BYTES - Direct-session default provider, reply, and projected payload bytes.
- DEFAULT_
DIRECT_ QUERY_ COLLECTION_ MEMBERS - Direct-session default collection members, including reduction cells.
- DEFAULT_
DIRECT_ QUERY_ GRAPH_ NODES - Direct-session default hydrated/projected graph-node count.
- DEFAULT_
DIRECT_ QUERY_ ITEMS - Direct-session default provider/result item count.
- DEFAULT_
DIRECT_ QUERY_ ROLE_ PLAYERS - Direct-session default relation-role-player references.
- DEFAULT_
DIRECT_ QUERY_ STATEMENTS - Direct-session default provider statements per terminal.
- DEFAULT_
DIRECT_ QUERY_ TIMEOUT_ MILLISECONDS - Direct-session default execution duration in milliseconds.
- DEFAULT_
PROXY_ QUERY_ ATTRIBUTE_ VALUES - Proxy-connection default hydrated/projected attribute-value count.
- DEFAULT_
PROXY_ QUERY_ BYTES - Proxy-connection default provider, reply, and projected payload bytes.
- DEFAULT_
PROXY_ QUERY_ COLLECTION_ MEMBERS - Proxy-connection default collection members, including reduction cells.
- DEFAULT_
PROXY_ QUERY_ GRAPH_ NODES - Proxy-connection default hydrated/projected graph-node count.
- DEFAULT_
PROXY_ QUERY_ ITEMS - Proxy-connection default provider/result item count.
- DEFAULT_
PROXY_ QUERY_ ROLE_ PLAYERS - Proxy-connection default relation-role-player references.
- DEFAULT_
PROXY_ QUERY_ STATEMENTS - Proxy-connection default provider statements per terminal.
- DEFAULT_
PROXY_ QUERY_ TIMEOUT_ MILLISECONDS - Proxy-connection default execution duration in milliseconds.
- MAX_
QUERY_ ATTRIBUTE_ VALUES Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_ATTRIBUTE_VALUES, with the same value. - MAX_
QUERY_ BYTES Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_BYTES, with the same value. - MAX_
QUERY_ COLLECTION_ MEMBERS Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_COLLECTION_MEMBERS, with the same value. - MAX_
QUERY_ GRAPH_ NODES Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_GRAPH_NODES, with the same value. - MAX_
QUERY_ ITEMS Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_ITEMS, with the same value. - MAX_
QUERY_ ROLE_ PLAYERS Deprecated - The 2.2 name of
DEFAULT_PROXY_QUERY_ROLE_PLAYERS, with the same value. - MAX_
QUERY_ STATEMENTS - Most provider statements a terminal can need. No terminal issues more, so a larger value would be accepted and ignored.
- MAX_
QUERY_ TIMEOUT_ MILLISECONDS - Longest execution duration a policy may ask for, in milliseconds.
Functions§
- canonical_
enum_ spelling - Check
valueagainst the enum named bykindand return its canonical spelling. An unknownkindis itself an unknownenum_kindspelling. - embedded_
driver_ versions - Return the driver versions compiled into this build, keyed by protocol band.
- prepare_
remote_ model_ query_ v2 - Adapt and prepare one released model-oriented terminal for remote V2 execution.
- resolve_
generated_ manager_ lookup - Resolve a generated-manager compatibility spelling without losing literal
field names that contain
__.
Type Aliases§
- Dynamic
Attribute Map - Runtime attribute values keyed by TypeDB attribute name or descriptor field name.
- Secure
Result - Result alias for typed secure connection and lifecycle operations.