CosmosClient Osztály
Egy Azure Cosmos DB-fiók ügyféloldali logikai ábrázolása.
Ezzel az ügyfélprogramtal konfigurálhatja és végrehajthatja az Azure Cosmos DB szolgáltatásra irányuló kéréseket.
Azt javasoljuk, hogy az alkalmazás élettartama során egyetlen CosmosClient-példányt tartson fenn, amely lehetővé teszi a hatékony kapcsolatkezelést és -teljesítményt.
A CosmosClient inicializálása nehéz művelet – ne használjon inicializálási CosmosClient-példányokat hitelesítő adatokként vagy hálózati kapcsolat érvényesítéseként.
Új CosmosClient példányosítása.
- Öröklődés
-
builtins.objectCosmosClient
Konstruktor
CosmosClient(url: str, credential: str | Dict[str, str] | TokenCredential, *, consistency_level: str | None = None, **kwargs: Any)
Paraméterek
Lehet a fiókkulcs vagy az erőforrás-jogkivonatok szótára.
- consistency_level
- str
A munkamenethez használandó konzisztenciaszint. Az alapértelmezett érték a Nincs (fiókszintű). További információ a konzisztenciaszintekkel és a lehetséges értékekkel kapcsolatban: https://aka.ms/cosmos-consistency-levels
- timeout
- int
Abszolút időtúllépés másodpercben a HTTP-kérések és -válaszok kombinált feldolgozásához.
- connection_timeout
- int
A HTTP-kérés időtúllépése másodpercben.
- connection_mode
- str
Az ügyfél kapcsolati módja – jelenleg csak az átjárót támogatja.
- proxy_config
- ProxyConfiguration
Kapcsolatproxy konfigurálása.
- ssl_config
- SSLConfiguration
Kapcsolat SSL-konfigurációja.
- connection_verify
- bool
A kapcsolat ellenőrzéséhez az alapértelmezett érték Igaz.
- connection_cert
- str
Alternatív tanúsítvány a kapcsolat ellenőrzéséhez.
- retry_total
- int
Újrapróbálkozási kísérletek maximális száma.
- retry_backoff_max
- int
Az újrapróbálkozás maximális várakozási ideje másodpercben.
- retry_fixed_interval
- int
Rögzített újrapróbálkozási időköz ezredmásodpercben.
- retry_read
- int
A szoftvercsatornák olvasási újrapróbálkozási kísérleteinek maximális száma.
- retry_connect
- int
A csatlakozási hibák újrapróbálkozási kísérleteinek maximális száma.
- retry_status
- int
A hibaállapot-kódokkal kapcsolatos újrapróbálkozási kísérletek maximális száma.
- retry_backoff_factor
- float
Az újrapróbálkozási kísérletek közötti várakozási idő kiszámításának tényezője.
- enable_endpoint_discovery
- bool
Engedélyezze a végpontfelderítést a georeplikált adatbázisfiókokhoz. (Alapértelmezett: Igaz)
- enable_diagnostics_logging
- bool
Engedélyezze a CosmosHttpLogging szabályzatot. A működéshez a naplózóval együtt kell használni.
- logger
- Logger
A kérésdiagnosztikák gyűjtéséhez használandó naplózó. Az átadás ügyfélszinten (az összes kérés naplózásához) vagy egyetlen kérelemszinten adhatók át. A kérések naplózása info szinten fog folytatódni.
Példák
Hozza létre a Cosmos DB-ügyfél új példányát:
async with CosmosClient(url, key) as client:
Metódusok
close |
Zárja be a CosmosClient ezen példányát. |
create_database |
Hozzon létre egy új adatbázist a megadott azonosítóval (névvel). |
create_database_if_not_exists |
Hozza létre az adatbázist, ha még nem létezik. Ha az adatbázis már létezik, a rendszer a meglévő beállításokat adja vissza. .. megjegyzés:: Ez a függvény nem ellenőrzi vagy frissíti a meglévő adatbázis-beállításokat, és nem kínál átviteli sebességet, ha eltérnek a átadotttól. |
delete_database |
Törölje az adatbázist a megadott azonosítóval (névvel). |
from_connection_string |
Hozzon létre egy CosmosClient-példányt egy kapcsolati sztring. Ez lekérhető a Azure Portal. A választható kulcsszóargumentumok teljes listáját a CosmosClient konstruktorban találja. |
get_database_client |
Egy meglévő adatbázis lekérése az azonosító (név) azonosítójával. |
list_databases |
A Cosmos DB SQL-adatbázisfiókban található adatbázisok listázása. |
query_databases |
Egy Cosmos DB SQL-adatbázisfiók adatbázisainak lekérdezése. |
close
Zárja be a CosmosClient ezen példányát.
async close() -> None
create_database
Hozzon létre egy új adatbázist a megadott azonosítóval (névvel).
async create_database(id: str, **kwargs: Any) -> DatabaseProxy
Paraméterek
- offer_throughput
- Union[int, ThroughputProperties]
Az ajánlathoz kiosztott átviteli sebesség.
- session_token
- str
Jogkivonat a munkamenet-konzisztenciához.
- etag
- str
ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.
- match_condition
- MatchConditions
Az etagen használandó egyezési feltétel.
Válaszok
Az új adatbázist jelölő DatabaseProxy-példány.
Visszatérési típus
Kivételek
A megadott azonosítóval rendelkező adatbázis már létezik.
Példák
Hozzon létre egy adatbázist a Cosmos DB-fiókban:
database_name = "testDatabase"
try:
database = await client.create_database(id=database_name)
except exceptions.CosmosResourceExistsError:
database = client.get_database_client(database=database_name)
create_database_if_not_exists
Hozza létre az adatbázist, ha még nem létezik.
Ha az adatbázis már létezik, a rendszer a meglévő beállításokat adja vissza.
.. megjegyzés:: Ez a függvény nem ellenőrzi vagy frissíti a meglévő adatbázis-beállításokat, és nem kínál átviteli sebességet, ha eltérnek a átadotttól.
async create_database_if_not_exists(id: str, **kwargs: Any) -> DatabaseProxy
Paraméterek
- offer_throughput
- Union[int, ThroughputProperties]
Az ajánlathoz kiosztott átviteli sebesség.
- session_token
- str
Jogkivonat a munkamenet-konzisztenciához.
- etag
- str
ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.
- match_condition
- MatchConditions
Az etagen használandó egyezési feltétel.
Válaszok
Az adatbázist jelölő DatabaseProxy-példány.
Visszatérési típus
Kivételek
Az adatbázis olvasása vagy létrehozása nem sikerült.
delete_database
Törölje az adatbázist a megadott azonosítóval (névvel).
async delete_database(database: str | DatabaseProxy | Dict[str, Any], **kwargs: Any) -> None
Paraméterek
Az azonosító (név), a törölni kívánt adatbázis tulajdonságait vagy DatabaseProxy példányát jelölő diktálás.
- session_token
- str
Jogkivonat a munkamenet-konzisztenciához.
- etag
- str
ETag-érték vagy helyettesítő karakter (*). Annak ellenőrzésére szolgál, hogy az erőforrás megváltozott-e, és a match_condition paraméter által megadott feltételnek megfelelően működik-e.
- match_condition
- MatchConditions
Az etagen használandó egyezési feltétel.
Visszatérési típus
Kivételek
Ha az adatbázis nem törölhető.
from_connection_string
Hozzon létre egy CosmosClient-példányt egy kapcsolati sztring.
Ez lekérhető a Azure Portal. A választható kulcsszóargumentumok teljes listáját a CosmosClient konstruktorban találja.
from_connection_string(conn_str: str, *, credential: str | Dict[str, str] | None = None, consistency_level: str | None = None, **kwargs: Any) -> CosmosClient
Paraméterek
Alternatív hitelesítő adatok a kapcsolati sztring megadott kulcs helyett.
- consistency_level
- str
A munkamenethez használandó konzisztenciaszint. Az alapértelmezett érték a Nincs (fiókszintű). További információ a konzisztenciaszintekkel és a lehetséges értékekkel kapcsolatban: https://aka.ms/cosmos-consistency-levels
Válaszok
CosmosClient-példány
Visszatérési típus
get_database_client
Egy meglévő adatbázis lekérése az azonosító (név) azonosítójával.
get_database_client(database: str | DatabaseProxy | Dict[str, Any]) -> DatabaseProxy
Paraméterek
A lekérni kívánt adatbázis tulajdonságait vagy DatabaseProxy példányát jelölő azonosító (név), diktálás.
Válaszok
A beolvasott adatbázist jelölő DatabaseProxy-példány .
Visszatérési típus
list_databases
A Cosmos DB SQL-adatbázisfiókban található adatbázisok listázása.
list_databases(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Paraméterek
- max_item_count
- int
Az enumerálási műveletben visszaadandó elemek maximális száma.
- session_token
- str
Jogkivonat a munkamenet-konzisztenciához.
Válaszok
Adatbázistulajdonságok (diktálások) AsyncItemPaged tulajdonsága.
Visszatérési típus
query_databases
Egy Cosmos DB SQL-adatbázisfiók adatbázisainak lekérdezése.
query_databases(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Paraméterek
Nem kötelező paramétertömb a lekérdezéshez. Minden paraméter egy "name" és "value" kulcsokkal rendelkező dict().
- max_item_count
- int
Az enumerálási műveletben visszaadandó elemek maximális száma.
- session_token
- str
Jogkivonat a munkamenet-konzisztenciához.
Válaszok
Adatbázistulajdonságok (diktálások) AsyncItemPaged tulajdonsága.
Visszatérési típus
Azure SDK for Python
Visszajelzés
https://aka.ms/ContentUserFeedback.
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ:Visszajelzés küldése és megtekintése a következőhöz: