cosmos Pacote

Pacotes

aio

Módulos

auth

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

container

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

cosmos_client

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

database

Interaja com bancos de dados no serviço de API de SQL do Azure Cosmos DB.

diagnostics

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

documents

Classes e enumerações para documentos no serviço de banco de dados do Azure Cosmos.

errors

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

.. aviso:: este módulo foi PRETERIDO. Use azure.cosmos.exceptions em vez disso.

exceptions

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

http_constants

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

offer

Crie propriedades de taxa de transferência no serviço de API de SQL do Azure Cosmos DB.

partition_key

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

permission

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

scripts

Criar, ler, atualizar e excluir e executar scripts no serviço de API de SQL do Azure Cosmos DB.

user

Criar, ler, atualizar e excluir usuários no serviço de API de SQL do Azure Cosmos DB.

Classes

ConnectionRetryPolicy
ConsistencyLevel

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

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, ConsistentPrefix e Eventual.

ContainerProxy

Uma interface para interagir com um contêiner de banco de dados específico.

Essa classe não deve ser instanciada diretamente. Em vez disso, use o get_container_client método para obter um contêiner existente ou o create_container método para criar um novo contêiner.

Um contêiner em um banco de dados da API sql do Azure Cosmos DB é uma coleção de documentos, cada um deles representado como um Item.

CosmosClient

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

Use esse cliente para configurar e executar solicitações para o serviço do Azure Cosmos DB.

É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes.

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

Criar uma instância de um novo CosmosClient.

DataType

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

DatabaseAccount

Conta de banco de dados.

Uma DatabaseAccount é o contêiner para bancos de dados.

DatabaseProxy

Uma interface para interagir com um banco de dados específico.

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

Um banco de dados contém um ou mais contêineres, cada um deles pode conter itens, procedimentos armazenados, gatilhos e funções definidas pelo usuário.

Um banco de dados também pode ter usuários associados, cada um deles configurado com um conjunto de permissões para acessar determinados contêineres, procedimentos armazenados, gatilhos, funções definidas pelo usuário ou itens.

Um banco de dados da API de SQL do Azure Cosmos DB tem as propriedades geradas pelo sistema a seguir. Essas propriedades são somente leitura:

  • _rid: a 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: a etag de recurso necessária para o controle de simultaneidade otimista.

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

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

IndexKind

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

IndexingMode

Especifica os modos de indexação com suporte.

PartitionKey

Chave usada para particionar um contêiner em partições lógicas.

Consulte 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 Permission no serviço de API de SQL do Azure Cosmos DB.

PermissionMode

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

ProxyConfiguration

Configuração para um proxy.

SSLConfiguration

Configuração para conexõ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 procedimentos armazenados.

Essa classe não deve ser instanciada diretamente. Em vez disso, use o scripts atributo .

ThroughputProperties

Representa as propriedades de taxa de transferência em um contêiner da API de SQL do Azure Cosmos DB.

Para ler e atualizar as propriedades de taxa de transferência, use os métodos associados no <xref:Container>. Se estiver configurando o dimensionamento automático, auto_scale_max_throughput precisará ser definido e auto_scale_increment_percent também poderá ser definido em conjunto com ele. O valor de offer_throughput não terá permissão para ser definido em conjunto com as configurações de dimensionamento automático.

TriggerOperation

Especifica as operações nas quais um gatilho deve ser executado.

TriggerType

Especifica o tipo de um gatilho.

UserProxy

Uma interface para interagir com um usuário específico.

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