Databases class

新しいデータベースを作成し、すべてのデータベースの読み取り/クエリを実行するための操作

既存 のデータベース の読み取りまたは削除については、「データベース」を参照してください。を使用します client.database(id)

注: これらの操作はすべて、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブインラインでスケーリングされるように、システムを設計する必要があります。 たとえば、データベースが存在することを確認するために、1 回item.read()の呼び出しの前に を呼び出databases.readAll()さないでください。これは、アプリケーションの起動時に 1 回行います。

プロパティ

client

メソッド

create(DatabaseRequest, RequestOptions)

データベースを作成するための要求を送信します。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

createIfNotExists(DatabaseRequest, RequestOptions)

データベースが存在するかどうかを確認し、存在しない場合は作成します。 これにより、 内 bodyの ID に基づいて読み取り操作が行われます。見つからない場合は作成操作です。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

query(string | SqlQuerySpec, FeedOptions)

すべてのデータベースに対してクエリを実行します。

すべてのデータベースを配列に読み取る。 * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

query<T>(string | SqlQuerySpec, FeedOptions)

すべてのデータベースに対してクエリを実行します。

すべてのデータベースを配列に読み取る。 * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

readAll(FeedOptions)

すべてのデータベースを読み取ります。

すべてのデータベースを配列に読み取る。 * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

プロパティの詳細

client

client: CosmosClient

プロパティ値

メソッドの詳細

create(DatabaseRequest, RequestOptions)

データベースを作成するための要求を送信します。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

パラメーター

body
DatabaseRequest

作成するデータベースを表す DatabaseDefinition

options
RequestOptions

応答ページ サイズ、継続トークンなどのオプションを設定するには、 を使用します。

戻り値

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

データベースが存在するかどうかを確認し、存在しない場合は作成します。 これにより、 内 bodyの ID に基づいて読み取り操作が行われます。見つからない場合は作成操作です。

データベースは、ユーザー、アクセス許可、およびコンテナーのセットを管理します。 各 Azure Cosmos DB データベース アカウントは、データの論理コンテナーである複数の独立した名前付きデータベースをサポートできます。

各データベースは 1 つ以上のコンテナーで構成され、各コンテナーには 1 つ以上のドキュメントが含まれます。 データベースは管理リソースであるため、ユーザー API を使用してアクションにアクセスして正常に完了するには、サービス マスター キーが必要です。

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

パラメーター

body
DatabaseRequest

作成するデータベースを表す DatabaseDefinition

options
RequestOptions

要求の追加オプション

戻り値

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

すべてのデータベースに対してクエリを実行します。

すべてのデータベースを配列に読み取る。 * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

パラメーター

query

string | SqlQuerySpec

操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。

options
FeedOptions

応答ページ サイズ、継続トークンなどのオプションを設定するには、 を使用します。

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。 *

query<T>(string | SqlQuerySpec, FeedOptions)

すべてのデータベースに対してクエリを実行します。

すべてのデータベースを配列に読み取る。 * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

パラメーター

query

string | SqlQuerySpec

操作のクエリ構成。 クエリを構成する方法の詳細については、「 SqlQuerySpec 」を参照してください。

options
FeedOptions

応答ページ サイズ、継続トークンなどのオプションを設定するには、 を使用します。

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。 *

readAll(FeedOptions)

すべてのデータベースを読み取ります。

すべてのデータベースを配列に読み取る。 * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

パラメーター

options
FeedOptions

応答ページ サイズ、継続トークンなどのオプションを設定するには、 を使用します。

戻り値

QueryIterator 配列内のすべてのデータベースを返したり、一度に 1 つずつ反復処理したりできます。 *