Skip to main content

Crate type_bridge_orm

Crate type_bridge_orm 

Source
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§

ClaimedRemoteModelReplyV2
The sole claimed reply slot for one adapted model request.
ConnectOptions
Connection-time options for the version-gated TypeDB runtime.
DynamicAggregate
Runtime aggregate requested by a language binding.
DynamicEntityIdentity
Identity-only evidence for one concrete entity discovered under a root type.
DynamicEntityRow
Dynamic entity row hydrated from a fetch document.
DynamicRelationIdentity
Owned identity-only evidence for a concrete relation discovered under a root relation.
DynamicRelationRow
Runtime relation row hydrated from a fetch document.
DynamicRolePlayer
Dynamic role player hydrated from relation fetch output or provided for relation insert.
DynamicRolePlayerInput
Runtime role player reference used for dynamic relation inserts.
GeneratedManagerLookup
One compatibility lookup resolved against generated field names.
PendingRemoteModelQueryV2
One adapted model request and its request-bound one-shot decoder.
ProjectedBatchExecutor
Binding-neutral atomic executor for ProjectedBatch.
ProjectedManagerFilter
One persistent, exact-model, generated-field filter.
ProjectedManagerFilterExecutor
Binding-neutral executor for exact generated-manager filters.
ProjectedManagerFilterResourceMeasure
Allocation-free resource measure for one immutable manager filter.
ProxyQueryConnection
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.
QueryExecutionDeadline
One absolute monotonic deadline shared by every stage of one query terminal.
QueryExecutionLimitOutOfRange
One answer-policy value above its supported maximum.
QueryExecutionResourceLimits
The answer policy of one query terminal, the same on every transport.
SecureConnectOptions
Connection options for the typed TLS transport surface.
UnknownEnumValue
A spelling rejected by one core enum parser.

Enums§

AnswerTransport
The transport an answer policy runs on, which decides its defaults.
DynamicComparisonOp
Runtime comparison operator requested by a language binding.
DynamicExpr
Runtime expression tree requested by a language binding.
DynamicSort
Runtime sort requested by a language binding.
EnumKind
One closed enum a binding accepts as text.
ManagerLookup
One generated-manager filter lookup (field__lookup=value).
OwnerLookup
One generated owner lookup (Model.has(attribute, value, lookup=...)).
ProjectedBatchResult
Result of one homogeneous projected mutation batch.
ProjectedManagerComparison
One closed scalar comparison admitted by an exact generated-manager filter.
QueryExecutionLimitsError
Why a set of named answer-policy values was refused.
QueryTarget
Where one terminal runs.
QueryTargetError
Why a terminal failed on its target.
RemoteModelQueryV2Error
A model-query remote failure retains its native structured error family.
SecureConnectError
Error returned by typed secure connection and lifecycle entry points.
TlsMode
Canonical TLS policy for secure TypeDB connections.
ValueType
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_VALUESDeprecated
The 2.2 name of DEFAULT_PROXY_QUERY_ATTRIBUTE_VALUES, with the same value.
MAX_QUERY_BYTESDeprecated
The 2.2 name of DEFAULT_PROXY_QUERY_BYTES, with the same value.
MAX_QUERY_COLLECTION_MEMBERSDeprecated
The 2.2 name of DEFAULT_PROXY_QUERY_COLLECTION_MEMBERS, with the same value.
MAX_QUERY_GRAPH_NODESDeprecated
The 2.2 name of DEFAULT_PROXY_QUERY_GRAPH_NODES, with the same value.
MAX_QUERY_ITEMSDeprecated
The 2.2 name of DEFAULT_PROXY_QUERY_ITEMS, with the same value.
MAX_QUERY_ROLE_PLAYERSDeprecated
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 value against the enum named by kind and return its canonical spelling. An unknown kind is itself an unknown enum_kind spelling.
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§

DynamicAttributeMap
Runtime attribute values keyed by TypeDB attribute name or descriptor field name.
SecureResult
Result alias for typed secure connection and lifecycle operations.