Struct Database 

pub struct Database<S: Schema = Unbound> { /* private fields */ }

Primary database session handle type-branded by schema S.

Implementations

impl<S: Schema> Database<S>

pub fn query(&self) -> Result<QuerySession<'_, S>>

Start one owner-branded query authoring session over this schema-bound database.

pub fn query_with_resources( &self, resources: QueryExecutionResourceLimits, cancellation: AnswerCancellation, ) -> Result<QuerySession<'_, S>>

Start one owner-branded query authoring session with one common tighten-only resource policy and caller-owned cancellation signal.

impl Database<Unbound>

pub async fn connect( options: impl Into<ConnectionOptions>, ) -> Result<Database<Unbound>>

Connect to a TypeDB server returning an unbound database handle.

pub fn with_schema<S: Schema>( self, schema: SchemaPackage<S>, ) -> Result<Database<S>>

Bind and verify a generated schema package, transitioning to Database<S>.

impl<S: Schema> Database<S>

pub fn entities<M>(&self) -> EntityManager<'_, S, M>

where M: EntityModel<Schema = S>,

Create a lightweight client-owned exact entity manager.

pub fn relations<M>(&self) -> RelationManager<'_, S, M>

where M: RelationModel<Schema = S>,

Create a lightweight client-owned exact relation manager.

pub async fn write(&self) -> Result<WriteTransaction<'_, S>>

Open one client-owned write transaction over this schema-bound database. Operations on its borrowed managers never auto-commit; the caller terminally commits or rolls back, and dropping the open transaction releases the context without commit.

pub async fn read(&self) -> Result<ReadTransaction<'_, S>>

Open one reusable client-owned read transaction. Query terminals borrow and reuse its retained context until explicit close or drop.

pub fn database_name(&self) -> &str

Return the target database name.

pub async fn database_exists(&self) -> Result<bool>

Return whether the one configured database exists.

pub async fn database_exists_controlled( &self, control: &MigrationExecutionControl, ) -> Result<bool>

Return whether the managed database exists, honoring execution controls.

pub async fn create_database(&self) -> Result<DatabaseCreateOutcome>

Create the one configured database and return its normalized outcome.

pub async fn create_database_controlled( &self, control: &MigrationExecutionControl, ) -> Result<DatabaseCreateOutcome>

Create the configured database with cancellation and deadline control.

pub async fn delete_database(&self) -> Result<DatabaseDeleteOutcome>

Delete the one configured database and return its normalized outcome.

pub async fn inspect_database_pair(&self) -> Result<ManagedDatabasePairState>

Inspect the exact managed database and reserved journal pair.

pub async fn inspect_database_pair_controlled( &self, control: &MigrationExecutionControl, ) -> Result<ManagedDatabasePairState>

Inspect the managed pair while honoring cancellation and a deadline.

pub async fn plan_database_delete(&self) -> Result<ManagedDatabaseDeletionPlan>

Inspect and retain an explicit pair-aware destructive deletion plan.

pub async fn plan_database_delete_controlled( &self, control: &MigrationExecutionControl, ) -> Result<ManagedDatabaseDeletionPlan>

Inspect and retain a deletion plan while honoring execution controls.

pub fn close(&self) -> Result<()>

Explicitly close this database’s provider connection.

Closing is idempotent. Once closed, the database cannot admit new provider work, while repeated calls remain harmless.

pub fn is_schema_bound(&self) -> bool

Return whether this database handle is bound to a verified schema.