Containers class
建立新容器和讀取/查詢所有容器的作業
如需讀取、取代或刪除現有容器，請參閱 容器 ;使用 .container(id) 。
注意：所有這些作業都會對固定預算進行呼叫。
您應該設計系統，讓這些呼叫以子線性方式調整您的應用程式。
例如，不要在每個單一 item.read() 呼叫之前呼叫 containers.readAll() ，以確保容器存在;請在應用程式啟動時執行此動作。
建構函式
| Containers(Database, Client |
屬性
| database |
方法
| create(Container |
建立容器。 容器是專案的具名邏輯容器。 資料庫可能包含零個或多個具名容器，而且每個容器都包含零或多個 JSON 專案。 無架構，容器中的專案不需要共用相同的結構或欄位。 由於容器是應用程式資源，因此可以使用主要金鑰或資源金鑰來獲得授權。 |
| create |
檢查容器是否存在，如果不存在，則會建立它。
這會根據 中的 容器是專案的具名邏輯容器。 資料庫可能包含零個或多個具名容器，而且每個容器都包含零或多個 JSON 專案。 無架構，容器中的專案不需要共用相同的結構或欄位。 由於容器是應用程式資源，因此可以使用主要金鑰或資源金鑰來獲得授權。 |
| query(Sql |
查詢所有容器。 範例 讀取所有容器以陣列。
* |
| query<T>(Sql |
查詢所有容器。 範例 讀取所有容器以陣列。
* |
| read |
讀取所有容器。 範例 讀取所有容器以陣列。
* |
建構函式詳細資料
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)參數
- database
- Database
- clientContext
-
ClientContext
屬性詳細資料
database
方法詳細資料
create(ContainerRequest, RequestOptions)
建立容器。
容器是專案的具名邏輯容器。
資料庫可能包含零個或多個具名容器，而且每個容器都包含零或多個 JSON 專案。
無架構，容器中的專案不需要共用相同的結構或欄位。
由於容器是應用程式資源，因此可以使用主要金鑰或資源金鑰來獲得授權。
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>參數
- body
- ContainerRequest
表示容器的主體。
- options
- RequestOptions
使用 來設定回應頁面大小、接續權杖等選項。
傳回
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
檢查容器是否存在，如果不存在，則會建立它。
這會根據 中的 body 識別碼進行讀取作業，如果找不到，則會建立作業。
您應該確認輸出符合針對非預設屬性傳入的主體 (，也就是編制索引原則/等)
容器是專案的具名邏輯容器。
資料庫可能包含零個或多個具名容器，而且每個容器都包含零或多個 JSON 專案。
無架構，容器中的專案不需要共用相同的結構或欄位。
由於容器是應用程式資源，因此可以使用主要金鑰或資源金鑰來獲得授權。
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>參數
- body
- ContainerRequest
表示容器的主體。
- options
- RequestOptions
使用 來設定回應頁面大小、接續權杖等選項。
傳回
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
查詢所有容器。
範例
讀取所有容器以陣列。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>參數
- query
- SqlQuerySpec
作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。
- options
- FeedOptions
使用 來設定回應頁面大小、接續權杖等選項。
傳回
QueryIterator<any>
QueryIterator 可讓您傳回陣列中的特定容器，或逐一逐一查看它們。 *
query<T>(SqlQuerySpec, FeedOptions)
查詢所有容器。
範例
讀取所有容器以陣列。
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>參數
- query
- SqlQuerySpec
作業的查詢組態。 如需如何設定查詢的詳細資訊，請參閱 SqlQuerySpec 。
- options
- FeedOptions
使用 來設定回應頁面大小、接續權杖等選項。
傳回
QueryIterator 可讓您傳回陣列中的特定容器，或逐一逐一查看它們。 *
readAll(FeedOptions)
讀取所有容器。
範例
讀取所有容器以陣列。
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>參數
- options
- FeedOptions
使用 來設定回應頁面大小、接續權杖等選項。
傳回
QueryIterator 可讓您傳回陣列中的所有容器，或逐一逐一查看它們。 *