@azure/cosmos package
Classes
AbortError |
Esse erro é gerado quando uma operação assíncrona é anulada.
Verifique se esse erro está testando o exemplo
|
ChangeFeedIterator |
Fornece o iterador para o feed de alterações. Use |
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 do 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. |
ClientSideMetrics | |
Conflict |
Use para ler ou excluir uma determinada de Conflito de Consulte Conflitos para consultar ou ler todos os conflitos. |
ConflictResponse | |
Conflicts |
Use para consultar ou ler todos os conflitos. Consulte |
Container |
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 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 |
ContainerResponse |
Objeto de resposta para operações de contêiner |
Containers |
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 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 |
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
exemplo Criar uma instância de um cliente com a Política de Conexão personalizada
|
CosmosDiagnostics |
|
Database |
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 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 |
DatabaseAccount |
Representa um 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 banco de dados para ler ou excluir um banco de dados existente; use 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 |
ErrorResponse | |
FeedRange |
Especifica um intervalo de feeds para o feed de alterações. |
FeedResponse | |
Item |
Usado para executar operações em um item específico. Consulte Itens para operações em todos os itens; ver |
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 |
Offer |
Use para ler ou substituir uma oferta existente por ID. Consulte Ofertas para consultar ou ler todas as ofertas. |
OfferResponse | |
Offers |
Use para consultar ou ler todas as Ofertas. Consulte |
PartitionKeyBuilder |
Classe de construtor para a criação de PartitionKey. |
Permission |
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. |
PermissionResponse | |
Permissions |
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. |
QueryIterator |
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. |
QueryMetrics | |
QueryPreparationTimes | |
ResourceResponse | |
RestError |
Um tipo de erro personalizado para solicitações de pipeline com falha. |
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 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 |
TimeoutError | |
Trigger |
Operações para ler, substituir ou excluir um gatilho . Use |
TriggerResponse | |
Triggers |
Operações para criar, upsert, consultar e ler todos os gatilhos. Use |
User |
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 Consulte Usuários para criar, upsert, consultar ou ler tudo. |
UserDefinedFunction |
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. |
UserDefinedFunctionResponse | |
UserDefinedFunctions |
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. |
UserResponse | |
Users |
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. |
Interfaces
@azure/cosmos.IndexAgent | |
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 ESTE 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 no feed de alterações. A ordem de precedência é:
Se nenhuma dessas opções estiver definida, ela começará a ler as alterações da primeira chamada |
ChangeFeedPullModelIterator |
Use |
CompositePath |
Representa um caminho composto na política de indexação. |
ComputedProperty | |
ConflictDefinition | |
ConflictResolutionPolicy |
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. |
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 | |
CosmosHeaders | |
CreateOperationInput | |
DatabaseDefinition | |
DatabaseRequest | |
DeleteOperationInput | |
DiagnosticNode |
Representa uma árvore como estrutura, para capturar informações de diagnóstico. |
ErrorBody | |
FailedRequestAttemptDiagnostic |
Esse tipo captura informações de diagnóstico sobre uma solicitação com falha na API do servidor. |
FeedOptions |
As opções de feed e os métodos de consulta. |
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. Você não pode usar chaves reservadas. Você pode ver a lista de chaves reservadas no <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 para o servidor. |
OfferDefinition | |
OperationBase | |
OperationResponse | |
PartitionKeyDefinition | |
PartitionKeyRangePropertiesNames | |
PatchOperationInput | |
PermissionBody | |
PermissionDefinition | |
ReadOperationInput | |
ReplaceOperationInput | |
RequestOptions |
Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.= |
Resource | |
RetryOptions |
Representa a política de repetição associada com solicitações limitadas no serviço de banco de dados do Azure Cosmos DB. |
SharedOptions |
Opções que podem ser especificadas para um emitido solicitado 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 do Azure Cosmos DB. As consultas com entradas devem ser parametrizadas para proteger contra injeção de SQL. exemplo Consulta SQL parametrizada
|
StoredProcedureDefinition | |
TriggerDefinition | |
UniqueKey |
Interface para uma única chave exclusiva passada como parte do UniqueKeyPolicy |
UniqueKeyPolicy |
Interface para definir chaves exclusivas na criação de contêiner |
UpsertOperationInput | |
UserDefinedFunctionDefinition | |
UserDefinition | |
VectorEmbedding |
Representa uma inserção de vetor. Uma inserção de vetor é usada para definir um campo de vetor nos documentos. |
VectorEmbeddingPolicy |
Representa a configuração de política para inserções de vetor no serviço do Azure Cosmos DB. |
VectorIndex |
Representa um índice de vetor no serviço do Azure Cosmos DB. Um índice de vetor é usado para indexar campos de vetor nos documentos. |
Aliases de tipo
AggregateType | |
BulkOperationResponse | |
BulkPatchOperation | |
ClientConfigDiagnostic |
Esse tipo contém informações relacionadas à inicialização de |
ClientSideRequestStatistics |
Esse é 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 para o 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 de chave de partição primitiva. |
ReadOperation | |
RemoveOperation | |
ReplaceOperation | |
RetryDiagnostics |
Esse tipo captura informações de diagnóstico sobre tentativas de repetição durante uma operação de cliente do CosmosDB. |
TokenProvider | |
UpsertOperation |
Enumerações
ChangeFeedMode | |
ConflictResolutionMode | |
ConnectionMode |
Determina o comportamento de conexão do CosmosClient. Observe que, no momento, só oferecemos suporte ao Modo de Gateway. |
ConsistencyLevel |
Representa os níveis de consistência com suporte para operações de cliente do Azure Cosmos DB. 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. |
CosmosDbDiagnosticLevel |
Nível de diagnóstico do Cosmos DB |
DataType |
Define um tipo de dados de destino de uma especificação de caminho de índice no serviço do Azure Cosmos DB. |
GeospatialType | |
IndexKind |
Especifica os tipos de índice com suporte. |
IndexingMode |
Especifica os modos de indexação com suporte. |
MetadataLookUpType |
Essa é uma enumeração possível para pesquisas de tipo de metadados. |
PartitionKeyDefinitionVersion |
Versão de definição partitionKey |
PartitionKeyKind |
Tipo de PartitionKey, ou seja, Hash, MultiHash |
PermissionMode |
Enumeração 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. 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. |
SpatialType | |
TriggerOperation |
Enumeração para valores de operação de gatilho. especifica as operações nas quais um gatilho deve ser executado. |
TriggerType |
Enumeração para valores de tipo de gatilho. Especifica o tipo do gatilho. |
UserDefinedFunctionType |
Enumeração para valores de 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
create |
Interno experimental gera apenas o conteúdo que representa a configuração de permissão para o token sas. |
Detalhes da função
createAuthorizationSasToken(string, SasTokenProperties)
Interno experimental gera apenas o conteúdo 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
Retornos
Promise<string>