Partilhar via


cosmos Pacote

Pacote

aio

Módulos

auth

Funções auxiliares de autorização no serviço de base de dados do Azure Cosmos.

container

Criar, ler, atualizar e eliminar itens no serviço API SQL do Azure Cosmos DB.

cosmos_client

Criar, ler e eliminar bases de dados no serviço API SQL do Azure Cosmos DB.

database

Interagir com bases de dados no serviço API SQL do Azure Cosmos DB.

diagnostics

Ferramentas de diagnóstico para operações do serviço de base de dados do Azure Cosmos.

documents

Classes e enums para documentos no serviço de base de dados do Azure Cosmos.

errors

Exceções específicas do serviço no serviço de base de dados do Azure Cosmos.

.. aviso:: este módulo foi preterido. Em vez disso, utilize azure.cosmos.exceptions.

exceptions

Exceções específicas do serviço no serviço de base de dados do Azure Cosmos.

http_constants

Constantes HTTP no serviço de base de dados do Azure Cosmos.

offer

Crie propriedades de débito no serviço API SQL do Azure Cosmos DB.

partition_key

Crie chaves de partição no serviço API SQL do Azure Cosmos DB.

permission

Crie permissões no serviço API SQL do Azure Cosmos DB.

scripts

Crie, leia, atualize e elimine e execute scripts no serviço API SQL do Azure Cosmos DB.

user

Criar, ler, atualizar e eliminar utilizadores no serviço API SQL do Azure Cosmos DB.

Classes

ConnectionRetryPolicy
ConsistencyLevel

Representa os níveis de consistência suportados para as operações de cliente do Azure Cosmos.

O ConsistencyLevel pedido tem de corresponder ou ser mais fraco do que o aprovisionado para a conta de base de dados. Níveis de consistência.

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

ContainerProxy

Uma interface para interagir com um Contentor de BD específico.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o get_container_client método para obter um contentor existente ou o create_container método para criar um novo contentor.

Um contentor numa base de dados da API SQL do Azure Cosmos DB é uma coleção de documentos, cada um dos quais é representado como um Item.

CosmosClient

Uma representação lógica do lado do cliente de uma conta do Azure Cosmos DB.

Utilize este cliente para configurar e executar pedidos para o serviço Azure Cosmos DB.

Recomenda-se manter uma única instância do CosmosClient por duração da aplicação, o que permite uma gestão e desempenho de ligações eficientes.

A inicialização do CosmosClient é uma operação intensiva – não utilize instâncias do CosmosClient de inicialização como credenciais ou validações de conectividade de rede.

Instanciar um novo CosmosClient.

DataType

Especifica o tipo de dados das especificações de índice.

DatabaseAccount

Conta de base de dados.

Uma DatabaseAccount é o contentor para bases de dados.

DatabaseProxy

Uma interface para interagir com uma base de dados específica.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o get_database_client método .

Uma base de dados contém um ou mais contentores, cada um dos quais pode conter itens, procedimentos armazenados, acionadores e funções definidas pelo utilizador.

Uma base de dados também pode ter utilizadores associados, cada um dos quais está configurado com um conjunto de permissões para aceder a determinados contentores, procedimentos armazenados, acionadores, funções definidas pelo utilizador ou itens.

Uma base de dados da API SQL do Azure Cosmos DB tem as seguintes propriedades geradas pelo sistema. Estas propriedades são só de leitura:

  • _rid: O ID do recurso.

  • _ts: quando o recurso foi atualizado pela última vez. O valor é um carimbo de data/hora.

  • _self: o URI endereçável exclusivo para o recurso.

  • _etag: o etag de recursos necessário para o controlo de simultaneidade otimista.

  • _colls: o caminho endereçável do recurso de coleções.

  • _users: o caminho endereçável do recurso de utilizadores.

IndexKind

Especifica o tipo de índice de especificações de índice.

IndexingMode

Especifica os modos de indexação suportados.

PartitionKey

Chave utilizada para particionar um contentor em partições lógicas.

Veja https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey para obter informações sobre como escolher chaves de partição.

Permission

Representa um objeto permissão no serviço API SQL do Azure Cosmos DB.

PermissionMode

Enumeração que especifica a aplicação de uma permissão.

ProxyConfiguration

Configuração para um proxy.

SSLConfiguration

Configuração para ligações SSL.

Consulte https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification para obter mais informações.

ScriptsProxy

Uma interface para interagir com os procedimentos armazenados.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o scripts atributo .

ThroughputProperties

Representa as propriedades de débito num contentor da API SQL do Azure Cosmos DB.

Para ler e atualizar as propriedades de débito, utilize os métodos associados no <xref:Container>. Se configurar o dimensionamento automático, auto_scale_max_throughput tem de ser definido e auto_scale_increment_percent também podem ser definidos em conjunto com o mesmo. O valor de offer_throughput não poderá ser definido em conjunto com as definições de dimensionamento automático.

TriggerOperation

Especifica as operações em que um acionador deve ser executado.

TriggerType

Especifica o tipo de acionador.

UserProxy

Uma interface para interagir com um utilizador específico.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o get_user_client método .