Partilhar via

@azure/cosmos package

Classes

AbortError

Este erro é gerado quando uma operação assíncrona foi anulada. Verifique esse erro testando a name de que a propriedade name do erro corresponde "AbortError".

Exemplo

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

Implementação de EncryptionKeyResolver que usa o Azure Key Vault para chaves gerenciadas pelo cliente.
ChangeFeedIterator

Fornece iterador para feed de alterações.

Use Items.changeFeed() para obter uma instância do iterador.
ChangeFeedIteratorResponse

Uma única página de resposta do Feed de Alterações do Azure Cosmos DB
ChangeFeedPolicy

Representa a configuração da política de feed de alterações para um contêiner no serviço Azure Cosmos DB.
ChangeFeedResponse

Uma única página de resposta do Feed de Alterações do Azure Cosmos DB
ChangeFeedRetentionTimeSpan
ChangeFeedStartFrom

Classe base para onde iniciar um ChangeFeedIterator.
ClientEncryptionKeyResponse

Objeto de resposta para operações ClientEncryptionKey
ClientSideMetrics
Conflict

Use para ler ou excluir uma determinada Conflito por id.

Consulte Conflitos para consultar ou ler todos os conflitos.
ConflictResponse
Conflicts

Use para consultar ou ler todos os conflitos.

Consulte de conflito para ler ou excluir uma determinada de conflito por id.
Container

Operações para ler, substituir ou excluir um contêiner específico existente por id.

Consulte Containers para criar novos contêineres e ler/consultar todos os contêineres; use .containers.

Nota: todas estas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo. Por exemplo, não ligue para container(id).read() antes de cada item.read() chamada, para garantir que o contêiner existe; Faça isso uma vez na inicialização do aplicativo.
ContainerResponse

Objeto de resposta para operações de contêiner
Containers

Operações para criar novos contêineres e ler/consultar todos os contêineres

Consulte de contêiner para ler, substituir ou excluir um contêiner existente; use .container(id).

Nota: todas estas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo. Por exemplo, não ligue para containers.readAll() antes de cada item.read() chamada, para garantir que o contêiner existe; Faça isso uma vez na inicialização do aplicativo.
CosmosClient

Fornece uma representação lógica do lado do cliente da conta de banco de dados do Azure Cosmos DB. Esse cliente é usado para configurar e executar solicitações no serviço de banco de dados do Azure Cosmos DB.

Exemplo

Instanciar um cliente e criar um novo banco de dados

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

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

Exemplo

Instanciar um cliente com uma Política de Conexão personalizada

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,
  },
});

Exemplo

Instanciar um cliente com autenticação do AAD e escopo personalizado

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
  • Este é um tipo de Diagnóstico Cosmos que contém informações de diagnóstico coletadas durante as operações de um cliente. ou seja. Item.read(), Container.create(). Tem três membros:
  1. clientSideRequestStatistics membro contém informações de diagnóstico agregadas, incluindo -
  • pesquisas de metadados. Aqui, todas as solicitações do servidor, além do recurso final pretendido, são consideradas chamadas de metadados. ou seja, para item.read(id), se o cliente fizer chamada de servidor para descobrir pontos de extremidade, ela será considerada como chamada de metadados.
  • tentativas
  • pontos finais contactados.
  • solicitação, estatísticas de carga útil de resposta.
  • gatewayStatistics - Informação correspondente à operação principal. Por exemplo, durante Item.read(), o cliente pode executar muitas operações, ou seja, pesquisa de metadados, etc., mas gatewayStatistics representa as informações de diagnóstico para a operação de leitura real.
  1. diagnosticNode - É uma estrutura semelhante a uma árvore que captura informações de diagnóstico detalhadas. Por padrão, ele é desativado e destina-se a ser usado apenas para depuração em ambientes que não sejam de produção. O tipo de detalhes capturados no diagnosticNode é controlado por CosmosDbDiagnosticLevel.
  • CosmosDbDiagnosticLevel.info - É o valor padrão. Neste nível, apenas clientSideRequestStatistics é capturado. Destina-se a ambientes de produção.
  • CosmosDbDiagnosticLevel.debug - Captura diagnosticNode e clientConfig. Nenhuma carga útil de solicitação e resposta é capturada. Não se destina a ser usado em ambiente de produção.
  • CosmosDbDiagnosticLevel.debug-unsafe - Além dos dados capturados em CosmosDbDiagnosticLevel.debug, também captura cargas úteis de solicitação e resposta. Não se destina a ser usado em ambiente de produção.
  1. clientConfig - Captura informações relacionadas a como o cliente foi configurado durante a inicialização.
Database

Operações para ler ou excluir um banco de dados existente.

Consulte de bancos de dados para criar novos bancos de dados e ler/consultar todos os bancos de dados; use client.databases.

Nota: todas estas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo. Por exemplo, não ligue para database.read() antes de cada chamada item.read(), para garantir que o banco de dados existe; Faça isso uma vez na inicialização do aplicativo.
DatabaseAccount

Representa uma DatabaseAccount no serviço de banco de dados do Azure Cosmos DB.
DatabaseResponse

Objeto de resposta para operações de banco de dados
Databases

Operações para criar novos bancos de dados e ler/consultar todos os bancos de dados

Consulte de banco de dados para ler ou excluir um banco de dados existente; use client.database(id).

Nota: todas estas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo. Por exemplo, não ligue para databases.readAll() antes de cada chamada item.read(), para garantir que o banco de dados existe; Faça isso uma vez na inicialização do aplicativo.
EncryptionQueryBuilder

Representa uma classe builder para criar parâmetros criptografados em consulta parametrizada.
ErrorResponse

Representa uma resposta de erro retornada em operações.
FeedRange

Especifica um intervalo de feed para o changefeed.
FeedResponse
Item

Usado para executar operações em um item específico.

Consulte Itens para operações em todos os itens; Ver container.items.
ItemResponse
Items

Operações para criar novos itens e ler/consultar todos os itens

Consulte Item para ler, substituir ou excluir um contêiner existente; use .item(id).
Offer

Use para ler ou substituir um de Oferta de existente por id.

Consulte Ofertas para consultar ou ler todas as ofertas.
OfferResponse
Offers

Use para consultar ou ler todas as ofertas.

Consulte de Oferta para ler ou substituir uma de Oferta de existente por id.
PartitionKeyBuilder

Builder classe para construir PartitionKey.
Permission

Use para ler, substituir ou excluir uma determinada Permissão por id.

Consulte Permissões para criar, atualizar, consultar ou ler todas as Permissões.
PermissionResponse
Permissions

Use para criar, substituir, consultar e ler todas as Permissões.

Consulte de permissão para ler, substituir ou excluir uma permissão específica por id.
QueryIterator

Representa um objeto QueryIterator, uma implementação de feed ou resposta de consulta que permite a travessia e a iteração sobre a resposta no serviço de banco de dados do Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

Operações para ler, substituir, excluir ou executar um procedimento armazenado específico e existente por id.

Para operações para criar, ler tudo ou consultar Procedimentos Armazenados,
StoredProcedureResponse
StoredProcedures

Operações para criar, atualizar ou ler/consultar todos os Procedimentos Armazenados.

Para operações para ler, substituir, excluir ou executar um procedimento armazenado específico e existente por id, consulte container.storedProcedure().
TimeoutError
Trigger

Operações para ler, substituir ou excluir umde gatilho de .

Use container.triggers para criar, atualizar, consultar ou ler tudo.
TriggerResponse
Triggers

Operações para criar, atualizar, consultar e ler todos os gatilhos.

Use para ler, substituir ou excluir umde gatilho de .
User

Usado para ler, substituir e excluir usuários.

Além disso, você pode acessar as permissões para um determinado usuário via user.permission e user.permissions.

Consulte Usuários criar, atualizar, consultar ou ler tudo.
UserDefinedFunction

Usado para ler, substituir ou excluir uma função definida pelo usuário especificada por id.

Consulte UserDefinedFunction para criar, atualizar, consultar, ler todas as funções definidas pelo usuário.
UserDefinedFunctionResponse
UserDefinedFunctions

Usado para criar, atualizar, consultar ou ler todas as funções definidas pelo usuário.

Consulte UserDefinedFunction para ler, substituir ou excluir uma determinada função definida pelo usuário por id.
UserResponse
Users

Usado para criar, atualizar, consultar e ler todos os usuários.

Consulte de usuário para ler, substituir ou excluir um usuário específico por id.

Interfaces

@azure/cosmos.Index
Agent
BulkOperationResult

representa a resposta para uma operação em massa com a API executeBulkOperations
BulkOptions

Objeto Options usado para modificar a execução em massa. continueOnError (Valor padrão: false) - Continua a execução em massa quando uma operação falha ** OBSERVAÇÃO QUE O PADRÃO SERÁ TRUE NA VERSÃO 4.0
ChangeFeedIteratorOptions

Especifica opções para o feed de alterações

Se nenhuma dessas opções estiver definida, ele começará a ler as alterações a partir de agora para todo o contêiner.
ChangeFeedOptions

Especifica opções para o feed de alterações

Algumas dessas opções controlam onde e quando começar a ler a partir do feed de alterações. A ordem de precedência é:

  • continuação
  • horaDeInício
  • startFromBeginning

Se nenhuma dessas opções estiver definida, ele começará a ler as alterações desde a primeira ChangeFeedIterator.fetchNext() chamada.
ChangeFeedPullModelIterator

Use Items.getChangeFeedIterator() para retornar um iterador que pode iterar todas as alterações de uma chave de partição, intervalo de alimentação ou um contêiner inteiro.
ClientEncryptionIncludedPath

Representa um caminho para criptografia e suas configurações associadas.
ClientEncryptionKeyProperties

Detalhes de uma chave de criptografia de cliente para uso com o serviço Azure Cosmos DB.
ClientEncryptionKeyRequest

Interface que representa uma solicitação de chave de criptografia de cliente no Cosmos DB.
ClientEncryptionOptions

Representa as opções de criptografia associadas a um CosmosClient.
ClientEncryptionPolicy

Representa a política de criptografia do cliente associada a um contêiner.
CompositePath

Representa um caminho composto na política de indexação.
ComputedProperty
ConflictDefinition
ConflictResolutionPolicy

Representa a configuração da política de resolução de conflitos para especificar como resolver conflitos caso gravações de regiões diferentes resultem em conflitos em documentos na coleção no serviço Azure Cosmos DB.
ConnectionPolicy

Representa a política de Conexão associada a um CosmosClient no serviço de banco de dados do Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosEncryptedNumber

Essa interface representa um número criptografado no SDK do Cosmos DB.

Exemplo

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

Representa uma estrutura semelhante a uma árvore, para capturar informações de diagnóstico.
EncryptionKeyResolver

Fornece uma interface para o resolvedor de chaves para diferentes provedores de chaves. Todos os resolvedores devem implementar essa interface.
EncryptionKeyWrapMetadata

Metadados usados para encapsular/desempacotar a chave de criptografia de dados usando uma chave gerenciada pelo cliente
ErrorBody
ExtendedOperationResponse

resposta para uma operação bem-sucedida em massa com a API executeBulkOperations
FailedRequestAttemptDiagnostic

Esse tipo captura informações de diagnóstico sobre uma solicitação com falha à api do servidor.
FeedOptions

As opções de feed e os métodos de consulta.
FullTextIndex

Representa um índice de texto completo na política de indexação.
FullTextPath

Representa um caminho de texto completo a ser indexado no serviço Azure Cosmos DB.
FullTextPolicy

Representa uma política de texto completo para uma coleção no serviço Azure Cosmos DB.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Os itens no Cosmos DB são simplesmente objetos JSON. A maioria das operações Item permite que você forneça seu próprio tipo que estende o ItemDefinition muito simples.

Não é possível usar nenhuma chave reservada. Você pode ver a lista de chaves reservadas em <xref:ItemBody>
JSONArray
JSONObject
Location

Usado para especificar os locais disponíveis, leitura é índice 1 e gravação é índice 0.
MetadataLookUpDiagnostic

Esse tipo contém informações de diagnóstico sobre uma única solicitação de metadados ao servidor.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

Opções que podem ser especificadas para uma solicitação emitida para os servidores do Azure Cosmos DB.=
Resource
RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.
RetryOptions

Representa a política Repetir associada a solicitações limitadas no serviço de banco de dados do Azure Cosmos DB.
SharedOptions

Opções que podem ser especificadas para uma solicitação emitida para os servidores do Azure Cosmos DB.=
SpatialIndex
SqlParameter

Representa um parâmetro em uma consulta SQL parametrizada, especificada em SqlQuerySpec
SqlQuerySpec

Representa uma consulta SQL no serviço Azure Cosmos DB.

As consultas com entradas devem ser parametrizadas para proteger contra a injeção de SQL.

Exemplo

Consulta SQL parametrizada

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

Interface para uma única chave exclusiva passada como parte de UniqueKeyPolicy
UniqueKeyPolicy

Interface para definir chaves exclusivas na criação de contêineres
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition
VectorEmbedding

Representa uma incorporação vetorial. Uma incorporação vetorial é usada para definir um campo vetorial nos documentos.
VectorEmbeddingPolicy

Representa a configuração de política para incorporações de vetor no serviço Azure Cosmos DB.
VectorIndex

Representa um índice de vetor no serviço Azure Cosmos DB. Um índice vetorial é usado para indexar campos vetoriais nos documentos.

Aliases de Tipo

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

Esse tipo contém informações relacionadas à inicialização de CosmosClient
ClientSideRequestStatistics

Este é um tipo de coleção para todas as informações de diagnóstico do lado do cliente.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

Esse tipo contém informações de diagnóstico sobre todas as solicitações de metadados ao servidor durante uma operação de cliente do CosmosDB.
NonePartitionKeyType

O objeto retornado representa um valor de chave de partição que permite criar e acessar itens sem um valor para chave de partição
NullPartitionKeyType

O objeto retornado representa um valor de chave de partição que permite criar e acessar itens com um valor nulo para a chave de partição.
Operation
OperationInput
OperationWithItem
PartitionKey

PartitionKey de um contêiner.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

Um valor primitivo de Partition Key.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

Esse tipo captura informações de diagnóstico sobre tentativas de repetição durante uma operação de cliente CosmosDB.
TokenProvider
UpsertOperation

Enumerações

ChangeFeedMode
ConflictResolutionMode
ConnectionMode

Determina o comportamento de conexão do CosmosClient. Note, atualmente só suportamos o Modo Gateway.
ConsistencyLevel

Representa os níveis de consistência suportados para operações de cliente do Azure Cosmos DB.
O ConsistencyLevel solicitado deve corresponder ou ser mais fraco do que o provisionado para a conta de banco de dados. Níveis de consistência.

Os níveis de consistência por ordem de força são Strong, BoundedStaleness, Session, Consistent Prefix e Eventual.

Consulte https://aka.ms/cosmos-consistency para obter documentação mais detalhada sobre os Níveis de Consistência.
CosmosDbDiagnosticLevel

Nível de diagnóstico do Cosmos DB
CosmosEncryptedNumberType

Este enum representa o tipo de número no SDK do Cosmos DB.
DataType

Define um tipo de dados de destino de uma especificação de caminho de índice no serviço Azure Cosmos DB.
EncryptionAlgorithm

Algoritmos de encriptação suportados para encriptação de dados
EncryptionKeyResolverName

Nomes das implementações de

Consulte EncryptionKeyResolver
EncryptionType

O tipo de criptografia a ser executada.
GeospatialType
IndexKind

Especifica os tipos de índice suportados.
IndexingMode

Especifica os modos de indexação suportados.
KeyEncryptionAlgorithm

Os algoritmos usados para encapsular/desembrulhar a chave de criptografia de dados com a chave de criptografia de chave.
MetadataLookUpType

Este é um enum para Tipo de pesquisas de metadados possíveis.
PartitionKeyDefinitionVersion

Versão de definição de PartitionKey
PartitionKeyKind

Tipo de PartitionKey, ou seja, Hash, MultiHash
PermissionMode

Enum para valores de modo de permissão.
PriorityLevel

Representa o Nível de Prioridade associado a cada solicitação de cliente do Azure Cosmos DB.
As solicitações de baixa prioridade são sempre limitadas antes de qualquer solicitação de alta prioridade.

Por padrão, todas as solicitações são consideradas como solicitações de alta prioridade.

Consulte https://aka.ms/CosmosDB/PriorityBasedExecution para obter documentação mais detalhada sobre a limitação baseada em prioridades.
SpatialType
TriggerOperation

Enum para valores de operação de gatilho. Especifica as operações nas quais um gatilho deve ser executado.
TriggerType

Enum para valores de tipo de gatilho. Especifica o tipo do gatilho.
UserDefinedFunctionType

Enum para valores do tipo udf. Especifica os tipos de funções definidas pelo usuário.
VectorEmbeddingDataType

Representa o tipo de dados do vetor.
VectorEmbeddingDistanceFunction

Representa a função de distância a ser usada para o cálculo de distância entre vetores.
VectorIndexType

Representa o tipo de índice do vetor.

Funções

createAuthorizationSasToken(string, SasTokenProperties)

Apenas experimental interno Gera a carga que representa a configuração de permissão para o token sas.

Detalhes de Função

createAuthorizationSasToken(string, SasTokenProperties)

Apenas experimental interno Gera a carga que representa a configuração de permissão para o token sas.

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

Parâmetros

masterKey

string

sasTokenProperties
SasTokenProperties

Devoluções

Promise<string>