@azure/cosmos package

  • 參考

類別

AbortError

非同步作業中止時，會擲回此錯誤。 藉由測試錯誤的名稱屬性是否符合 "AbortError" 來檢查 name 此錯誤。

範例

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
ChangeFeedIterator

提供變更摘要的反覆運算器。

使用 Items.changeFeed() 取得反覆運算器的實例。
ChangeFeedIteratorResponse

Azure Cosmos DB 變更摘要的單一回應頁面
ChangeFeedResponse

Azure Cosmos DB 變更摘要的單一回應頁面
ChangeFeedStartFrom

要在其中啟動 ChangeFeedIterator 的基類。
ClientSideMetrics
Conflict

用來讀取或刪除依識別碼的指定 衝突 。

請參閱查詢衝突或讀取所有衝突。
ConflictResponse
Conflicts

使用 來查詢或讀取所有衝突。

請參閱 衝突 ，以依識別碼讀取或刪除指定的 衝突 。
Container

依識別碼讀取、取代或刪除特定現有容器的作業。

請參閱 建立 新容器的容器，以及讀取/查詢所有容器;使用 .containers 。

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

容器作業的回應物件
Containers

建立新容器和讀取/查詢所有容器的作業

如需讀取、取代或刪除現有容器，請參閱 容器 ;使用 .container(id) 。

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

提供 Azure Cosmos DB 資料庫帳戶的用戶端邏輯標記法。 此用戶端用來設定和執行 Azure Cosmos DB 資料庫服務中的要求。

範例

具現化用戶端並建立新的資料庫

const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}});
await client.databases.create({id: "<datbase name here>"});

範例

具現化具有自訂連線原則的用戶端

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});
CosmosDiagnostics
  • 這是 Cosmos 診斷類型，會在用戶端作業期間保存收集的診斷資訊。 即。Item.read () ，Container.create () 。 它有三個成員 -
  1. clientSideRequestStatistics 成員包含匯總診斷資訊，包括 -
  • 中繼資料查閱。 在這裡，除了最終預定的資源之外，所有伺服器要求都會被視為中繼資料呼叫。 亦即，如果用戶端呼叫伺服器來探索端點，則會將 item.read (識別碼) ，則會將其視為中繼資料呼叫。
  • 重試
  • 已連絡的端點。
  • 要求，回應承載統計資料。
  • gatewayStatistics - 對應至主要作業的資訊。 例如，在 Item.read () 期間，用戶端可能會執行許多作業，例如中繼資料查閱等，但 gatewayStatistics 代表實際讀取作業的診斷資訊。
  1. diagnosticNode - 是結構之類的樹狀結構，可擷取詳細的診斷資訊。 根據預設，它會停用，而且僅供非生產環境偵錯之用。 diagnosticNode 中擷取的詳細資料種類是由 控制 CosmosDbDiagnosticLevel 。
  • CosmosDbDiagnosticLevel.info - 為預設值。 在此層級中，只會擷取 clientSideRequestStatistics。 這是用於生產環境。
  • CosmosDbDiagnosticLevel.debug - 擷取 diagnosticNode 和 clientConfig。 不會擷取要求和回應承載。 不打算在生產環境中使用。
  • CosmosDbDiagnosticLevel.debug-unsafe - 除了 CosmosDbDiagnosticLevel.debug 中所擷取的資料之外，也會擷取要求和回應承載。 不打算在生產環境中使用。
  1. clientConfig - 擷取初始化期間如何設定用戶端的相關資訊。
Database

讀取或刪除現有資料庫的作業。

請參閱建立新資料庫的資料庫，以及讀取/查詢所有資料庫;使用 client.databases 。

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

代表 Azure Cosmos DB 資料庫服務中的 DatabaseAccount。
DatabaseResponse

資料庫作業的回應物件
Databases

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

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

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

指定變更摘要的摘要範圍。
FeedResponse
Item

用來在特定專案上執行作業。

如需所有專案的作業，請參閱 專案 ;請參閱 container.items 。
ItemResponse
Items

建立新專案的作業，以及讀取/查詢所有專案

如需讀取、取代或刪除現有容器，請參閱 專案 ;使用 .item(id) 。
Offer

用來依識別碼讀取或取代現有的 供應專案 。

請參閱 供應專案 以查詢或讀取所有供應專案。
OfferResponse
Offers

用來查詢或讀取所有供應專案。

請參閱 供應 專案，以識別碼讀取或取代現有的 供應專案 。
PartitionKeyBuilder

建置 PartitionKey 的 Builder 類別。
Permission

用來依識別碼讀取、取代或刪除指定的 許可權 。

請參閱建立、upsert、查詢或讀取擁有權限 的許可權 。
PermissionResponse
Permissions

用來建立、取代、查詢及讀取擁有權限。

請參閱 依 識別碼讀取、取代或刪除特定許可權的許可權。
QueryIterator

代表 QueryIterator 物件，這是摘要或查詢回應的實作，可讓周遊和逐一查看 Azure Cosmos DB 資料庫服務中的回應。
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

失敗管線要求的自訂錯誤類型。
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

依識別碼讀取、取代、刪除或執行特定現有預存程式的作業。

若要讓作業建立、讀取或查詢預存程式，
StoredProcedureResponse
StoredProcedures

建立、插入或讀取/查詢所有預存程式的作業。

如需依識別碼讀取、取代、刪除或執行特定現有預存程式的作業，請參閱 container.storedProcedure() 。
TimeoutError
Trigger

讀取、取代或刪除 觸發程式的作業。

使用 container.triggers 建立、upsert、查詢或全部讀取。
TriggerResponse
Triggers

建立、upsert、查詢和讀取所有觸發程式的作業。

用來 container.triggers 讀取、取代或刪除 觸發程式。
User

用來讀取、取代和刪除使用者。

此外，您可以透過 user.permission 和 user.permissions 存取指定使用者的許可權。

請參閱 使用者 以建立、upsert、查詢或全部讀取。
UserDefinedFunction

用來依識別碼讀取、取代或刪除指定的使用者定義函式。

請參閱 UserDefinedFunction 來建立、upsert、查詢、讀取所有使用者定義函數。
UserDefinedFunctionResponse
UserDefinedFunctions

用來建立、upsert、查詢或讀取所有使用者定義函式。

請參閱 UserDefinedFunction ，依識別碼讀取、取代或刪除指定的使用者定義函數。
UserResponse
Users

用來建立、upsert、查詢和讀取所有使用者。

請參閱 使用者 以識別碼讀取、取代或刪除特定使用者。

介面

@azure/cosmos.Index
Agent
BulkOptions

用來修改大量執行的選項物件。 continueOnError (預設值：false) - 在作業失敗時繼續大量執行 ** 注意 4.0 版本中的預設值為 TRUE
ChangeFeedIteratorOptions

指定變更摘要的選項

如果未設定這些選項，它將會開始讀取整個容器的變更。
ChangeFeedOptions

指定變更摘要的選項

其中一些選項可控制從變更摘要開始讀取的位置和時機。 優先順序為：

  • continuation (接續)
  • startTime
  • startFromBeginning

如果未設定這些選項，則會開始從第一次 ChangeFeedIterator.fetchNext() 呼叫讀取變更。
ChangeFeedPullModelIterator

使用 Items.getChangeFeedIterator() 傳回反覆運算器，可逐一查看分割區索引鍵、摘要範圍或整個容器的所有變更。
ConflictDefinition
ConflictResolutionPolicy

表示衝突解決原則組態，用於指定如何解決衝突，以防從不同區域寫入會導致 Azure Cosmos DB 服務集合中檔發生衝突。
ConnectionPolicy

表示與 Azure Cosmos DB 資料庫服務中 CosmosClient 相關聯的連線原則。
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

表示結構之類的樹狀結構，用於擷取診斷資訊。
ErrorBody
FailedRequestAttemptDiagnostic

此類型會擷取伺服器 API 失敗要求的診斷資訊。
FeedOptions

摘要選項和查詢方法。
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Cosmos DB 中的專案只是 JSON 物件。 大部分的 Item 作業都可讓您提供您自己的類型，以擴充非常簡單的 ItemDefinition。

您無法使用任何保留金鑰。 您可以在 中看到保留金鑰清單 <xref:ItemBody>
JSONArray
JSONObject
Location

用來指定可用的位置，讀取是索引 1，而寫入是索引 0。
MetadataLookUpDiagnostic

此類型包含有關伺服器之單一中繼資料要求的診斷資訊。
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

可針對向 Azure Cosmos DB 伺服器發出的要求指定選項。=
Resource
RetryOptions

表示在 Azure Cosmos DB 資料庫服務中使用節流要求所分派的重試原則。
SharedOptions

可針對向 Azure Cosmos DB 伺服器發出的要求指定選項。=
SpatialIndex
SqlParameter

表示參數化 SQL 查詢中的參數，指定于SqlQuerySpec中
SqlQuerySpec

表示 Azure Cosmos DB 服務中的 SQL 查詢。

具有輸入的查詢應該參數化，以防止 SQL 插入。

範例

參數化 SQL 查詢

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

在 UniqueKeyPolicy 中傳遞的單一唯一索引鍵介面
UniqueKeyPolicy

在容器建立時設定唯一索引鍵的介面
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

類型別名

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

此類型會保存初始化的相關資訊 CosmosClient
ClientSideRequestStatistics

這是所有用戶端診斷資訊的集合類型。
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

此類型包含 CosmosDB 用戶端作業期間伺服器所有中繼資料要求的診斷資訊。
NonePartitionKeyType

傳回的物件代表資料分割索引鍵值，允許建立和存取沒有資料分割索引鍵值的專案
NullPartitionKeyType

傳回的 物件代表資料分割索引鍵值，允許建立及存取具有資料分割索引鍵 Null 值的專案。
Operation
OperationInput
OperationWithItem
PartitionKey

容器的 PartitionKey。
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

基本資料分割索引鍵值。
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

此類型會擷取 CosmosDB 用戶端作業期間重試嘗試的診斷資訊。
TokenProvider
UpsertOperation

列舉

ConflictResolutionMode
ConnectionMode

決定 CosmosClient 的連接行為。 請注意，我們目前僅支援閘道模式。
ConsistencyLevel

表示 Azure Cosmos DB 用戶端作業支援的一致性層級。
要求的 ConsistencyLevel 必須符合或比為資料庫帳戶布建的還要弱。 一致性層級。

依強度順序的一致性層級為強式、BoundedStaleness、會話、一致前置詞和最終。

如需一致性層級的詳細檔，請參閱 https://aka.ms/cosmos-consistency 。
CosmosDbDiagnosticLevel

Cosmos DB 診斷層級
DataType

在 Azure Cosmos DB 服務中定義索引路徑規格的目標資料類型。
GeospatialType
IndexKind

指定支援的索引類型。
IndexingMode

指定支援的索引編制模式。
MetadataLookUpType

這是可能的中繼資料查閱類型列舉。
PartitionKeyDefinitionVersion

PartitionKey 定義版本
PartitionKeyKind

PartitionKey 的類型，例如 Hash、MultiHash
PermissionMode

許可權模式值的列舉。
PriorityLevel

代表與每個 Azure Cosmos DB 用戶端要求相關聯的優先順序層級。
低優先順序要求一律會在任何高優先順序要求之前進行節流。

根據預設，所有要求都會被視為高優先順序要求。

如需優先順序型節流的詳細檔，請參閱 https://aka.ms/CosmosDB/PriorityBasedExecution 。
SpatialType
TriggerOperation

觸發程式作業值的列舉。 指定應該執行觸發程式的作業。
TriggerType

觸發程式類型值的列舉。 指定觸發程序的類型。
UserDefinedFunctionType

udf 類型值的列舉。 指定使用者定義函式的類型。

函數

createAuthorizationSasToken(string, SasTokenProperties)

實驗性內部只會產生代表 sas 權杖許可權設定的承載。

函式詳細資料

createAuthorizationSasToken(string, SasTokenProperties)

實驗性內部只會產生代表 sas 權杖許可權設定的承載。

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

參數

masterKey

string

sasTokenProperties
SasTokenProperties

傳回

Promise<string>