Databases class

套件:

@azure/cosmos

建立新資料庫的作業，以及讀取/查詢所有資料庫

請參閱 資料庫 以讀取或刪除現有的資料庫;使用 client.database(id) 。

注意：所有這些作業都會對固定預算進行呼叫。 您應該設計系統，讓這些呼叫以子線性方式調整您的應用程式。 例如，不要在每個單一 item.read() 呼叫之前呼叫 databases.readAll() ，以確保資料庫存在;請在應用程式啟動時執行此動作。

屬性

client

方法

create(DatabaseRequest, RequestOptions)	傳送建立資料庫的要求。 資料庫會管理使用者、許可權和一組容器。 每個 Azure Cosmos DB 資料庫帳戶都能夠支援多個獨立的具名資料庫，而資料庫是資料的邏輯容器。 每個資料庫都包含一或多個容器，每個容器接著都包含一或多個檔。 由於資料庫是系統管理資源，因此需要服務主要金鑰，才能使用使用者 API 存取並順利完成任何動作。
createIfNotExists(DatabaseRequest, RequestOptions)	檢查資料庫是否存在，如果不存在，請加以建立。 這會根據 中的 body 識別碼進行讀取作業，如果找不到，則會建立作業。 資料庫會管理使用者、許可權和一組容器。 每個 Azure Cosmos DB 資料庫帳戶都能夠支援多個獨立的具名資料庫，而資料庫是資料的邏輯容器。 每個資料庫都包含一或多個容器，每個容器接著都包含一或多個檔。 由於資料庫是系統管理資源，因此需要服務主要金鑰，才能使用使用者 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

屬性值

CosmosClient

方法詳細資料

create(DatabaseRequest, RequestOptions)

傳送建立資料庫的要求。

資料庫會管理使用者、許可權和一組容器。 每個 Azure Cosmos DB 資料庫帳戶都能夠支援多個獨立的具名資料庫，而資料庫是資料的邏輯容器。

每個資料庫都包含一或多個容器，每個容器接著都包含一或多個檔。 由於資料庫是系統管理資源，因此需要服務主要金鑰，才能使用使用者 API 存取並順利完成任何動作。

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

參數

body

DatabaseRequest

DatabaseDefinition，代表要建立的資料庫。

options

RequestOptions

使用 來設定回應頁面大小、接續權杖等選項。

傳回

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

檢查資料庫是否存在，如果不存在，請加以建立。 這會根據 中的 body 識別碼進行讀取作業，如果找不到，則會建立作業。

資料庫會管理使用者、許可權和一組容器。 每個 Azure Cosmos DB 資料庫帳戶都能夠支援多個獨立的具名資料庫，而資料庫是資料的邏輯容器。

每個資料庫都包含一或多個容器，每個容器接著都包含一或多個檔。 由於資料庫是系統管理資源，因此需要服務主要金鑰，才能使用使用者 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<any>

QueryIterator 可讓您傳回陣列中的所有資料庫，或逐一查看。 *

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<T>

QueryIterator 可讓您傳回陣列中的所有資料庫，或逐一查看。 *

readAll(FeedOptions)

讀取所有資料庫。

範例

讀取要陣列的所有資料庫。 * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

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

參數

options

FeedOptions

使用 來設定回應頁面大小、接續權杖等選項。

傳回

QueryIterator<DatabaseDefinition & Resource>

QueryIterator 可讓您傳回陣列中的所有資料庫，或逐一查看。 *