ContainerProxy Sınıf

Başvuru

Belirli bir VERITABANı Kapsayıcısı ile etkileşime geçmek için bir arabirim.

Bu sınıf doğrudan örneklenmemelidir. Bunun yerine, mevcut bir kapsayıcıyı almak için yöntemini veya create_container yeni bir kapsayıcı oluşturmak için yöntemini kullanınget_container_client.

Azure Cosmos DB SQL API veritabanındaki kapsayıcılar, her biri Öğe olarak temsil edilen bir belge koleksiyonudur.

Devralma: builtins.object

ContainerProxy

Oluşturucu

ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)

Parametreler

client_connection

database_link

id

properties

varsayılan değer: None

Değişkenler

id: str

Kapsayıcının kimliği (adı)

session_token: str

Kapsayıcının oturum belirteci.

Yöntemler

create_item	Kapsayıcıda bir öğe oluşturun. Varolan bir öğeyi güncelleştirmek veya değiştirmek için yöntemini kullanın upsert_item .
delete_all_items_by_partition_key	Bölüm anahtarına göre silme özelliği, Cosmos SDK'sını kullanarak aynı mantıksal bölüm anahtarı değerine sahip tüm belgeleri silmenizi sağlayan zaman uyumsuz, arka plan işlemidir. Bölüm anahtarına göre silme işlemi, kapsayıcıdaki toplam kullanılabilir RU/sn değerinin her saniye en fazla %10'unu kullanacak şekilde kısıtlanır. Bu, bu arka plan görevi tarafından kullanılan kaynakları sınırlamaya yardımcı olur.
delete_conflict	Belirtilen çakışmayı kapsayıcıdan silin. Çakışma kapsayıcıda zaten yoksa, bir özel durum oluşur.
delete_item	Belirtilen öğeyi kapsayıcıdan silin. Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.
get_conflict	Çakışma tarafından tanımlanan çakışmayı alın.
get_throughput	Bu kapsayıcı için ThroughputProperties nesnesini alın. Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur. :keyword Callable response_hook: Yanıt meta verileriyle çağrılabilir. :returns: Kapsayıcı için aktarım hızı. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Kapsayıcı için aktarım hızı özelliği yok veya aktarım hızı özellikleri alınamadı.
list_conflicts	Kapsayıcıdaki tüm çakışmaları listeleyin.
patch_item	Geçici yöntem Belirtilen öğe kapsayıcıda varsa sağlanan işlemlerle ilgili düzeltme eki uygular. Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.
query_conflicts	Belirli bir sorguyla eşleşen tüm çakışmaları döndürür.
query_items	Verilen sorguyla eşleşen tüm sonuçları döndürür. FROM yan tümcesinde kapsayıcı adı için herhangi bir değer kullanabilirsiniz, ancak genellikle kapsayıcı adı kullanılır. Aşağıdaki örneklerde kapsayıcı adı "products" şeklindedir ve WHERE yan tümcesinde daha kolay başvurmak için "p" olarak adlandırılır. sorgu yanıtında yanıt devamlılığı belirteci. Geçerli değerler pozitif tamsayılardır. 0 değeri, değer geçirmemeyle aynıdır (varsayılan sınır yoktur). :keyword int max_integrated_cache_staleness_in_ms: içindeki tümleşik önbellek için en yüksek önbellek eskime durumu Milisaniye. Oturum veya Son tutarlılık kullanılarak tümleşik önbelleği kullanacak şekilde yapılandırılmış hesaplarda yanıtların bu değerden daha eski olmadığı garanti edilir.
query_items_change_feed	Değiştirilen öğelerin, değiştirildikleri sırayla sıralanmış bir listesini alın.
read	Kapsayıcı özelliklerini okuyun.
read_all_items	Kapsayıcıdaki tüm öğeleri listeleyin.
read_item	Öğe tarafından tanımlanan öğeyi alır.
read_offer	Bu kapsayıcı için ThroughputProperties nesnesini alın. Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur. :keyword Callable response_hook: Yanıt meta verileriyle çağrılabilir. :returns: Kapsayıcı için aktarım hızı. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Kapsayıcı için aktarım hızı özelliği yok veya aktarım hızı özellikleri alınamadı.
replace_item	Kapsayıcıda varsa belirtilen öğeyi değiştirir. Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.
replace_throughput	Kapsayıcının aktarım hızını değiştirin. Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur.
upsert_item	Belirtilen öğeyi ekleyin veya güncelleştirin. Öğe kapsayıcıda zaten varsa değiştirilir. Öğe henüz yoksa eklenir.

create_item

Kapsayıcıda bir öğe oluşturun.

Varolan bir öğeyi güncelleştirmek veya değiştirmek için yöntemini kullanın upsert_item .

create_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, indexing_directive: Any | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

body

Gerekli

Oluşturulacak öğeyi temsil eden dikte benzeri bir nesne.

pre_trigger_include

Gerekli

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include

Gerekli

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliği.

indexing_directive

Gerekli

Belgenin dizin oluşturmadan atlanıp atlanmayacağını belirtin.

enable_automatic_id_generation: bool

Kimlik yoksa otomatik kimlik oluşturmayı etkinleştirin.

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

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

Döndürülenler

Yeni öğeyi temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

delete_all_items_by_partition_key

Bölüm anahtarına göre silme özelliği, Cosmos SDK'sını kullanarak aynı mantıksal bölüm anahtarı değerine sahip tüm belgeleri silmenizi sağlayan zaman uyumsuz, arka plan işlemidir. Bölüm anahtarına göre silme işlemi, kapsayıcıdaki toplam kullanılabilir RU/sn değerinin her saniye en fazla %10'unu kullanacak şekilde kısıtlanır. Bu, bu arka plan görevi tarafından kullanılan kaynakları sınırlamaya yardımcı olur.

delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None

Parametreler

partition_key: Any

Gerekli

Silinecek öğeler için bölüm anahtarı.

pre_trigger_include: str

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include: str

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliği.

session_token: str

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

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

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

Dönüş türü

None

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

delete_conflict

Belirtilen çakışmayı kapsayıcıdan silin.

Çakışma kapsayıcıda zaten yoksa, bir özel durum oluşur.

delete_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> None

Parametreler

conflict

Gerekli

Silinecek çakışmayı temsil eden kimlik (ad) veya dikte.

partition_key

Gerekli

Çakışmanın silineceği bölüm anahtarı.

response_hook: Callable

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

Dönüş türü

None

Özel durumlar

CosmosHttpResponseError

Çakışma başarıyla silinemedi.

CosmosResourceNotFoundError

Çakışma kapsayıcıda yok.

delete_item

Belirtilen öğeyi kapsayıcıdan silin.

Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.

delete_item(item: Dict[str, Any] | str, partition_key: Any, populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> None

Parametreler

item

Gerekli

Silinecek öğeyi temsil eden kimlik (ad) veya dikte.

partition_key

Gerekli

Öğenin bölüm anahtarı değerini belirtir.

pre_trigger_include

Gerekli

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include

Gerekli

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliğ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

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

Dönüş türü

None

Özel durumlar

CosmosHttpResponseError

Öğe başarıyla silinemedi.

CosmosResourceNotFoundError

Öğe kapsayıcıda yok.

get_conflict

Çakışma tarafından tanımlanan çakışmayı alın.

get_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> Dict[str, Any]

Parametreler

conflict

Gerekli

Alınacak çakışmayı temsil eden kimlik (ad) veya dikte.

partition_key

Gerekli

Çakışmanın alınması için bölüm anahtarı.

response_hook: Callable

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

Döndürülenler

Alınan çakışmayı temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen çakışma alınamadı.

get_throughput

Bu kapsayıcı için ThroughputProperties nesnesini alın.

Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur. :keyword Callable response_hook: Yanıt meta verileriyle çağrılabilir. :returns: Kapsayıcı için aktarım hızı. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Kapsayıcı için aktarım hızı özelliği yok veya

aktarım hızı özellikleri alınamadı.

get_throughput(**kwargs: Any) -> ThroughputProperties

Dönüş türü

ThroughputProperties

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

list_conflicts

Kapsayıcıdaki tüm çakışmaları listeleyin.

list_conflicts(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametreler

max_item_count

Gerekli

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

response_hook: Callable

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

Döndürülenler

Çakışmaların yinelenebilir bir örneği (dikte).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

patch_item

Geçici yöntem Belirtilen öğe kapsayıcıda varsa sağlanan işlemlerle ilgili düzeltme eki uygular.

Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.

patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]

Parametreler

item: Union[str, Dict[str, Any]]

Gerekli

Yama yapılacak öğeyi temsil eden kimlik (ad) veya dikte.

partition_key: Union[str, int, float, bool]

Gerekli

Düzeltme eki uygulamak için nesnenin bölüm anahtarı.

patch_operations: List[Dict[str, Any]]

Gerekli

Öğeye uygulanacak düzeltme eki işlemlerinin listesi.

filter_predicate: str

Patch işlemlerine uygulanacak koşullu filtre.

pre_trigger_include: str

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include: str

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliği.

session_token: str

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

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

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

Döndürülenler

Düzeltme eki işlemleri tamamlandıktan sonra öğeyi temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Düzeltme eki işlemleri başarısız oldu veya verilen kimlikli öğe yok.

query_conflicts

Belirli bir sorguyla eşleşen tüm çakışmaları döndürür.

query_conflicts(query: str, parameters: List[str] | None = None, enable_cross_partition_query: bool | None = None, partition_key: Any | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametreler

query

Gerekli

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

parameters

Gerekli

Sorguya isteğe bağlı parametre dizisi. Sorgu sağlanmazsa yoksayılır.

enable_cross_partition_query

Gerekli

Azure Cosmos DB hizmetinde sorguyu yürütmek için birden fazla istek gönderilmesine izin verir. Sorgunun kapsamı tek bölüm anahtarı değeri olarak belirtilmemişse birden fazla istek gereklidir.

partition_key

Gerekli

Öğenin bölüm anahtarı değerini belirtir.

max_item_count

Gerekli

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

response_hook: Callable

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

Döndürülenler

Çakışmaların yinelenebilir bir örneği (dikte).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

query_items

Verilen sorguyla eşleşen tüm sonuçları döndürür.

FROM yan tümcesinde kapsayıcı adı için herhangi bir değer kullanabilirsiniz, ancak genellikle kapsayıcı adı kullanılır. Aşağıdaki örneklerde kapsayıcı adı "products" şeklindedir ve WHERE yan tümcesinde daha kolay başvurmak için "p" olarak adlandırılır.

sorgu yanıtında yanıt devamlılığı belirteci. Geçerli değerler pozitif tamsayılardır. 0 değeri, değer geçirmemeyle aynıdır (varsayılan sınır yoktur). :keyword int max_integrated_cache_staleness_in_ms: içindeki tümleşik önbellek için en yüksek önbellek eskime durumu

Milisaniye. Oturum veya Son tutarlılık kullanılarak tümleşik önbelleği kullanacak şekilde yapılandırılmış hesaplarda yanıtların bu değerden daha eski olmadığı garanti edilir.

query_items(query: str, parameters: List[Dict[str, object]] | None = None, partition_key: Any | None = None, enable_cross_partition_query: bool | None = None, max_item_count: int | None = None, enable_scan_in_query: bool | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Döndürülenler

Öğelerin yinelenebilir bir öğesi (dikte).

Dönüş türü

<xref:ItemPaged>[Dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

Örnekler

Kullanımdan kaldırılmayan tüm ürünleri alın:


   import json

   for item in container.query_items(
       query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"',
       enable_cross_partition_query=True,
   ):
       print(json.dumps(item, indent=True))

Sonlandırılan tüm ürünleri almak için parametreli sorgu:


   discontinued_items = container.query_items(
       query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"',
       parameters=[dict(name="@model", value="DISCONTINUED")],
   )
   for item in discontinued_items:
       print(json.dumps(item, indent=True))

query_items_change_feed

Değiştirilen öğelerin, değiştirildikleri sırayla sıralanmış bir listesini alın.

query_items_change_feed(partition_key_range_id: str | None = None, is_start_from_beginning: bool = False, continuation: str | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametreler

partition_key_range_id

Gerekli

ChangeFeed istekleri belirli bölüm anahtarı aralıklarında yürütülebilir. Bu, değişiklik akışını birden çok tüketici arasında paralel olarak işlemek için kullanılır.

partition_key

Gerekli

ChangeFeed isteklerinin hedeflendiği bölüm anahtarı.

is_start_from_beginning

Gerekli

Değişiklik akışının başlangıçtan mı (true) yoksa geçerliden mi (yanlış) başlaması gerektiğini alın. Varsayılan olarak, geçerli (false) ile başlar.

continuation

Gerekli

Değişiklik akışını okumak için devamlılık olarak kullanılacak e_tag değer.

max_item_count

Gerekli

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

response_hook: Callable

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

Döndürülenler

Öğelerin yinelenebilir bir öğesi (dikte).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

read

Kapsayıcı özelliklerini okuyun.

read(*, populate_partition_key_range_statistics: bool | None = None, populate_quota_info: bool | None = None, **kwargs)

Parametreler

populate_partition_key_range_statistics: bool

Yanıt üst bilgilerinde bölüm anahtarı aralığı istatistiklerini döndürmeyi etkinleştirin.

populate_quota_info: bool

Yanıt üst bilgilerinde koleksiyon depolama kotası bilgilerini döndürmeyi etkinleştirin.

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

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

Döndürülenler

Alınan kapsayıcıyı temsil eden dikt.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Kapsayıcı alınamazsa oluşturulur. Kapsayıcının mevcut olmaması buna dahildir.

read_all_items

Kapsayıcıdaki tüm öğeleri listeleyin.

read_all_items(max_item_count: int | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parametreler

max_item_count

Gerekli

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

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

max_integrated_cache_staleness_in_ms: int

Milisaniye cinsinden tümleşik önbellek için en yüksek önbellek eskime durumu. Oturum veya Son tutarlılık kullanılarak tümleşik önbelleği kullanacak şekilde yapılandırılmış hesaplarda yanıtların bu değerden daha eski olmadığı garanti edilir.

Döndürülenler

Öğelerin yinelenebilir bir öğesi (dikte).

Dönüş türü

Iterable[dict[str, Any]]

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

read_item

Öğe tarafından tanımlanan öğeyi alır.

read_item(item: str | Dict[str, Any], partition_key: Any, populate_query_metrics: bool | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

item

Gerekli

Alınacak öğeyi temsil eden kimlik (ad) veya dikte.

partition_key

Gerekli

Alınacak öğenin bölüm anahtarı.

post_trigger_include

Gerekli

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliğ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.

response_hook: Callable

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

max_integrated_cache_staleness_in_ms: int

Döndürülenler

Alınacak öğeyi temsil eden dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen öğe alınamadı.

Örnekler

Veritabanından bir öğe alın ve özelliklerinden birini güncelleştirin:


   item = container.read_item("item2", partition_key="Widget")
   item["productModel"] = "DISCONTINUED"
   updated_item = container.upsert_item(item)

read_offer

Bu kapsayıcı için ThroughputProperties nesnesini alın. Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur. :keyword Callable response_hook: Yanıt meta verileriyle çağrılabilir. :returns: Kapsayıcı için aktarım hızı. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Kapsayıcı için aktarım hızı özelliği yok veya

aktarım hızı özellikleri alınamadı.

read_offer(**kwargs: Any) -> Offer

Dönüş türü

ThroughputProperties

Özel durumlar

CosmosHttpResponseError

Verilen kimlikli öğe zaten var.

replace_item

Kapsayıcıda varsa belirtilen öğeyi değiştirir.

Öğe kapsayıcıda zaten yoksa, bir özel durum oluşturulur.

replace_item(item: str | Dict[str, Any], body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

item

Gerekli

Değiştirilecek öğeyi temsil eden kimlik (ad) veya dikte.

body

Gerekli

Değiştirilebilecek öğeyi temsil eden dikte benzeri bir nesne.

pre_trigger_include

Gerekli

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include

Gerekli

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliğ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

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

Döndürülenler

Değiştirme işleminden sonra öğeyi temsil eden bir dikte oluştu.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Değiştirme başarısız oldu veya belirtilen kimlikle öğe yok.

replace_throughput

Kapsayıcının aktarım hızını değiştirin.

Kapsayıcı için zaten bir ThroughputProperties yoksa, bir özel durum oluşur.

replace_throughput(throughput: int | ThroughputProperties | None, **kwargs: Any) -> ThroughputProperties

Parametreler

throughput

Gerekli

Ayarlanacak aktarım hızı (tamsayı).

response_hook: Callable

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

Döndürülenler

Kapsayıcı için ThroughputProperties, yeni aktarım hızıyla güncelleştirildi.

Dönüş türü

ThroughputProperties

Özel durumlar

CosmosHttpResponseError

Kapsayıcı için aktarım hızı özelliği yok veya aktarım hızı özellikleri güncelleştirilemedi.

upsert_item

Belirtilen öğeyi ekleyin veya güncelleştirin.

Öğe kapsayıcıda zaten varsa değiştirilir. Öğe henüz yoksa eklenir.

upsert_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parametreler

body

Gerekli

Güncelleştirilecek veya eklenecek öğeyi temsil eden dikte benzeri bir nesne.

pre_trigger_include

Gerekli

ön işlem tetikleyicisi olarak kullanılacak tetikleyici kimliği.

post_trigger_include

Gerekli

işlem sonrası tetikleyicisi olarak kullanılacak tetikleyici kimliğ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

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

Döndürülenler

Yukarı atanan öğeyi temsil eden bir dikte.

Dönüş türü

dict[str, Any]

Özel durumlar

CosmosHttpResponseError

Verilen öğe yukarı eklenemedi.