Skip to main content

type_bridge/
lib.rs

1//! Public Rust client library for TypeBridge.
2//!
3//! Provides top-level [`Database`], [`ConnectionOptions`], [`SchemaPackage`],
4//! and owner-branded schema/model primitives. [`plan`] builds typed
5//! `query-plan/v3` programs and [`staged`] runs them in staged transactions.
6
7#![forbid(unsafe_code)]
8#![deny(missing_docs)]
9
10extern crate self as type_bridge;
11
12pub mod __codegen;
13pub mod aggregate;
14mod canonical_codec;
15mod connection;
16#[allow(dead_code)]
17mod entity_codec;
18mod entity_manager;
19pub mod error;
20/// Value-only provider failure vocabulary used by Error::failure.
21pub use type_bridge_contract::failure;
22pub mod hooks;
23pub mod migration;
24pub mod model;
25pub mod plan;
26mod projected_batch;
27mod projected_codec;
28mod projected_filter;
29mod query;
30#[allow(dead_code)]
31mod relation_codec;
32mod relation_manager;
33mod remote;
34pub mod schema;
35#[cfg(test)]
36#[path = "../../../../tests/support/sdk_profile_matrix.rs"]
37#[allow(dead_code)]
38mod sdk_profile_matrix;
39pub mod session;
40pub mod staged;
41mod transaction;
42pub mod value;
43
44pub use canonical_codec::{CanonicalCodecLimits, CanonicalCodecOptions};
45pub use connection::{Connection, ConnectionPolicy};
46pub use entity_manager::{EntityManager, EntitySubtypeManager};
47pub use error::{
48    Error, ErrorCategory, ErrorDetail, ErrorDiagnostic, ErrorPathSegment, ModelValidationPhase,
49    QueryDiagnosticCategory, QueryDiagnosticPathKind, Result,
50};
51pub use hooks::{
52    CrudOperation, HookContext, HookError, HookFuture, LifecycleHook, ModelKind, PreHookResult,
53};
54pub use migration::{
55    MigrationApprovalBuilder, MigrationApprovalSet, MigrationCatalog, MigrationHistoryEntry,
56    MigrationPlan, MigrationPreview, MigrationPreviewEntry,
57};
58pub use projected_filter::{
59    ProjectedEntityFilter, ProjectedRelationFilter, ReadEntityManager, ReadRelationManager,
60};
61pub use query::{
62    Binding, BoundField, BoundRole, Collected, Exact, FieldGroupedQuery, FunctionArgument,
63    FunctionCall, FunctionInput, FunctionScalarArgument, GroupedQuery, NamedSelection, Order,
64    OrderedOperand, Page, PageOptions, Predicate, Query, QueryOperand, QuerySession, RowsOptions,
65    Selectable, SelectedRowSpec, SelectedShape, SelectedSlot, SelectionMode, SingularSelectedShape,
66    Subtypes,
67};
68pub use relation_manager::{RelationManager, RelationSubtypeManager};
69pub use remote::{ProxyConnectionPolicy, ProxyDatabase, ProxyExchange};
70#[allow(deprecated)]
71pub use remote::{
72    RemoteConnectionOptions, RemoteDatabase, RemoteQueryLimits, RemoteQueryTransport,
73};
74pub use schema::{Schema, SchemaPackage, Unbound};
75pub use session::{ConnectionOptions, Database, DatabaseCreateOutcome, DatabaseDeleteOutcome};
76#[cfg(feature = "typedb")]
77pub use session::{
78    ManagedDatabaseDeleteOutcome, ManagedDatabaseDeletionPlan, ManagedDatabasePairState,
79};
80pub use transaction::{
81    ReadTransaction, TransactionEntityManager, TransactionRelationManager, WriteTransaction,
82};
83pub use type_bridge_contract::limits::{QueryLimits, QueryLimitsError};
84#[cfg(feature = "typedb")]
85pub use type_bridge_orm::DirectConnectionPolicy;
86pub use type_bridge_orm::{
87    AnswerCancellation, AnswerTransport, DEFAULT_DIRECT_QUERY_ATTRIBUTE_VALUES,
88    DEFAULT_DIRECT_QUERY_BYTES, DEFAULT_DIRECT_QUERY_COLLECTION_MEMBERS,
89    DEFAULT_DIRECT_QUERY_GRAPH_NODES, DEFAULT_DIRECT_QUERY_ITEMS,
90    DEFAULT_DIRECT_QUERY_ROLE_PLAYERS, DEFAULT_DIRECT_QUERY_STATEMENTS,
91    DEFAULT_DIRECT_QUERY_TIMEOUT_MILLISECONDS, DEFAULT_PROXY_QUERY_ATTRIBUTE_VALUES,
92    DEFAULT_PROXY_QUERY_BYTES, DEFAULT_PROXY_QUERY_COLLECTION_MEMBERS,
93    DEFAULT_PROXY_QUERY_GRAPH_NODES, DEFAULT_PROXY_QUERY_ITEMS, DEFAULT_PROXY_QUERY_ROLE_PLAYERS,
94    DEFAULT_PROXY_QUERY_STATEMENTS, DEFAULT_PROXY_QUERY_TIMEOUT_MILLISECONDS, MAX_QUERY_STATEMENTS,
95    MAX_QUERY_TIMEOUT_MILLISECONDS, ProjectedManagerComparison, QueryExecutionDeadline,
96    QueryExecutionLimitOutOfRange, QueryExecutionLimitsError, QueryExecutionResourceLimits,
97};
98#[allow(deprecated)]
99pub use type_bridge_orm::{
100    DirectTls, MAX_QUERY_ATTRIBUTE_VALUES, MAX_QUERY_BYTES, MAX_QUERY_COLLECTION_MEMBERS,
101    MAX_QUERY_GRAPH_NODES, MAX_QUERY_ITEMS, MAX_QUERY_ROLE_PLAYERS,
102};
103pub use type_bridge_orm::{ProxyEndpoint, TlsPolicy};
104pub use type_bridge_orm_derive::SelectedRow;
105#[cfg(feature = "typedb")]
106pub use type_bridge_schema_migration::{
107    MAX_MIGRATION_BACKFILL_OBSERVATIONS, MAX_MIGRATION_EXECUTION_GROUPS,
108    MigrationBackfillObservation, MigrationCancellation, MigrationDriftFinding,
109    MigrationExecutionControl, MigrationExecutionDirection, MigrationExecutionReport,
110    MigrationExecutionReportPosition, MigrationExecutionResourceLimits, MigrationExecutionStatus,
111    MigrationVerifyReport,
112};