ContainerProxy Osztály

Egy adott ADATBÁZIS-tárolóval való interakcióra szolgáló felület.

Ezt az osztályt nem szabad közvetlenül példányosítani. Ehelyett használja a metódust get_container_client egy meglévő tároló lekéréséhez, vagy egy create_container új tároló létrehozásához.

Az Azure Cosmos DB SQL API-adatbázisok tárolói dokumentumok gyűjteményei, amelyek mindegyike elemként jelenik meg.

Öröklődés

builtins.object

ContainerProxy

Konstruktor

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

Paraméterek

client_connection

database_link

id

properties

alapértelmezett érték: None

Változók

id

str

A tároló azonosítója (neve)

session_token

str

A tároló munkamenet-jogkivonata.

Metódusok

create_item	Hozzon létre egy elemet a tárolóban. Meglévő elem frissítéséhez vagy cseréjéhez használja a metódust upsert_item .
delete_all_items_by_partition_key	A partíciókulcsok szerinti törlés funkció egy aszinkron háttérművelet, amely lehetővé teszi az azonos logikai partíciókulcs-értékkel rendelkező összes dokumentum törlését a Cosmos SDK használatával. A partíciókulcs-törlési művelet arra van korlátozva, hogy a tárolón másodpercenként a teljes rendelkezésre álló RU/s legfeljebb 10%-át használja fel. Ez segít korlátozni a háttérfeladat által használt erőforrásokat.
delete_conflict	Adott ütközés törlése a tárolóból. Ha az ütközés még nem létezik a tárolóban, kivétel keletkezik.
delete_item	Törölje a megadott elemet a tárolóból. Ha az elem még nem létezik a tárolóban, kivétel keletkezik.
get_conflict	Kérje le az ütközés által azonosított ütközést.
get_throughput	Kérje le a tároló Átviteli sebességTulajdonságok objektumát. Ha a tárolóhoz még nincs Átviteli sebességTulajdonságok, kivétel keletkezik. :keyword Callable response_hook: A válasz metaadataival meghívott hívható. :returns: A tároló átviteli sebessége. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Nincs átviteli sebesség tulajdonság a tárolóhoz vagy az átviteli sebesség tulajdonságai nem kérhetők le.
list_conflicts	Sorolja fel a tároló összes ütközését.
patch_item	Ideiglenes módszer Kijavítja a megadott elemet a megadott műveletekkel, ha az megtalálható a tárolóban. Ha az elem még nem létezik a tárolóban, kivétel keletkezik.
query_conflicts	Adja vissza az adott lekérdezésnek megfelelő összes ütközést.
query_items	Az adott lekérdezésnek megfelelő összes eredményt adja vissza. A FROM záradékban bármilyen értéket használhat a tárolónévhez, de gyakran a tároló nevét is. Az alábbi példákban a tároló neve "products", és a WHERE záradékban való könnyebb hivatkozás érdekében "p" aliasnévvel van elnevezve. válaszfolytatási jogkivonat a lekérdezési válaszban. Az érvényes értékek pozitív egész számok. A 0 érték ugyanaz, mintha nem adná át az értéket (alapértelmezés szerint nincs korlát). :keyword int max_integrated_cache_staleness_in_ms: Az integrált gyorsítótár maximális gyorsítótár-elavultsága a következőben: Ezredmásodperc. Az integrált gyorsítótár használatára konfigurált fiókok esetében a munkamenet vagy a végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.
query_items_change_feed	A módosított elemek rendezett listájának lekérése a módosításuk sorrendjében.
read	Olvassa el a tároló tulajdonságait.
read_all_items	Sorolja fel a tárolóban lévő összes elemet.
read_item	Az elem által azonosított elem lekérése.
read_offer	Kérje le a tároló ThroughputProperties objektumát. Ha még nem létezik Átviteli sebességTulajdonságok a tárolóhoz, kivétel keletkezik. :keyword Callable response_hook: A válasz metaadataival meghívott meghívható. :returns: A tároló átviteli sebessége. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Nincs átviteli sebesség tulajdonság a tárolóhoz vagy az átviteli sebesség tulajdonságai nem kérhetők le.
replace_item	Lecseréli a megadott elemet, ha létezik a tárolóban. Ha az elem még nem létezik a tárolóban, kivétel keletkezik.
replace_throughput	Cserélje le a tároló átviteli sebességét. Ha még nem létezik Átviteli sebességTulajdonságok a tárolóhoz, kivétel keletkezik.
upsert_item	A megadott elem beszúrása vagy frissítése. Ha az elem már létezik a tárolóban, a rendszer lecseréli. Ha az elem még nem létezik, a program beszúrja.

create_item

Hozzon létre egy elemet a tárolóban.

Meglévő elem frissítéséhez vagy cseréjéhez használja a metódust 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]

Paraméterek

body

Kötelező

A létrehozandó elemet jelképező diktálásszerű objektum.

pre_trigger_include

Kötelező

a művelet előtti eseményindítóként használandó eseményindító azonosítója.

post_trigger_include

Kötelező

a művelet utáni eseményindítóként használandó eseményindító azonosítója.

indexing_directive

Kötelező

Azt jelzi, hogy a dokumentumot ki kell-e hagyni az indexelésből.

enable_automatic_id_generation

bool

Ha nincs azonosító, engedélyezze az automatikus azonosító-létrehozást.

session_token

str

Jogkivonat a munkamenet konzisztenciájával való használathoz.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

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 jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

response_hook

Callable

A válasz metaadataival hívható hívás.

Válaszok

Az új elemet jelképező diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

delete_all_items_by_partition_key

A partíciókulcsok szerinti törlés funkció egy aszinkron háttérművelet, amely lehetővé teszi az azonos logikai partíciókulcs-értékkel rendelkező összes dokumentum törlését a Cosmos SDK használatával. A partíciókulcs-törlési művelet arra van korlátozva, hogy a tárolón másodpercenként a teljes rendelkezésre álló RU/s legfeljebb 10%-át használja fel. Ez segít korlátozni a háttérfeladat által használt erőforrásokat.

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

Paraméterek

partition_key

Any

Kötelező

A törölni kívánt elemek partíciókulcsa.

pre_trigger_include

str

a művelet előtti eseményindítóként használandó eseményindító azonosítója.

post_trigger_include

str

a művelet utáni eseményindítóként használandó eseményindító azonosítója.

session_token

str

Jogkivonat a munkamenet konzisztenciájával való használathoz.

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 jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

response_hook

Callable

A válasz metaadataival hívható hívás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

delete_conflict

Adott ütközés törlése a tárolóból.

Ha az ütközés még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

conflict

Kötelező

A törölni kívánt ütközést jelző azonosító (név) vagy diktálás.

partition_key

Kötelező

A törölni kívánt ütközés partíciókulcsa.

response_hook

Callable

A válasz metaadataival hívható hívás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

Az ütközést nem sikerült törölni.

CosmosResourceNotFoundError

Az ütközés nem létezik a tárolóban.

delete_item

Törölje a megadott elemet a tárolóból.

Ha az elem még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

item

Kötelező

A törölni kívánt elemet jelképező azonosító (név) vagy diktálás.

partition_key

Kötelező

Megadja az elem partíciókulcs-értékét.

pre_trigger_include

Kötelező

a művelet előtti eseményindítóként használandó eseményindító azonosítója.

post_trigger_include

Kötelező

a művelet utáni eseményindítóként használandó eseményindító azonosítója.

session_token

str

Jogkivonat a munkamenet konzisztenciájával való használathoz.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

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 jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

response_hook

Callable

A válasz metaadataival hívható hívás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

Az elemet nem sikerült törölni.

CosmosResourceNotFoundError

Az elem nem létezik a tárolóban.

get_conflict

Kérje le az ütközés által azonosított ütközést.

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

Paraméterek

conflict

Kötelező

A beolvasni kívánt ütközést jelző azonosító (név) vagy diktálás.

partition_key

Kötelező

A beolvasandó ütközés partíciókulcsa.

response_hook

Callable

A válasz metaadataival hívható hívás.

Válaszok

A beolvasott ütközést jelképező diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

A megadott ütközést nem sikerült lekérni.

get_throughput

Kérje le a tároló Átviteli sebességTulajdonságok objektumát.

Ha a tárolóhoz még nincs Átviteli sebességTulajdonságok, kivétel keletkezik. :keyword Callable response_hook: A válasz metaadataival meghívott hívható. :returns: A tároló átviteli sebessége. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Nincs átviteli sebesség tulajdonság a tárolóhoz vagy

az átviteli sebesség tulajdonságai nem kérhetők le.

get_throughput(**kwargs: Any) -> ThroughputProperties

Visszatérési típus

ThroughputProperties

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

list_conflicts

Sorolja fel a tároló összes ütközését.

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

Paraméterek

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó elemek maximális száma.

response_hook

Callable

A válasz metaadataival hívható hívás.

Válaszok

Az ütközések iterálódása (diktálások).

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

patch_item

Ideiglenes módszer Kijavítja a megadott elemet a megadott műveletekkel, ha az megtalálható a tárolóban.

Ha az elem még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

item

Union[str, Dict[str, Any]]

Kötelező

A javítandó elemet jelképező azonosító (név) vagy diktálás.

partition_key

Union[str, int, float, bool]

Kötelező

A javítandó objektum partíciókulcsa.

patch_operations

List[Dict[str, Any]]

Kötelező

Az elemre alkalmazandó javítási műveletek listája.

filter_predicate

str

feltételes szűrőt, amely a Patch-műveletekre vonatkozik.

pre_trigger_include

str

a művelet előtti eseményindítóként használandó eseményindító azonosítója.

post_trigger_include

str

a művelet utáni eseményindítóként használandó eseményindító azonosítója.

session_token

str

Jogkivonat a munkamenet konzisztenciájával való használathoz.

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 jár-e el.

match_condition

MatchConditions

Az etagen használni kívánt egyeztetési feltétel.

response_hook

Callable

A válasz metaadataival hívható hívás.

Válaszok

Egy diktálás, amely az elemet jelöli a javítási műveletek elvégzése után.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

A javítási műveletek sikertelenek, vagy a megadott azonosítóval rendelkező elem nem létezik.

query_conflicts

Adja vissza az adott lekérdezésnek megfelelő összes ütközést.

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]]

Paraméterek

query

Kötelező

A végrehajtandó Azure Cosmos DB SQL-lekérdezés.

parameters

Kötelező

A lekérdezéshez választható paraméterek tömbje. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.

enable_cross_partition_query

Kötelező

Lehetővé teszi egynél több kérelem küldését a lekérdezés azure Cosmos DB szolgáltatásban való végrehajtásához. Több kérelemre van szükség, ha a lekérdezés nem egyetlen partíciókulcs-értékre van hatókörben.

partition_key

Kötelező

Megadja az elem partíciókulcs-értékét.

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó elemek maximális száma.

response_hook

Callable

A válasz metaadataival hívható hívás.

Válaszok

Az ütközések iterálódása (diktálások).

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

query_items

Az adott lekérdezésnek megfelelő összes eredményt adja vissza.

A FROM záradékban bármilyen értéket használhat a tárolónévhez, de gyakran a tároló nevét is. Az alábbi példákban a tároló neve "products", és a WHERE záradékban való könnyebb hivatkozás érdekében "p" aliasnévvel van elnevezve.

válaszfolytatási jogkivonat a lekérdezési válaszban. Az érvényes értékek pozitív egész számok. A 0 érték ugyanaz, mintha nem adná át az értéket (alapértelmezés szerint nincs korlát). :keyword int max_integrated_cache_staleness_in_ms: Az integrált gyorsítótár maximális gyorsítótár-elavultsága a következőben:

Ezredmásodperc. Az integrált gyorsítótár használatára konfigurált fiókok esetében a munkamenet vagy a végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.

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]]

Válaszok

Elemek (diktálások) iterable eleme.

Visszatérési típus

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

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

Példák

Szerezze be az összes olyan terméket, amely még nem lett megszüntetve:

   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))

Paraméteres lekérdezés az összes megszűnt termék lekéréséhez:

   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

A módosított elemek rendezett listájának lekérése a módosításuk sorrendjében.

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]]

Paraméterek

partition_key_range_id

Kötelező

A ChangeFeed-kérések adott partíciókulcs-tartományokon hajthatók végre. Ez a változáscsatorna párhuzamos feldolgozására szolgál több fogyasztó között.

partition_key

Kötelező

partíciókulcs, amelyen a ChangeFeed-kérések vannak megcélzva.

is_start_from_beginning

Kötelező

Megtudhatja, hogy a változáscsatorna az elejétől (igaz) vagy az aktuálistól (hamis) induljon-e. Alapértelmezés szerint az aktuálistól (hamis) indul.

continuation

Kötelező

e_tag változáscsatorna olvasásához használandó érték.

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó elemek maximális száma.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

Elemek (diktálások) iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

read

Olvassa el a tároló tulajdonságait.

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

Paraméterek

populate_partition_key_range_statistics

bool

Partíciókulcs-tartomány statisztikáinak visszaadása a válaszfejlécekben.

populate_quota_info

bool

Engedélyezze a gyűjtemény tárterületkvóta-információinak visszaadását a válaszfejlécekben.

session_token

str

Jogkivonat a munkamenet-konzisztenciához.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A lekért tárolót jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Fel van emelve, ha a tárolót nem sikerült lekérni. Ebbe beletartozik az is, ha a tároló nem létezik.

read_all_items

Sorolja fel a tárolóban lévő összes elemet.

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

Paraméterek

max_item_count

Kötelező

Az enumerálási műveletben visszaadandó elemek maximális száma.

session_token

str

Jogkivonat a munkamenet-konzisztenciához.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

response_hook

Callable

Meghívható a válasz metaadataival.

max_integrated_cache_staleness_in_ms

int

Az integrált gyorsítótár maximális gyorsítótár-állékonysága ezredmásodpercben. Az integrált gyorsítótár használatára konfigurált fiókok esetében a munkamenet vagy a végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.

Válaszok

Elemek (diktálások) iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

read_item

Az elem által azonosított elem lekérése.

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]

Paraméterek

item

Kötelező

A lekérni kívánt elemet jelölő azonosító (név) vagy diktálás.

partition_key

Kötelező

A lekérni kívánt elem partíciókulcsa.

post_trigger_include

Kötelező

eseményindító-azonosító, amelyet a művelet utáni eseményindítóként kell használni.

session_token

str

Jogkivonat a munkamenet-konzisztenciához.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

response_hook

Callable

Meghívható a válasz metaadataival.

max_integrated_cache_staleness_in_ms

int

Az integrált gyorsítótár maximális gyorsítótár-állékonysága ezredmásodpercben. Az integrált gyorsítótár használatára konfigurált fiókok esetében a munkamenet vagy a végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.

Válaszok

A lekérni kívánt elemet jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Nem sikerült beolvasni a megadott elemet.

Példák

Szerezzen be egy elemet az adatbázisból, és frissítse annak egyik tulajdonságát:

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

read_offer

Kérje le a tároló ThroughputProperties objektumát. Ha még nem létezik Átviteli sebességTulajdonságok a tárolóhoz, kivétel keletkezik. :keyword Callable response_hook: A válasz metaadataival meghívott meghívható. :returns: A tároló átviteli sebessége. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: Nincs átviteli sebesség tulajdonság a tárolóhoz vagy

az átviteli sebesség tulajdonságai nem kérhetők le.

read_offer(**kwargs: Any) -> Offer

Visszatérési típus

ThroughputProperties

Kivételek

CosmosHttpResponseError

A megadott azonosítójú elem már létezik.

replace_item

Lecseréli a megadott elemet, ha létezik a tárolóban.

Ha az elem még nem létezik a tárolóban, kivétel keletkezik.

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]

Paraméterek

item

Kötelező

A lecserélni kívánt elemet jelölő azonosító (név) vagy diktálás.

body

Kötelező

A lecserélni kívánt elemet jelképező diktátumszerű objektum.

pre_trigger_include

Kötelező

a művelet előtti eseményindítóként használandó eseményindító-azonosító.

post_trigger_include

Kötelező

eseményindító-azonosító, amelyet a művelet utáni eseményindítóként kell használni.

session_token

str

Jogkivonat a munkamenet-konzisztenciához.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

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.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A csere után az elemet jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

A csere sikertelen volt, vagy az elem adott azonosítóval nem létezik.

replace_throughput

Cserélje le a tároló átviteli sebességét.

Ha még nem létezik Átviteli sebességTulajdonságok a tárolóhoz, kivétel keletkezik.

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

Paraméterek

throughput

Kötelező

A beállítandó átviteli sebesség (egész szám).

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

Átviteli sebességTulajdonságok a tárolóhoz, új átviteli sebességgel frissítve.

Visszatérési típus

ThroughputProperties

Kivételek

CosmosHttpResponseError

A tárolóhoz nem léteznek átvitelisebesség-tulajdonságok, vagy az átviteli sebesség tulajdonságai nem frissíthetők.

upsert_item

A megadott elem beszúrása vagy frissítése.

Ha az elem már létezik a tárolóban, a rendszer lecseréli. Ha az elem még nem létezik, a program beszúrja.

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]

Paraméterek

body

Kötelező

A frissíteni vagy beszúrni kívánt elemet jelképező diktátumszerű objektum.

pre_trigger_include

Kötelező

a művelet előtti eseményindítóként használandó eseményindító-azonosító.

post_trigger_include

Kötelező

eseményindító-azonosító, amelyet a művelet utáni eseményindítóként kell használni.

session_token

str

Jogkivonat a munkamenet-konzisztenciához.

initial_headers

dict[str,str]

A kérés részeként elküldendő kezdeti fejlécek.

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.

response_hook

Callable

Meghívható a válasz metaadataival.

Válaszok

A beszúrt elemet jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

A megadott elemet nem sikerült beszúrni.

Attribútumok

is_system_key

scripts