CosmosClient Sınıf

Azure Cosmos DB hesabının istemci tarafı mantıksal gösterimi.

Azure Cosmos DB hizmetine yönelik istekleri yapılandırmak ve yürütmek için bu istemciyi kullanın.

Etkili bağlantı yönetimi ve performansı sağlayan uygulamanın kullanım ömrü başına tek bir CosmosClient örneğinin tutulması önerilir.

CosmosClient başlatması ağır bir işlemdir; kimlik bilgileri veya ağ bağlantısı doğrulamaları olarak CosmosClient örneklerini başlatmayı kullanmayın.

Yeni bir CosmosClient örneği oluşturma.

Devralma

builtins.object

CosmosClient

Oluşturucu

CosmosClient(url: str, credential: str | Dict[str, str] | TokenCredential, *, consistency_level: str | None = None, **kwargs: Any)

Parametreler

url

str

Gerekli

Cosmos DB hesabının URL'si.

credential

Union[str, Dict[str, str], AsyncTokenCredential]

Gerekli

Hesap anahtarı veya kaynak belirteçleri sözlüğü olabilir.

consistency_level

str

Oturum için kullanılacak tutarlılık düzeyi. Varsayılan değer Yok 'tur (hesap düzeyi). Tutarlılık düzeyleri ve olası değerler hakkında daha fazla bilgi: https://aka.ms/cosmos-consistency-levels

timeout

int

Birleştirilmiş HTTP isteği ve yanıt işleme için saniyeler içinde mutlak bir zaman aşımı.

connection_timeout

int

SANIYEler içinde HTTP isteği zaman aşımı.

connection_mode

str

İstemci için bağlantı modu - şu anda yalnızca 'Ağ Geçidi'ni destekler.

proxy_config

ProxyConfiguration

Bağlantı ara sunucusu yapılandırması.

ssl_config

SSLConfiguration

Bağlantı SSL yapılandırması.

connection_verify

bool

Bağlantının doğrulanıp doğrulanmayacağı, varsayılan değer True'dur.

connection_cert

str

Bağlantıyı doğrulamak için alternatif bir sertifika.

retry_total

int

En fazla yeniden deneme denemesi.

retry_backoff_max

int

En uzun yeniden deneme bekleme süresi (saniye cinsinden).

retry_fixed_interval

int

Milisaniye cinsinden yeniden deneme aralığı düzeltildi.

retry_read

int

Yuva okuma yeniden denemesi sayısı üst sınırı.

retry_connect

int

Bağlantı hatası yeniden deneme denemesi sayısı üst sınırı.

retry_status

int

Hata durum kodları üzerinde en fazla yeniden deneme denemesi sayısı.

retry_on_status_codes

list[int]

Yeniden denenecek belirli durum kodlarının listesi.

retry_backoff_factor

float

Yeniden deneme girişimleri arasındaki bekleme süresini hesaplamak için faktör.

enable_endpoint_discovery

bool

Coğrafi olarak çoğaltılan veritabanı hesapları için uç nokta bulmayı etkinleştirin. (Varsayılan: True)

preferred_locations

list[str]

Coğrafi olarak çoğaltılan veritabanı hesapları için tercih edilen konumlar.

enable_diagnostics_logging

bool

CosmosHttpLogging ilkesini etkinleştirin. Çalışmak için günlükçü ile birlikte kullanılmalıdır.

logger

Logger

İstek tanılamalarını toplamak için kullanılacak günlükçü. İstemci düzeyinde (tüm istekleri günlüğe kaydetmek için) veya tek bir istek düzeyinde geçirilebilir. İstekler BİlGİ düzeyinde günlüğe kaydedilir.

Örnekler

Cosmos DB istemcisinin yeni bir örneğini oluşturun:

       async with CosmosClient(url, key) as client:

Yöntemler

close	CosmosClient'ın bu örneğini kapatın.
create_database	Verilen kimlikle (ad) yeni bir veritabanı oluşturun.
create_database_if_not_exists	Henüz yoksa veritabanını oluşturun. Veritabanı zaten varsa, mevcut ayarlar döndürülür. .. not:: Bu işlev, geçirilenden farklıysa mevcut veritabanı ayarlarını denetlemez veya güncelleştirmez ya da aktarım hızı sunmaz.
delete_database	Verilen kimlikle (ad) veritabanını silin.
from_connection_string	Bir bağlantı dizesinden CosmosClient örneği oluşturun. Bu, Azure portal alınabilir. İsteğe bağlı anahtar sözcük bağımsız değişkenlerinin tam listesi için bkz. CosmosClient oluşturucu.
get_database_client	Kimlik (ad) kimliğine sahip mevcut bir veritabanını alın.
list_databases	Cosmos DB SQL veritabanı hesabındaki veritabanlarını listeleme.
query_databases	Cosmos DB SQL veritabanı hesabındaki veritabanlarını sorgular.

close

CosmosClient'ın bu örneğini kapatın.

async close() -> None

create_database

Verilen kimlikle (ad) yeni bir veritabanı oluşturun.

async create_database(id: str, **kwargs: Any) -> DatabaseProxy

Parametreler

id

str

Gerekli

Oluşturulacak veritabanının kimliği (adı).

offer_throughput

Union[int, ThroughputProperties]

Bu teklif için sağlanan aktarım hızı.

session_token

str

Oturum tutarlılığı ile kullanım için belirteç.

initial_headers

dict[str, str]

İsteğin bir parçası olarak gönderilecek ilk üst bilgiler.

etag

str

ETag değeri veya joker karakter (*). Kaynağın değişip değişmediğini denetlemek ve match_condition parametresi tarafından belirtilen koşula göre hareket etmek için kullanılır.

match_condition

MatchConditions

Etag'de kullanılacak eşleştirme koşulu.

response_hook

Callable[[Dict[str, str], Dict[str, Any]], None]

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Yeni veritabanını temsil eden bir DatabaseProxy örneği.

Dönüş türü

DatabaseProxy

Özel durumlar

CosmosResourceExistsError

Verilen kimlikli veritabanı zaten var.

Örnekler

Cosmos DB hesabında veritabanı oluşturun:

           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

Henüz yoksa veritabanını oluşturun.

Veritabanı zaten varsa, mevcut ayarlar döndürülür.

.. not:: Bu işlev, geçirilenden farklıysa mevcut veritabanı ayarlarını denetlemez veya güncelleştirmez ya da aktarım hızı sunmaz.

async create_database_if_not_exists(id: str, **kwargs: Any) -> DatabaseProxy

Parametreler

id

str

Gerekli

Okunacak veya oluşturulacak veritabanının kimliği (adı).

offer_throughput

Union[int, ThroughputProperties]

Bu teklif için sağlanan aktarım hızı.

session_token

str

Oturum tutarlılığı ile kullanım için belirteç.

initial_headers

dict[str, str]

İsteğin bir parçası olarak gönderilecek ilk üst bilgiler.

etag

str

ETag değeri veya joker karakter (*). Kaynağın değişip değişmediğini denetlemek ve match_condition parametresi tarafından belirtilen koşula göre hareket etmek için kullanılır.

match_condition

MatchConditions

Etag'de kullanılacak eşleştirme koşulu.

response_hook

Callable[[Dict[str, str], Dict[str, Any]], None]

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Veritabanını temsil eden databaseProxy örneği.

Dönüş türü

DatabaseProxy

Özel durumlar

CosmosHttpResponseError

Veritabanı okunamadı veya oluşturulamadı.

delete_database

Verilen kimlikle (ad) veritabanını silin.

async delete_database(database: str | DatabaseProxy | Dict[str, Any], **kwargs: Any) -> None

Parametreler

database

Union[str, DatabaseProxy, Dict[str, Any]]

Gerekli

Kimlik (ad), özellikleri temsil eden dikte veya DatabaseProxy silinecek veritabanının örneği.

session_token

str

Oturum tutarlılığı ile kullanım için belirteç.

initial_headers

dict[str, str]

İsteğin bir parçası olarak gönderilecek ilk üst bilgiler.

etag

str

ETag değeri veya joker karakter (*). Kaynağın değişip değişmediğini denetlemek ve match_condition parametresi tarafından belirtilen koşula göre hareket etmek için kullanılır.

match_condition

MatchConditions

Etag'de kullanılacak eşleştirme koşulu.

response_hook

Callable[[Dict[str, str]], None]

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Dönüş türü

None

Özel durumlar

CosmosHttpResponseError

Veritabanı silinemediyse.

from_connection_string

Bir bağlantı dizesinden CosmosClient örneği oluşturun.

Bu, Azure portal alınabilir. İsteğe bağlı anahtar sözcük bağımsız değişkenlerinin tam listesi için bkz. CosmosClient oluşturucu.

from_connection_string(conn_str: str, *, credential: str | Dict[str, str] | None = None, consistency_level: str | None = None, **kwargs: Any) -> CosmosClient

Parametreler

conn_str

str

Gerekli

Bağlantı dizesi.

credential

Union[str, Dict[str, str]]

Bağlantı dizesinde sağlanan anahtar yerine kullanılacak alternatif kimlik bilgileri.

consistency_level

str

Oturum için kullanılacak tutarlılık düzeyi. Varsayılan değer Yok 'tur (hesap düzeyi). Tutarlılık düzeyleri ve olası değerler hakkında daha fazla bilgi: https://aka.ms/cosmos-consistency-levels

Döndürülenler

CosmosClient örneği

Dönüş türü

CosmosClient

get_database_client

Kimlik (ad) kimliğine sahip mevcut bir veritabanını alın.

get_database_client(database: str | DatabaseProxy | Dict[str, Any]) -> DatabaseProxy

Parametreler

database

Union[str, DatabaseProxy, Dict[str, Any]]

Gerekli

Kimlik (ad), özellikleri temsil eden dikte veya DatabaseProxy alınacak veritabanının örneği.

Döndürülenler

Alınan veritabanını temsil eden bir DatabaseProxy örneği.

Dönüş türü

DatabaseProxy

list_databases

Cosmos DB SQL veritabanı hesabındaki veritabanlarını listeleme.

list_databases(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametreler

max_item_count

int

Numaralandırma işleminde döndürülecek en fazla öğe sayısı.

session_token

str

Oturum tutarlılığı ile kullanım için belirteç.

initial_headers

dict[str, str]

İsteğin bir parçası olarak gönderilecek ilk üst bilgiler.

response_hook

Callable[[Dict[str, str]], None]

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Veritabanı özelliklerinin (dikteler) AsyncItemPaged'i.

Dönüş türü

<xref:AsyncItemPaged>[Dict[str, str]]

query_databases

Cosmos DB SQL veritabanı hesabındaki veritabanlarını sorgular.

query_databases(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametreler

query

Union[str, Dict[str, Any]]

Yürütülecek Azure Cosmos DB SQL sorgusu.

parameters

List[Dict[str, Any]]

Sorguya isteğe bağlı parametre dizisi. Her parametre , 'name' ve 'value' anahtarları olan bir dict() değeridir.

max_item_count

int

Numaralandırma işleminde döndürülecek en fazla öğe sayısı.

session_token

str

Oturum tutarlılığı ile kullanım için belirteç.

initial_headers

dict[str, str]

İsteğin bir parçası olarak gönderilecek ilk üst bilgiler.

response_hook

Callable[[Dict[str, str]], None]

Yanıt meta verileriyle çağrılabilir bir çağrılabilir.

Döndürülenler

Veritabanı özelliklerinin (dikteler) AsyncItemPaged'i.

Dönüş türü

<xref:AsyncItemPaged>[Dict[str, str]]