ContainerProxy Klasa
Interfejs umożliwiający interakcję z określonym kontenerem bazy danych.
Ta klasa nie powinna być tworzone bezpośrednio. Zamiast tego użyj <xref:azure.cosmos.aio.database.DatabaseProxy.get_container_client> metody , aby uzyskać istniejący kontener lub <xref:azure.cosmos.aio.database.DatabaseProxy.create_container> metodę tworzenia nowego kontenera.
Kontener w bazie danych interfejsu API SQL usługi Azure Cosmos DB to kolekcja dokumentów, z których każda jest reprezentowana jako element.
- Dziedziczenie
-
builtins.objectContainerProxy
Konstruktor
ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)
Parametry
- client_connection
- database_link
- id
- properties
Zmienne
- id
- str
Identyfikator (nazwa) kontenera
- session_token
- str
Token sesji dla kontenera.
Metody
create_item |
Utwórz element w kontenerze. Aby zaktualizować lub zastąpić istniejący element, użyj upsert_item metody . |
delete_all_items_by_partition_key |
Funkcja usuwania według klucza partycji jest asynchroniczną operacją w tle, która umożliwia usunięcie wszystkich dokumentów z tą samą wartością klucza partycji logicznej przy użyciu zestawu Cosmos SDK. Operacja usuwania według klucza partycji jest ograniczona do korzystania z co najwyżej 10% całkowitej dostępnej liczby jednostek RU/s w kontenerze co sekundę. Pomaga to ograniczyć zasoby używane przez to zadanie w tle. |
delete_conflict |
Usuń określony konflikt z kontenera. Jeśli konflikt jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek. |
delete_item |
Usuń określony element z kontenera. Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek. |
get_conflict |
Pobierz konflikt zidentyfikowany przez konflikt. |
get_throughput |
Pobierz obiekt ThroughputProperties dla tego kontenera. Jeśli dla kontenera nie istnieje już żadna właściwość Przepływność, zostanie zgłoszony wyjątek. |
list_conflicts |
Wyświetl listę wszystkich konfliktów w kontenerze. |
patch_item |
Metoda tymczasowa Poprawia określony element przy użyciu podanych operacji, jeśli istnieje w kontenerze. Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek. |
query_conflicts |
Zwraca wszystkie konflikty pasujące do danego zapytania. |
query_items |
Zwróć wszystkie wyniki pasujące do danego zapytania. Możesz użyć dowolnej wartości nazwy kontenera w klauzuli FROM, ale często jest używana nazwa kontenera. W poniższych przykładach nazwa kontenera to "products" i jest aliasem "p", aby ułatwić odwoływanie się do klauzuli WHERE. token kontynuacji odpowiedzi odpowiedzi. Prawidłowe wartości to dodatnie liczby całkowite. Wartość 0 jest taka sama jak nie przekazująca wartości (wartość domyślna nie ma limitu). :słowo kluczowe int max_integrated_cache_staleness_in_ms: maksymalna nieaktualność pamięci podręcznej dla zintegrowanej pamięci podręcznej w Milisekund. W przypadku kont skonfigurowanych do używania zintegrowanej pamięci podręcznej przy użyciu spójności sesji lub ostatecznej odpowiedzi nie są nieaktualne niż ta wartość. |
query_items_change_feed |
Pobierz posortowaną listę elementów, które zostały zmienione, w kolejności, w której zostały zmodyfikowane. |
read |
Odczyt właściwości kontenera. |
read_all_items |
Wyświetl listę wszystkich elementów w kontenerze. |
read_item |
Pobierz element zidentyfikowany przez element. |
replace_item |
Zastępuje określony element, jeśli istnieje w kontenerze. Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek. |
replace_throughput |
Zastąp przepływność kontenera. Jeśli dla kontenera nie istnieją już właściwości przepływności, zostanie zgłoszony wyjątek. |
upsert_item |
Wstaw lub zaktualizuj określony element. Jeśli element już istnieje w kontenerze, zostanie zastąpiony. Jeśli element jeszcze nie istnieje, zostanie wstawiony. |
create_item
Utwórz element w kontenerze.
Aby zaktualizować lub zastąpić istniejący element, użyj upsert_item metody .
async create_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parametry
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- indexing_directive
- Union[int, IndexingDirective]
Wylicza możliwe wartości, aby wskazać, czy dokument powinien zostać pominięty z indeksowania. Możliwe wartości to: 0 dla wartości domyślnych, 1 dla wykluczenia lub 2 dla opcji Uwzględnij.
- enable_automatic_id_generation
- bool
Włącz automatyczne generowanie identyfikatorów, jeśli nie ma żadnego identyfikatora.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dykt reprezentujący nowy element.
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
delete_all_items_by_partition_key
Funkcja usuwania według klucza partycji jest asynchroniczną operacją w tle, która umożliwia usunięcie wszystkich dokumentów z tą samą wartością klucza partycji logicznej przy użyciu zestawu Cosmos SDK. Operacja usuwania według klucza partycji jest ograniczona do korzystania z co najwyżej 10% całkowitej dostępnej liczby jednostek RU/s w kontenerze co sekundę. Pomaga to ograniczyć zasoby używane przez to zadanie w tle.
async delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None
Parametry
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
- response_hook
- Callable
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
delete_conflict
Usuń określony konflikt z kontenera.
Jeśli konflikt jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
async delete_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
Parametry
Identyfikator (nazwa) lub dykt reprezentujący konflikt do pobrania.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Typ zwracany
Wyjątki
Konflikt nie został pomyślnie usunięty.
Konflikt nie istnieje w kontenerze.
delete_item
Usuń określony element z kontenera.
Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
async delete_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
Parametry
Identyfikator (nazwa) lub dykt reprezentujący element do usunięcia.
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Typ zwracany
Wyjątki
Element nie został pomyślnie usunięty.
Element nie istnieje w kontenerze.
get_conflict
Pobierz konflikt zidentyfikowany przez konflikt.
async get_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
Parametry
Identyfikator (nazwa) lub dykt reprezentujący konflikt do pobrania.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dykt reprezentujący pobrany konflikt.
Typ zwracany
Wyjątki
Nie można pobrać danego konfliktu.
get_throughput
Pobierz obiekt ThroughputProperties dla tego kontenera.
Jeśli dla kontenera nie istnieje już żadna właściwość Przepływność, zostanie zgłoszony wyjątek.
async get_throughput(**kwargs: Any) -> ThroughputProperties
Parametry
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
PrzepływnośćWłaściwości kontenera.
Typ zwracany
Wyjątki
Nie można pobrać właściwości przepływności dla kontenera lub nie można pobrać właściwości przepływności.
list_conflicts
Wyświetl listę wszystkich konfliktów w kontenerze.
list_conflicts(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parametry
- max_item_count
- int
Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
AsyncItemPaged konfliktów (dykt).
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
patch_item
Metoda tymczasowa Poprawia określony element przy użyciu podanych operacji, jeśli istnieje w kontenerze.
Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
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]
Parametry
Identyfikator (nazwa) lub dykt reprezentujący element do stosowania poprawek.
- filter_predicate
- str
filtr warunkowy, który ma być stosowany do operacji poprawek.
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
- response_hook
- Callable
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dykt reprezentujący element po wykonaniu operacji poprawek.
Typ zwracany
Wyjątki
Operacje poprawek nie powiodły się lub element o danym identyfikatorze nie istnieje.
query_conflicts
Zwraca wszystkie konflikty pasujące do danego zapytania.
query_conflicts(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parametry
Opcjonalna tablica parametrów zapytania. Ignorowane, jeśli nie podano kwerendy.
Określa wartość klucza partycji dla elementu. Jeśli żadne z nich nie zostanie przekazane, zostanie wykonane zapytanie obejmujące wiele partycji.
- max_item_count
- int
Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
AsyncItemPaged konfliktów (dykt).
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
query_items
Zwróć wszystkie wyniki pasujące do danego zapytania.
Możesz użyć dowolnej wartości nazwy kontenera w klauzuli FROM, ale często jest używana nazwa kontenera. W poniższych przykładach nazwa kontenera to "products" i jest aliasem "p", aby ułatwić odwoływanie się do klauzuli WHERE.
token kontynuacji odpowiedzi odpowiedzi. Prawidłowe wartości to dodatnie liczby całkowite. Wartość 0 jest taka sama jak nie przekazująca wartości (wartość domyślna nie ma limitu). :słowo kluczowe int max_integrated_cache_staleness_in_ms: maksymalna nieaktualność pamięci podręcznej dla zintegrowanej pamięci podręcznej w
Milisekund. W przypadku kont skonfigurowanych do używania zintegrowanej pamięci podręcznej przy użyciu spójności sesji lub ostatecznej odpowiedzi nie są nieaktualne niż ta wartość.
query_items(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Zwraca
AsyncItemPaged elementów (dykt).
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
Przykłady
Pobierz wszystkie produkty, które nie zostały wycofane:
import json
async for item in container.query_items(
query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"'
):
print(json.dumps(item, indent=True))
Sparametryzowane zapytanie umożliwiające pobranie wszystkich produktów, które zostały przerwane:
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
Pobierz posortowaną listę elementów, które zostały zmienione, w kolejności, w której zostały zmodyfikowane.
query_items_change_feed(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parametry
- is_start_from_beginning
- bool
Uzyskaj, czy kanał informacyjny zmian powinien zaczynać się od początku (true) lub od bieżącego (false). Domyślnie rozpoczyna się od bieżącego (fałsz).
- partition_key_range_id
- str
Żądania ChangeFeed można wykonywać względem określonych zakresów kluczy partycji. Jest to używane do przetwarzania zestawienia zmian równolegle między wieloma użytkownikami.
- continuation
- str
e_tag wartość, która ma być używana jako kontynuacja odczytu zestawienia zmian.
- max_item_count
- int
Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.
klucz partycji, w którym są kierowane żądania ChangeFeed.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
AsyncItemPaged elementów (dykt).
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
read
Odczyt właściwości kontenera.
async read(**kwargs: Any) -> Dict[str, Any]
Parametry
- populate_partition_key_range_statistics
- bool
Włącz zwracanie statystyk zakresu kluczy partycji w nagłówkach odpowiedzi.
- populate_quota_info
- bool
Włącz zwracanie informacji o limitach przydziału magazynu kolekcji w nagłówkach odpowiedzi.
- session_token
- str
Token do użycia z spójnością sesji.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dict reprezentujący pobrany kontener.
Typ zwracany
Wyjątki
Podniesione, jeśli nie można pobrać kontenera. Dotyczy to również tego, czy kontener nie istnieje.
read_all_items
Wyświetl listę wszystkich elementów w kontenerze.
read_all_items(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
Parametry
- max_item_count
- int
Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.
- session_token
- str
Token do użycia z spójnością sesji.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
- max_integrated_cache_staleness_in_ms
- int
Maksymalna nieaktualność pamięci podręcznej dla zintegrowanej pamięci podręcznej w milisekundach. W przypadku kont skonfigurowanych do używania zintegrowanej pamięci podręcznej przy użyciu spójności sesji lub ostatecznej odpowiedzi nie są nieaktualne niż ta wartość.
Zwraca
AsyncItemPaged elementów (dykt).
Typ zwracany
Wyjątki
Element o podanym identyfikatorze już istnieje.
read_item
Pobierz element zidentyfikowany przez element.
async read_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
Parametry
Identyfikator (nazwa) lub dykt reprezentujący element do pobrania.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
- max_integrated_cache_staleness_in_ms
- int
Maksymalna nieaktualność pamięci podręcznej dla zintegrowanej pamięci podręcznej w milisekundach. W przypadku kont skonfigurowanych do używania zintegrowanej pamięci podręcznej przy użyciu spójności sesji lub ostatecznej odpowiedzi nie są nieaktualne niż ta wartość.
Zwraca
Dict reprezentujący element do pobrania.
Typ zwracany
Wyjątki
Nie można pobrać danego elementu.
Przykłady
Pobierz element z bazy danych i zaktualizuj jedną z jego właściwości:
item = await container.read_item("item2", partition_key="Widget")
item["productModel"] = "DISCONTINUED"
updated_item = await container.upsert_item(item)
replace_item
Zastępuje określony element, jeśli istnieje w kontenerze.
Jeśli element jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
async replace_item(item: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parametry
Identyfikator (nazwa) lub dykt reprezentujący element do zastąpienia.
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dykt reprezentujący element po zastąpieniu przeszedł.
Typ zwracany
Wyjątki
Zamiana nie powiodła się lub element o podanym identyfikatorze nie istnieje.
replace_throughput
Zastąp przepływność kontenera.
Jeśli dla kontenera nie istnieją już właściwości przepływności, zostanie zgłoszony wyjątek.
async replace_throughput(throughput: int | ThroughputProperties, **kwargs: Any) -> ThroughputProperties
Parametry
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
PrzepływnośćWłaściwości kontenera, zaktualizowane o nową przepływność.
Typ zwracany
Wyjątki
Nie można zaktualizować właściwości przepływności dla kontenera lub nie można zaktualizować właściwości przepływności.
upsert_item
Wstaw lub zaktualizuj określony element.
Jeśli element już istnieje w kontenerze, zostanie zastąpiony. Jeśli element jeszcze nie istnieje, zostanie wstawiony.
async upsert_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parametry
Obiekt przypominający dykt reprezentujący element do zaktualizowania lub wstawienia.
- pre_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz operacji wstępnej.
- post_trigger_include
- str
identyfikator wyzwalacza, który ma być używany jako wyzwalacz po operacji.
- session_token
- str
Token do użycia z spójnością sesji.
- etag
- str
Wartość ETag lub symbol wieloznaczny (*). Służy do sprawdzania, czy zasób uległ zmianie i działa zgodnie z warunkiem określonym przez parametr match_condition .
- match_condition
- MatchConditions
Warunek dopasowania do użycia na etagu.
Wywołanie wywoływane przy użyciu metadanych odpowiedzi.
Zwraca
Dykt reprezentujący element upserted.
Typ zwracany
Wyjątki
Nie można przesłonić danego elementu.
Atrybuty
is_system_key
scripts
Azure SDK for Python