@azure/cosmos package

Esse erro é gerado quando uma operação assíncrona é anulada. Verifique se esse erro está testando o name de que a propriedade de nome 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.
  }
}

Fornece o iterador para o feed de alterações.

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

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

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

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

Classe base para onde iniciar um ChangeFeedIterator.

Use para ler ou excluir uma determinada de Conflito de por ID.

Consulte Conflitos para consultar ou ler todos os conflitos.

Use para consultar ou ler todos os conflitos.

Consulte de Conflito para ler ou excluir um determinado de Conflito de por ID.

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

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

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

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

Operações para criar novos contêineres e leitura/consulta de todos os contêineres

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

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

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

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

exemplo

Criar uma instância de um cliente com a Política de Conexão personalizada

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

• Esse é um tipo de Diagnóstico do Cosmos que contém informações de diagnóstico coletadas durante operações de cliente. Ie. 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 de servidor, além do recurso final pretendido, são consideradas como chamadas de metadados. Ou seja, para item.read(id), se o cliente fizer uma chamada de servidor para descobrir pontos de extremidade, ele será considerado como chamada de metadados.
• Tentativas
• pontos de extremidade contatados.
• solicitação, estatísticas de conteúdo de resposta.
• gatewayStatistics – Informações correspondentes à 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.

2. diagnosticNode – É uma estrutura semelhante a uma árvore que captura informações detalhadas de diagnóstico. Por padrão, ele está desabilitado e destina-se a ser usado apenas para depuração em ambientes não de produção. O tipo de detalhes capturados no diagnosticNode é controlado por CosmosDbDiagnosticLevel.

• CosmosDbDiagnosticLevel.info – é o valor padrão. Nesse nível, somente clientSideRequestStatistics são capturados. Destina-se a ambientes de produção.
• CosmosDbDiagnosticLevel.debug – Captura diagnosticNode e clientConfig. Nenhum conteúdo de solicitação e resposta é capturado. Não é para ser usado no ambiente de produção.
• CosmosDbDiagnosticLevel.debug-unsafe – além dos dados capturados no CosmosDbDiagnosticLevel.debug, também captura cargas de solicitação e resposta. Não é para ser usado no ambiente de produção.

3. clientConfig – captura informações relacionadas à forma como o cliente foi configurado durante a inicialização.

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

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

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

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

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

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

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

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

Especifica um intervalo de feeds para o feed de alterações.

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

Consulte Itens para operações em todos os itens; ver container.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).

Use para ler ou substituir uma oferta existente por ID.

Consulte Ofertas para consultar ou ler todas as ofertas.

Use para consultar ou ler todas as Ofertas.

Consulte de oferta para ler ou substituir um de oferta de existente por ID.

Classe de construtor para a criação de PartitionKey.

Use para ler, substituir ou excluir uma determinada permissão de por ID.

Consulte Permissões para criar, upsert, consultar ou ler todas as Permissões.

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

Consulte Permissão para ler, substituir ou excluir uma permissão específica por ID.

Representa um objeto QueryIterator, uma implementação de feed ou resposta de consulta que permite a passagem e a iteração sobre a resposta no serviço de banco de dados do Azure Cosmos DB.

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

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,

Operações para criação, upserting ou leitura/consulta de todos os procedimentos armazenados.

Para que as operações leiam, substituam, excluam ou executem um procedimento armazenado específico e existente por ID, consulte container.storedProcedure().

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

Use container.triggers para criar, upsert, consultar ou ler tudo.

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

Use container.triggers para ler, substituir ou excluir um gatilho .

Usado para ler, substituir e excluir Usuários.

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

Consulte Usuários para criar, upsert, consultar ou ler tudo.

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

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

Usado para criar, upsert, 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.

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

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

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 ESTE PADRÃO SERÁ TRUE NA VERSÃO 4.0

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.

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

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

• continuação
• startTime
• startFromBeginning

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

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

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

Representa a configuração de 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 do Azure Cosmos DB.

Representa a política de conexão associada a um CosmosClient no serviço de banco de dados do Azure Cosmos DB.

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

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

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

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.

Você não pode usar chaves reservadas. Você pode ver a lista de chaves reservadas no <xref:ItemBody>

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

Esse tipo contém informações de diagnóstico sobre uma única solicitação de metadados para o servidor.

Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.=

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

Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.=

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

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

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

exemplo

Consulta SQL parametrizada

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

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

Interface para definir chaves exclusivas na criação de contêiner

Representa uma inserção de vetor. Uma inserção de vetor é usada para definir um campo de vetor nos documentos.

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

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

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

Esse é um tipo de coleção para todas as informações de diagnóstico do lado do cliente.

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

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

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.

PartitionKey de um contêiner.

Um valor de chave de partição primitiva.

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

Determina o comportamento de conexão do CosmosClient. Observe que, no momento, só oferecemos suporte ao Modo de Gateway.

Representa os níveis de consistência com suporte 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 uma documentação mais detalhada sobre níveis de consistência.

Nível de diagnóstico do Cosmos DB

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

Especifica os tipos de índice com suporte.

Especifica os modos de indexação com suporte.

Essa é uma enumeração possível para pesquisas de tipo de metadados.

Versão de definição partitionKey

Tipo de PartitionKey, ou seja, Hash, MultiHash

Enumeração para valores de modo de permissão.

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 uma documentação mais detalhada sobre limitação baseada em prioridade.

Enumeração para valores de operação de gatilho. especifica as operações nas quais um gatilho deve ser executado.

Enumeração para valores de tipo de gatilho. Especifica o tipo do gatilho.

Enumeração para valores de tipo udf. Especifica os tipos de funções definidas pelo usuário.

Representa o tipo de dados do vetor.

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

Representa o tipo de índice do vetor.

Interno experimental gera apenas o conteúdo que representa a configuração de permissão para o token sas.