共用方式為

@azure/cosmos package

類別

AbortError

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

範例

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

EncryptionKeyResolver 的實現，它使用 Azure Key Vault 作為客戶管理的密鑰。
ChangeFeedIterator

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

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

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

代表 Azure Cosmos DB 服務中容器的變更摘要原則設定。
ChangeFeedResponse

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

用來啟動 ChangeFeedIterator 之位置的基類。
ClientEncryptionKeyResponse

ClientEncryptionKey作的響應物件
ClientSideMetrics
Conflict

使用依標識碼讀取或刪除指定的 衝突。

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

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

請參閱 衝突，依標識符讀取或刪除指定的 衝突。
Container

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

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

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

容器作業的回應物件
Containers

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

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

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

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

範例

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

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

範例

使用自定義連線原則具現化用戶端

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({
  endpoint,
  key,
  connectionPolicy: {
    requestTimeout: 10000,
  },
});

範例

具現化具有 AAD 驗證和自訂範圍的用戶端

import { DefaultAzureCredential } from "@azure/identity";
import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const aadCredentials = new DefaultAzureCredential();
const client = new CosmosClient({
  endpoint,
  aadCredentials,
  aadScope: "https://cosmos.azure.com/.default", // Optional custom scope
});
CosmosDiagnostics
  • 這是 Cosmos 診斷類型，會在用戶端作業期間保存收集的診斷資訊。 即Item.read（），Container.create（）。 它有三個成員 -
  1. clientSideRequestStatistics 成員包含匯總診斷資訊，包括 -
  • 元數據查閱。 除了最終預定資源之外，所有伺服器要求都會視為元數據呼叫。 也就是針對item.read（id），如果客戶端進行伺服器呼叫來探索端點，則會將其視為元數據呼叫。
  • 重試
  • 已連絡的端點。
  • 要求、響應承載統計數據。
  • 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。

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

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

Database 作業的響應物件
Databases

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

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

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

表示用於在參數化查詢中構建加密參數的構建器類。
ErrorResponse

表示 operations 中返回的錯誤回應。
FeedRange

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

用來在特定項目上執行作業。

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

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

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

使用 以標識碼讀取或取代現有的 供應專案。

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

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

請參閱 供應專案 以標識符讀取或取代現有的 供應專案。
PartitionKeyBuilder

建置 PartitionKey 的 Builder 類別。
Permission

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

請參閱 許可權 來建立、更新插入、查詢或讀取所有許可權。
PermissionResponse
Permissions

用來建立、取代、查詢及讀取所有許可權。

請參閱 許可權，以依標識符讀取、取代或刪除特定許可權。
QueryIterator

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

依標識符讀取、取代、刪除或執行特定現有預存程序的作業。

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

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

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

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

使用 container.triggers 來建立、更新插入、查詢或全部讀取。
TriggerResponse
Triggers

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

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

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

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

請參閱 使用者 來建立、更新插入、查詢或全部讀取。
UserDefinedFunction

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

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

用來建立、更新插入、查詢或讀取所有用戶定義函數。

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

用來建立、更新插入、查詢和讀取所有使用者。

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

介面

@azure/cosmos.Index
Agent
BulkOperationResult

表示對使用 executeBulkOperations API 批量作的回應
BulkOptions

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

指定變更摘要的選項

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

指定變更摘要的選項

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

  • 延續
  • 開始時間
  • startFromBeginning 開始

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

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

表示加密的路徑及其關聯設置。
ClientEncryptionKeyProperties

用於 Azure Cosmos DB 服務的用戶端加密金鑰的詳細資訊。
ClientEncryptionKeyRequest

表示對 Cosmos DB 中的用戶端加密金鑰的請求的介面。
ClientEncryptionOptions

表示與 CosmosClient 關聯的加密選項。
ClientEncryptionPolicy

表示與容器關聯的用戶端加密策略。
CompositePath

表示索引編製原則中的復合路徑。
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

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

代表 Azure Cosmos DB 資料庫服務中與 CosmosClient 相關聯的連線原則。
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosEncryptedNumber

此介面表示 Cosmos DB SDK 中的加密數位。

範例

import { CosmosEncryptedNumber, CosmosEncryptedNumberType } from "@azure/cosmos";

const encryptedNumber1: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Integer,
};
const encryptedNumber2: CosmosEncryptedNumber = {
  value: 4.1,
  numberType: CosmosEncryptedNumberType.Float,
};
const encryptedNumber3: CosmosEncryptedNumber = {
  value: 4,
  numberType: CosmosEncryptedNumberType.Float, // represents 4.0
};
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

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

為不同金鑰提供者的金鑰解析程式提供介面。 所有解析器都應實現此介面。
EncryptionKeyWrapMetadata

用於使用客戶管理的金鑰包裝/解包數據加密金鑰的元數據
ErrorBody
ExtendedOperationResponse

使用 executeBulkOperations API 批量執行成功作的回應
FailedRequestAttemptDiagnostic

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

摘要選項和查詢方法。
FullTextIndex

表示索引編製原則中的全文檢索索引。
FullTextPath

表示 Azure Cosmos DB 服務中要編製索引的全文檢索路徑。
FullTextPolicy

代表 Azure Cosmos DB 服務中集合的全文檢索原則。
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

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

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

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

此類型包含伺服器單一元數據要求的相關診斷資訊。
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

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

失敗管線要求的自定義錯誤類型。
RetryOptions

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

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

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

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

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

範例

參數化 SQL 查詢

import { SqlQuerySpec } from "@azure/cosmos";

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
VectorEmbedding

表示向量內嵌。 向量內嵌可用來定義檔中的向量欄位。
VectorEmbeddingPolicy

代表向量內嵌在 Azure Cosmos DB 服務中的原則組態。
VectorIndex

表示 Azure Cosmos DB 服務中的向量索引。 向量索引可用來為檔中的向量欄位編製索引。

類型別名

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

列舉

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

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

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

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

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

Cosmos DB 診斷層級
CosmosEncryptedNumberType

此枚舉表示 Cosmos DB SDK 中的數字類型。
DataType

在 Azure Cosmos DB 服務中定義索引路徑規格的目標數據類型。
EncryptionAlgorithm

數據加密支援的加密演算法
EncryptionKeyResolverName

的實現名稱

請參閱 EncryptionKeyResolver
EncryptionType

要執行的加密類型。
GeospatialType
IndexKind

指定支援的索引類型。
IndexingMode

指定支援的索引編製模式。
KeyEncryptionAlgorithm

用於將數據加密金鑰與金鑰加密金鑰包裝/解包的演算法。
MetadataLookUpType

這是可能的元數據查閱類型列舉。
PartitionKeyDefinitionVersion

PartitionKey 定義版本
PartitionKeyKind

PartitionKey 的類型，亦即 Hash、MultiHash
PermissionMode

許可權模式值的列舉。
PriorityLevel

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

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

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

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

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

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

表示向量的數據型別。
VectorEmbeddingDistanceFunction

表示用於向量之間距離計算的 distance 函式。
VectorIndexType

表示向量的索引類型。

函式

createAuthorizationSasToken(string, SasTokenProperties)

實驗內部只會產生代表 sas 令牌許可權組態的承載。

函式詳細資料

createAuthorizationSasToken(string, SasTokenProperties)

實驗內部只會產生代表 sas 令牌許可權組態的承載。

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

參數

masterKey

string

sasTokenProperties
SasTokenProperties

傳回

Promise<string>