你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure/cosmos package

  • 参考

类

AbortError

异步操作中止时，将引发此错误。 通过测试 name 错误的 name 属性是否与 匹配 "AbortError"来检查此错误。

示例

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

用于按 ID 读取或删除给定 的 Conflict 。

请参阅 冲突 以查询或读取所有冲突。
ConflictResponse
Conflicts

使用 查询或读取所有冲突。

请参阅 冲突 以按 ID 读取或删除给定 的 Conflict 。
Container

用于按 ID 读取、替换或删除特定现有容器的操作。

请参阅 用于 创建新容器和读取/查询所有容器的容器;使用 .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 (id) ，如果客户端进行服务器调用以发现终结点，则会将其视为元数据调用。
  • retries
  • 已联系终结点。
  • 请求、响应有效负载统计信息。
  • gatewayStatistics - 对应于main操作的信息。 例如，在 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

用于对特定项执行操作。

有关所有项的操作，请参阅 Items ;请参阅 container.items。
ItemResponse
Items

用于创建新项和读取/查询所有项的操作

有关读取、替换或删除现有容器，请参阅 Item ;使用 .item(id)。
Offer

使用 按 ID 读取或替换现有 产品/服务 。

请参阅 产品/服务 以查询或读取所有产品/服务。
OfferResponse
Offers

使用 查询或读取所有产品/服务。

请参阅 产品/服务 ，按 ID 读取或替换现有 产品/服务 。
PartitionKeyBuilder

用于生成 PartitionKey 的 Builder 类。
Permission

使用 按 ID 读取、替换或删除给定 的权限 。

请参阅 创建 、更新插入、查询或读取所有权限的权限。
PermissionResponse
Permissions

用于创建、替换、查询和读取所有权限。

请参阅 按 ID 读取、替换或删除特定权限的权限。
QueryIterator

表示 QueryIterator 对象，这是源或查询响应的实现，用于在 Azure Cosmos DB 数据库服务中遍历和循环访问响应。
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

失败管道请求的自定义错误类型。
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

用于按 ID 读取、替换、删除或执行特定现有存储过程的操作。

对于要创建、读取所有或查询存储过程的操作，
StoredProcedureResponse
StoredProcedures

用于创建、更新插入或读取/查询所有存储过程的操作。

有关按 ID 读取、替换、删除或执行特定现有存储过程的操作，请参阅 container.storedProcedure()。
TimeoutError
Trigger

读取、替换或删除 触发器的操作。

用于 container.triggers 创建、更新插入、查询或读取全部内容。
TriggerResponse
Triggers

用于创建、更新插入、查询和读取所有触发器的操作。

用于 container.triggers 读取、替换或删除 触发器。
User

用于读取、替换和删除用户。

此外，还可以通过 user.permission 和 user.permissions访问给定用户的权限。

请参阅 要 创建、更新插入、查询或读取全部的用户。
UserDefinedFunction

用于按 ID 读取、替换或删除指定的用户定义函数。

请参阅 UserDefinedFunction 以创建、更新插入、查询和读取所有用户定义的函数。
UserDefinedFunctionResponse
UserDefinedFunctions

用于创建、更新插入、查询或读取所有用户定义函数。

请参阅 UserDefinedFunction ，按 ID 读取、替换或删除给定的用户定义的函数。
UserResponse
Users

用于创建、更新插入、查询和读取所有用户。

请参阅 用户 以按 ID 读取、替换或删除特定用户。

接口

@azure/cosmos.Index
Agent
BulkOptions

用于修改批量执行的 Options 对象。 continueOnError (默认值：false) - 在操作失败时继续批量执行 ** 注意 这在 4.0 版本中默认为 TRUE
ChangeFeedIteratorOptions

指定更改源的选项

如果未设置这些选项，它将从现在开始读取整个容器的更改。
ChangeFeedOptions

指定更改源的选项

其中一些选项控制从更改源开始读取的位置和时间。 优先级顺序为：

  • 持续标记
  • 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

表示在 SqlQuerySpec 中指定的参数化 SQL 查询中的参数
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 必须与为数据库帐户预配的 ConsistencyLevel 匹配或弱。 一致性级别。

按强度顺序排列的一致性级别为 Strong、BoundedStaleness、Session、一致前缀和最终。

有关一致性级别的更详细文档，请参阅 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>