Dela via


cosmos Paket

Paket

aio

Moduler

auth

Auktoriseringshjälpfunktioner i Azure Cosmos-databastjänsten.

container

Skapa, läsa, uppdatera och ta bort objekt i Azure Cosmos DB SQL API-tjänsten.

cosmos_client

Skapa, läsa och ta bort databaser i Azure Cosmos DB SQL API-tjänsten.

database

Interagera med databaser i Azure Cosmos DB SQL API-tjänsten.

diagnostics

Diagnostikverktyg för Azure Cosmos-databastjänståtgärder.

documents

Klasser och uppräkningar för dokument i Azure Cosmos-databastjänsten.

errors

Tjänstspecifika undantag i Azure Cosmos-databastjänsten.

.. warning:: Den här modulen är INAKTUELL. Använd azure.cosmos.exceptions i stället.

exceptions

Tjänstspecifika undantag i Azure Cosmos-databastjänsten.

http_constants

HTTP-konstanter i Azure Cosmos-databastjänsten.

offer

Skapa dataflödesegenskaper i Azure Cosmos DB SQL API-tjänsten.

partition_key

Skapa partitionsnycklar i Azure Cosmos DB SQL API-tjänsten.

permission

Skapa behörigheter i Azure Cosmos DB SQL API-tjänsten.

scripts

Skapa, läsa, uppdatera och ta bort och köra skript i Azure Cosmos DB SQL API-tjänsten.

user

Skapa, läsa, uppdatera och ta bort användare i Azure Cosmos DB SQL API-tjänsten.

Klasser

ConnectionRetryPolicy
ConsistencyLevel

Representerar de konsekvensnivåer som stöds för Azure Cosmos-klientåtgärder.

Den begärda ConsistencyLevel måste matcha eller vara svagare än den som har etablerats för databaskontot. Konsekvensnivåer.

Konsekvensnivåer efter styrkeordning är Strong, BoundedStaleness, Session, ConsistentPrefix och Eventual.

ContainerProxy

Ett gränssnitt för att interagera med en specifik DB-container.

Den här klassen ska inte instansieras direkt. Använd get_container_client i stället metoden för att hämta en befintlig container eller create_container metoden för att skapa en ny container.

En container i en Azure Cosmos DB SQL API-databas är en samling dokument som vart och ett representeras som ett objekt.

CosmosClient

En logisk representation på klientsidan av ett Azure Cosmos DB-konto.

Använd den här klienten för att konfigurera och köra begäranden till Azure Cosmos DB-tjänsten.

Vi rekommenderar att du underhåller en enda instans av CosmosClient per livslängd för programmet, vilket möjliggör effektiv anslutningshantering och prestanda.

CosmosClient-initiering är en tung åtgärd – använd inte initiering av CosmosClient-instanser som autentiseringsuppgifter eller verifiering av nätverksanslutning.

Instansiera en ny CosmosClient.

DataType

Anger datatypen för indexspecifikationer.

DatabaseAccount

Databaskonto.

Ett DatabaseAccount är containern för databaser.

DatabaseProxy

Ett gränssnitt för att interagera med en specifik databas.

Den här klassen ska inte instansieras direkt. Använd i get_database_client stället metoden .

En databas innehåller en eller flera containrar som var och en kan innehålla objekt, lagrade procedurer, utlösare och användardefinierade funktioner.

En databas kan också ha associerade användare, som var och en är konfigurerad med en uppsättning behörigheter för åtkomst till vissa containrar, lagrade procedurer, utlösare, användardefinierade funktioner eller objekt.

En Azure Cosmos DB SQL API-databas har följande systemgenererade egenskaper. Dessa egenskaper är skrivskyddade:

  • _rid: Resurs-ID.

  • _ts: När resursen senast uppdaterades. Värdet är en tidsstämpel.

  • _self: Resursens unika adresserbara URI.

  • _etag: Resursetaggar som krävs för optimistisk samtidighetskontroll.

  • _colls: Den adresserbara sökvägen för samlingsresursen.

  • _users: Den adresserbara sökvägen för användarresursen.

IndexKind

Anger indextyp för indexspecifikationer.

IndexingMode

Anger vilka indexeringslägen som stöds.

PartitionKey

Nyckel som används för att partitionera en container i logiska partitioner.

Mer https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey information om hur du väljer partitionsnycklar finns i.

Permission

Representerar ett behörighetsobjekt i Azure Cosmos DB SQL API-tjänsten.

PermissionMode

Uppräkning som anger tillämplighet för en behörighet.

ProxyConfiguration

Konfiguration för en proxy.

SSLConfiguration

Konfiguration för SSL-anslutningar.

Mer information finns i https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification.

ScriptsProxy

Ett gränssnitt för att interagera med lagrade procedurer.

Den här klassen ska inte instansieras direkt. Använd i stället attributet scripts .

ThroughputProperties

Representerar dataflödesegenskaperna i en Azure Cosmos DB SQL API-container.

Om du vill läsa och uppdatera dataflödesegenskaper använder du de associerade metoderna på <xref:Container>. Om du konfigurerar automatisk skalning måste auto_scale_max_throughput anges och auto_scale_increment_percent kan också ställas in tillsammans med den. Värdet för offer_throughput tillåts inte att anges tillsammans med inställningarna för automatisk skalning.

TriggerOperation

Anger de åtgärder som en utlösare ska köras på.

TriggerType

Anger typen av utlösare.

UserProxy

Ett gränssnitt för att interagera med en specifik användare.

Den här klassen ska inte instansieras direkt. Använd get_user_client i stället metoden .