IDocumentDatabase Interface

Definition

Namespace:

System.Cloud.DocumentDb

Assembly:

System.Cloud.DocumentDb.Abstractions.dll

Package:

System.Cloud.DocumentDb.Abstractions v8.0.0-rc.1.23453.1

An interface for managing a document database.

public interface class IDocumentDatabase

public interface IDocumentDatabase

type IDocumentDatabase = interface

Public Interface IDocumentDatabase

Derived

System.Cloud.DocumentDb.IDocumentDatabase<TContext>

Remarks

This interface helps with database, table, and connection management. It also allows constructing readers and writers for tables.

Methods

ConnectAsync(Boolean, CancellationToken)	Initializes connections and optionally creates the database if it doesn't exist.
CreateTableAsync(TableOptions, RequestOptions, CancellationToken)	Creates a table using provided parameters.
DeleteDatabaseAsync(CancellationToken)	Deletes the database this instance is responsible for.
DeleteTableAsync(TableOptions, RequestOptions, CancellationToken)	Deletes table using provided parameters.
GetDocumentReader<TDocument>(TableOptions)	Gets a document reader for the specified table and document type.
GetDocumentWriter<TDocument>(TableOptions)	Gets a document writer for the specified table and document type.
ReadTableSettingsAsync(TableOptions, RequestOptions, CancellationToken)	Reads the provided table settings.
UpdateTableSettingsAsync(TableOptions, RequestOptions, CancellationToken)	Updates the existing table settings.