ContainerProxy Osztály
Egy adott DB-tárolóval való interakcióra használható felület.
Ezt az osztályt nem szabad közvetlenül példányosítani. Ehelyett használja a <xref:azure.cosmos.aio.database.DatabaseProxy.get_container_client> metódust egy meglévő tároló lekéréséhez, vagy a <xref:azure.cosmos.aio.database.DatabaseProxy.create_container> metódussal hozzon létre egy új tárolót.
Az Azure Cosmos DB SQL API-adatbázisban található tárolók dokumentumok gyűjteményei, amelyek mindegyike elemként jelenik meg.
- Öröklődés
-
builtins.objectContainerProxy
Konstruktor
ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)
Paraméterek
- client_connection
- database_link
- id
- properties
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ókulcs-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 másodpercenként a tárolón elérhető összes 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ó ThroughputProperties objektumát. Ha a tárolóhoz még nem létezik Átviteli sebességTulajdonságok, kivétel keletkezik. |
list_conflicts |
Sorolja fel a tárolóban lévő összes ütközést. |
patch_item |
Ideiglenes módszer Kijavítja a megadott elemet a megadott műveletekkel, ha az létezik a tárolóban. Ha az elem még nem létezik a tárolóban, kivétel keletkezik. |
query_conflicts |
Visszaadja 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 használja. Az alábbi példákban a tároló neve "termékek", és a WHERE záradékban való könnyebb hivatkozás érdekében "p" néven 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 megegyezik azzal, hogy nem ad át egy é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-állékonysá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 az 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ás sorrendjében. |
read |
Olvassa el a tároló tulajdonságait. |
read_all_items |
Sorolja fel a tároló összes elemét. |
read_item |
Az elem által azonosított elem lekérése. |
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 a tárolóhoz még nincs Átviteli sebességTulajdonságok, 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, akkor 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 .
async create_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Paraméterek
- pre_trigger_include
- str
a művelet előtti eseményindítóként használandó eseményindító-azonosító.
- post_trigger_include
- str
eseményindító-azonosító, amelyet a művelet utáni eseményindítóként kell használni.
- indexing_directive
- Union[int, IndexingDirective]
A lehetséges értékek számbavétele annak jelzésére, hogy a dokumentumot ki kell-e hagyni az indexelésből. Lehetséges értékek: 0 az Alapértelmezett, 1 a Kizárás, 2 a Belefoglalás.
- 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á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 elemet jelölő diktálás.
Visszatérési típus
Kivételek
A megadott azonosítójú elem már létezik.
delete_all_items_by_partition_key
A partíciókulcs-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 másodpercenként a tárolón elérhető összes RU/s legfeljebb 10%-át használja fel. Ez segít korlátozni a háttérfeladat által használt erőforrásokat.
async delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None
Paraméterek
- pre_trigger_include
- str
a művelet előtti eseményindítóként használandó eseményindító-azonosító.
- post_trigger_include
- str
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.
- 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.
Visszatérési típus
Kivételek
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.
async delete_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
Paraméterek
A beolvasandó ütközést jelölő azonosító (név) vagy diktálás.
Visszatérési típus
Kivételek
Az ütközés nem lett sikeresen törölve.
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.
async delete_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
Paraméterek
A törölni kívánt elemet jelölő azonosító (név) vagy diktálás.
- pre_trigger_include
- str
a művelet előtti eseményindítóként használandó eseményindító-azonosító.
- post_trigger_include
- str
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.
- 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
Az elem törlése nem sikerült.
Az elem nem létezik a tárolóban.
get_conflict
Kérje le az ütközés által azonosított ütközést.
async get_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
Paraméterek
A beolvasandó ütközést jelölő azonosító (név) vagy diktálás.
Válaszok
A beolvasott ütközést jelölő diktálás.
Visszatérési típus
Kivételek
A megadott ütközést nem sikerült lekérni.
get_throughput
Kérje le a tároló ThroughputProperties objektumát.
Ha a tárolóhoz még nem létezik Átviteli sebességTulajdonságok, kivétel keletkezik.
async get_throughput(**kwargs: Any) -> ThroughputProperties
Paraméterek
Meghívható a válasz metaadataival.
Válaszok
Átviteli sebességTulajdonságok a tárolóhoz.
Visszatérési típus
Kivételek
A tárolóhoz nem léteznek átvitelisebesség-tulajdonságok, vagy az átviteli sebesség tulajdonságai nem kérhetők le.
list_conflicts
Sorolja fel a tárolóban lévő összes ütközést.
list_conflicts(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Paraméterek
- max_item_count
- int
Az enumerálási műveletben visszaadandó elemek maximális száma.
Meghívható a válasz metaadataival.
Válaszok
Ütközések (diktálások) AsyncItemPaged eleme.
Visszatérési típus
Kivételek
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 létezik a tárolóban.
Ha az elem még nem létezik a tárolóban, kivétel keletkezik.
async 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
- filter_predicate
- str
feltételes szűrő, amely a Javítási műveletekre vonatkozik.
- pre_trigger_include
- str
a művelet előtti eseményindítóként használandó eseményindító-azonosító.
- post_trigger_include
- str
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.
- 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
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
Kivételek
A javítási műveletek sikertelenek, vagy a megadott azonosítójú elem nem létezik.
query_conflicts
Visszaadja az adott lekérdezésnek megfelelő összes ütközést.
query_conflicts(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Paraméterek
Nem kötelező paramétertömb a lekérdezéshez. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.
Megadja az elem partíciókulcs-értékét. Ha egyik sincs átadva, a rendszer egy partíciók közötti lekérdezést hajt végre.
- max_item_count
- int
Az enumerálási műveletben visszaadandó elemek maximális száma.
Meghívható a válasz metaadataival.
Válaszok
Ütközések (diktálások) AsyncItemPaged eleme.
Visszatérési típus
Kivételek
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 használja. Az alábbi példákban a tároló neve "termékek", és a WHERE záradékban való könnyebb hivatkozás érdekében "p" néven 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 megegyezik azzal, hogy nem ad át egy é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-állékonysá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 az végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.
query_items(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Válaszok
Elemek (diktálások) AsyncItemPaged eleme.
Visszatérési típus
Kivételek
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
async for item in container.query_items(
query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"'
):
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")],
)
async 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ás sorrendjében.
query_items_change_feed(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Paraméterek
- is_start_from_beginning
- bool
Megtudhatja, hogy a változáscsatornának az elejétől (igaz) vagy az aktuálistól (hamis) kell-e kezdődnie. Alapértelmezés szerint az aktuálistól (hamis) indul.
- partition_key_range_id
- str
A ChangeFeed-kérések adott partíciókulcs-tartományokon végrehajthatók. Ez a változáscsatorna több fogyasztó közötti párhuzamos feldolgozására szolgál.
- continuation
- str
e_tag változáscsatorna olvasásához használandó érték.
- max_item_count
- int
Az enumerálási műveletben visszaadandó elemek maximális száma.
partíciókulcs, amelyen a ChangeFeed-kérések meg vannak célozva.
A válasz metaadataival hívható hívás.
Válaszok
Elemek AsyncItemPagedje (diktálások).
Visszatérési típus
Kivételek
A megadott azonosítójú elem már létezik.
read
Olvassa el a tároló tulajdonságait.
async read(**kwargs: Any) -> Dict[str, Any]
Paraméterek
- populate_partition_key_range_statistics
- bool
Engedélyezze a partíciókulcs-tartomány statisztikáinak visszaadását a válaszfejlécekben.
- populate_quota_info
- bool
Engedélyezze a gyűjtemény tárkvótaadatainak visszaadását a válaszfejlécekben.
- session_token
- str
Jogkivonat a munkamenet konzisztenciájával való használathoz.
A válasz metaadataival hívható hívás.
Válaszok
A lekért tárolót jelképező diktálás.
Visszatérési típus
Kivételek
Fel van emelve, ha a tárolót nem sikerült lekérni. Ez magában foglalja, ha a tároló nem létezik.
read_all_items
Sorolja fel a tároló összes elemét.
read_all_items(**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ájával való használathoz.
A válasz metaadataival hívható hívás.
- 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 az végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.
Válaszok
Elemek AsyncItemPagedje (diktálások).
Visszatérési típus
Kivételek
A megadott azonosítójú elem már létezik.
read_item
Az elem által azonosított elem lekérése.
async read_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
Paraméterek
A lekérni kívánt elemet képviselő azonosító (név) vagy diktálás.
- 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.
A válasz metaadataival hívható hívás.
- 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 az végleges konzisztencia használatával a válaszok garantáltan nem lesznek elavultak ennél az értéknél.
Válaszok
A lekérendő elemet jelképező diktálás.
Visszatérési típus
Kivételek
A megadott elemet nem sikerült lekérni.
Példák
Egy elem lekérése az adatbázisból, és annak egyik tulajdonságának frissítése:
item = await container.read_item("item2", partition_key="Widget")
item["productModel"] = "DISCONTINUED"
updated_item = await container.upsert_item(item)
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.
async replace_item(item: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Paraméterek
A lecserélni kívánt elemet jelképező azonosító (név) vagy diktálás.
- 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.
A válasz metaadataival hívható hívás.
Válaszok
A csere után az elemet jelképező diktálás ment keresztül.
Visszatérési típus
Kivételek
A csere sikertelen volt, vagy a megadott azonosítójú elem nem létezik.
replace_throughput
Cserélje le a tároló átviteli sebességét.
Ha a tárolóhoz még nincs Átviteli sebességTulajdonságok, kivétel keletkezik.
async replace_throughput(throughput: int | ThroughputProperties, **kwargs: Any) -> ThroughputProperties
Paraméterek
A válasz metaadataival hívható hívás.
Válaszok
Átviteli sebességTulajdonságok a tárolóhoz, új átviteli sebességgel frissítve.
Visszatérési típus
Kivételek
A tárolóhoz nincs átviteli sebességtulajdonság, 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, akkor a program beszúrja.
async upsert_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Paraméterek
A frissíteni vagy beszúrni kívánt elemet jelképező diktálásszerű objektum.
- 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.
A válasz metaadataival hívható hívás.
Válaszok
A beszúrt elemet jelképező diktálás.
Visszatérési típus
Kivételek
A megadott elem nem állítható be.
Attribútumok
is_system_key
scripts
Azure SDK for Python