ContainerProxy Klas

Een interface voor interactie met een specifieke DB-container.

Deze klasse mag niet rechtstreeks worden geïnstantieerd. Gebruik in plaats daarvan de get_container_client methode om een bestaande container op te halen of de create_container methode om een nieuwe container te maken.

Een container in een SQL API-database van Azure Cosmos DB is een verzameling documenten, die elk worden weergegeven als een item.

Overname

builtins.object

ContainerProxy

Constructor

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

Parameters

client_connection

database_link

id

properties

standaardwaarde: None

Variabelen

id

str

Id (naam) van de container

session_token

str

Het sessietoken voor de container.

Methoden

create_item	Maak een item in de container. Gebruik de upsert_item methode om een bestaand item bij te werken of te vervangen.
delete_all_items_by_partition_key	De functie verwijderen op partitiesleutel is een asynchrone bewerking op de achtergrond waarmee u alle documenten met dezelfde logische partitiesleutelwaarde kunt verwijderen met behulp van de Cosmos SDK. De bewerking verwijderen via partitiesleutel is beperkt tot het verbruik van maximaal 10% van de totale beschikbare RU/s op de container elke seconde. Dit helpt bij het beperken van de resources die door deze achtergrondtaak worden gebruikt.
delete_conflict	Verwijder een opgegeven conflict uit de container. Als het conflict nog niet in de container bestaat, wordt er een uitzondering gegenereerd.
delete_item	Verwijder het opgegeven item uit de container. Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.
get_conflict	Haal het conflict op dat is geïdentificeerd door conflict.
get_throughput	Haal het object ThroughputProperties voor deze container op. Als er al geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd. :keyword Callable response_hook: een aanroepbare die wordt aangeroepen met de antwoordmetagegevens. :retourneert: Doorvoer voor de container. :genereert ~azure.cosmos.exceptions.CosmosHttpResponseError: er bestaan geen doorvoereigenschappen voor de container of de doorvoereigenschappen kunnen niet worden opgehaald.
list_conflicts	Alle conflicten in de container weergeven.
patch_item	Voorlopige methode Hiermee wordt het opgegeven item bijgewerkt met de opgegeven bewerkingen als dit in de container bestaat. Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.
query_conflicts	Alle conflicten retourneren die overeenkomen met een bepaalde query.
query_items	Retourneer alle resultaten die overeenkomen met de opgegeven query. U kunt elke waarde gebruiken voor de containernaam in de FROM-component, maar vaak wordt de containernaam gebruikt. In de onderstaande voorbeelden is de containernaam 'products' en is de alias 'p' voor eenvoudigere verwijzingen in de WHERE-component. antwoordvolgtoken in het queryantwoord. Geldige waarden zijn positieve gehele getallen. Een waarde van 0 is hetzelfde als het niet doorgeven van een waarde (standaard geen limiet). :keyword int max_integrated_cache_staleness_in_ms: Het maximale cachegeheugen voor de geïntegreerde cache in Milliseconden. Voor accounts die zijn geconfigureerd voor het gebruik van de geïntegreerde cache, met behulp van sessie- of uiteindelijkconsistentie, worden antwoorden gegarandeerd niet verlopen dan deze waarde.
query_items_change_feed	Een gesorteerde lijst met items ophalen die zijn gewijzigd, in de volgorde waarin ze zijn gewijzigd.
read	Lees de containereigenschappen.
read_all_items	Alle items in de container weergeven.
read_item	Haal het item op dat wordt geïdentificeerd door het item.
read_offer	Haal het object ThroughputProperties voor deze container op. Als er nog geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd. :keyword Callable response_hook: een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord. :retourneert: Doorvoer voor de container. :genereert ~azure.cosmos.exceptions.CosmosHttpResponseError: er bestaan geen doorvoereigenschappen voor de container of de doorvoereigenschappen kunnen niet worden opgehaald.
replace_item	Vervangt het opgegeven item als het in de container bestaat. Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.
replace_throughput	Vervang de doorvoer van de container. Als er nog geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd.
upsert_item	Het opgegeven item invoegen of bijwerken. Als het item al in de container bestaat, wordt het vervangen. Als het item nog niet bestaat, wordt het ingevoegd.

create_item

Maak een item in de container.

Gebruik de upsert_item methode om een bestaand item bij te werken of te vervangen.

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]

Parameters

body

Vereist

Een dict-achtig object dat het item vertegenwoordigt dat moet worden gemaakt.

pre_trigger_include

Vereist

trigger-id die moet worden gebruikt als prebewerkingtrigger.

post_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger na de bewerking.

indexing_directive

Vereist

Geef aan of het document moet worden weggelaten voor indexering.

enable_automatic_id_generation

bool

Schakel het automatisch genereren van id's in als er geen id aanwezig is.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retouren

Een dict die het nieuwe item vertegenwoordigt.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

delete_all_items_by_partition_key

De functie verwijderen op partitiesleutel is een asynchrone bewerking op de achtergrond waarmee u alle documenten met dezelfde logische partitiesleutelwaarde kunt verwijderen met behulp van de Cosmos SDK. De bewerking verwijderen via partitiesleutel is beperkt tot het verbruik van maximaal 10% van de totale beschikbare RU/s op de container elke seconde. Dit helpt bij het beperken van de resources die door deze achtergrondtaak worden gebruikt.

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

Parameters

partition_key

Any

Vereist

Partitiesleutel voor de items die moeten worden verwijderd.

pre_trigger_include

str

trigger-id die moet worden gebruikt als prebewerkingtrigger.

post_trigger_include

str

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retourtype

None

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

delete_conflict

Verwijder een opgegeven conflict uit de container.

Als het conflict nog niet in de container bestaat, wordt er een uitzondering gegenereerd.

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

Parameters

conflict

Vereist

De id (naam) of het dict die het conflict vertegenwoordigt dat moet worden verwijderd.

partition_key

Vereist

Partitiesleutel voor het conflict dat moet worden verwijderd.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retourtype

None

Uitzonderingen

CosmosHttpResponseError

Het conflict is niet verwijderd.

CosmosResourceNotFoundError

Het conflict bestaat niet in de container.

delete_item

Verwijder het opgegeven item uit de container.

Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.

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

Parameters

item

Vereist

De id (naam) of het dict die het item vertegenwoordigt dat moet worden verwijderd.

partition_key

Vereist

Hiermee geeft u de partitiesleutelwaarde voor het item op.

pre_trigger_include

Vereist

trigger-id die moet worden gebruikt als prebewerkingtrigger.

post_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retourtype

None

Uitzonderingen

CosmosHttpResponseError

Het item is niet verwijderd.

CosmosResourceNotFoundError

Het item bestaat niet in de container.

get_conflict

Haal het conflict op dat is geïdentificeerd door conflict.

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

Parameters

conflict

Vereist

De id (naam) of het dict die het conflict vertegenwoordigt dat moet worden opgehaald.

partition_key

Vereist

Partitiesleutel om het conflict op te halen.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retouren

Een dict die het opgehaalde conflict vertegenwoordigt.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

Het opgegeven conflict kan niet worden opgehaald.

get_throughput

Haal het object ThroughputProperties voor deze container op.

Als er al geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd. :keyword Callable response_hook: een aanroepbare die wordt aangeroepen met de antwoordmetagegevens. :retourneert: Doorvoer voor de container. :genereert ~azure.cosmos.exceptions.CosmosHttpResponseError: er bestaan geen doorvoereigenschappen voor de container of

de doorvoereigenschappen kunnen niet worden opgehaald.

get_throughput(**kwargs: Any) -> ThroughputProperties

Retourtype

ThroughputProperties

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

list_conflicts

Alle conflicten in de container weergeven.

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

Parameters

max_item_count

Vereist

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retouren

Een iterable van conflicten (dicteren).

Retourtype

Iterable[dict[str, Any]]

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

patch_item

Voorlopige methode Hiermee wordt het opgegeven item bijgewerkt met de opgegeven bewerkingen als dit in de container bestaat.

Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.

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

Parameters

item

Union[str, Dict[str, Any]]

Vereist

De id (naam) of het dict die het item vertegenwoordigt dat moet worden gepatcht.

partition_key

Union[str, int, float, bool]

Vereist

De partitiesleutel van het object dat moet worden gepatcht.

patch_operations

List[Dict[str, Any]]

Vereist

De lijst met patchbewerkingen die moeten worden toegepast op het item.

filter_predicate

str

voorwaardelijk filter om toe te passen op patchbewerkingen.

pre_trigger_include

str

trigger-id die moet worden gebruikt als prebewerkingtrigger.

post_trigger_include

str

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retouren

Een dict die het item vertegenwoordigt nadat de patchbewerkingen zijn uitgevoerd.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

De patchbewerkingen zijn mislukt of het item met de opgegeven id bestaat niet.

query_conflicts

Alle conflicten retourneren die overeenkomen met een bepaalde query.

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

Parameters

query

Vereist

De Azure Cosmos DB SQL-query die moet worden uitgevoerd.

parameters

Vereist

Optionele matrix met parameters voor de query. Genegeerd als er geen query wordt opgegeven.

enable_cross_partition_query

Vereist

Hiermee kunt u meer dan één aanvraag verzenden om de query uit te voeren in de Azure Cosmos DB-service. Er is meer dan één aanvraag nodig als de query niet is gericht op één partitiesleutelwaarde.

partition_key

Vereist

Hiermee geeft u de partitiesleutelwaarde voor het item op.

max_item_count

Vereist

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking.

response_hook

Callable

Een aanroepbare aangeroepen met de antwoordmetagegevens.

Retouren

Een iterable van conflicten (dicteren).

Retourtype

Iterable[dict[str, Any]]

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

query_items

Retourneer alle resultaten die overeenkomen met de opgegeven query.

U kunt elke waarde gebruiken voor de containernaam in de FROM-component, maar vaak wordt de containernaam gebruikt. In de onderstaande voorbeelden is de containernaam 'products' en is de alias 'p' voor eenvoudigere verwijzingen in de WHERE-component.

antwoordvolgtoken in het queryantwoord. Geldige waarden zijn positieve gehele getallen. Een waarde van 0 is hetzelfde als het niet doorgeven van een waarde (standaard geen limiet). :keyword int max_integrated_cache_staleness_in_ms: Het maximale cachegeheugen voor de geïntegreerde cache in

Milliseconden. Voor accounts die zijn geconfigureerd voor het gebruik van de geïntegreerde cache, met behulp van sessie- of uiteindelijkconsistentie, worden antwoorden gegarandeerd niet verlopen dan deze waarde.

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

Retouren

Een iterable van items (dicteren).

Retourtype

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

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

Voorbeelden

Download alle producten die niet zijn stopgezet:

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

Query met parameters om alle producten op te halen die zijn stopgezet:

   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

Een gesorteerde lijst met items ophalen die zijn gewijzigd, in de volgorde waarin ze zijn gewijzigd.

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

Parameters

partition_key_range_id

Vereist

ChangeFeed-aanvragen kunnen worden uitgevoerd op basis van specifieke partitiesleutelbereiken. Dit wordt gebruikt om de wijzigingenfeed parallel te verwerken voor meerdere consumenten.

partition_key

Vereist

partitiesleutel waarop ChangeFeed-aanvragen zijn gericht.

is_start_from_beginning

Vereist

Bepalen of de wijzigingenfeed moet beginnen vanaf het begin (waar) of vanaf huidige (onwaar). De standaardinstelling is dat deze begint met de huidige waarde (onwaar).

continuation

Vereist

e_tag waarde die moet worden gebruikt als vervolg voor het lezen van wijzigingenfeed.

max_item_count

Vereist

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

Retouren

Een iterable van items (dicteren).

Retourtype

Iterable[dict[str, Any]]

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

read

Lees de containereigenschappen.

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

Parameters

populate_partition_key_range_statistics

bool

Schakel het retourneren van statistieken over partitiesleutelbereiken in antwoordheaders in.

populate_quota_info

bool

Schakel het retourneren van opslagquotagegevens voor verzamelingen in antwoordheaders in.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

Retouren

Dict die de opgehaalde container vertegenwoordigt.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

Gegenereerd als de container niet kan worden opgehaald. Dit geldt ook als de container niet bestaat.

read_all_items

Alle items in de container weergeven.

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

Parameters

max_item_count

Vereist

Maximum aantal items dat moet worden geretourneerd in de opsommingsbewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

max_integrated_cache_staleness_in_ms

int

Het maximale cachegeheugen voor de geïntegreerde cache in milliseconden. Voor accounts die zijn geconfigureerd voor het gebruik van de geïntegreerde cache, met behulp van sessie- of uiteindelijkconsistentie, worden antwoorden gegarandeerd niet verlopen dan deze waarde.

Retouren

Een iterable van items (dicteren).

Retourtype

Iterable[dict[str, Any]]

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

read_item

Haal het item op dat wordt geïdentificeerd door het item.

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]

Parameters

item

Vereist

De id (naam) of de dict die het item vertegenwoordigt dat moet worden opgehaald.

partition_key

Vereist

Partitiesleutel voor het item dat moet worden opgehaald.

post_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

max_integrated_cache_staleness_in_ms

int

Het maximale cachegeheugen voor de geïntegreerde cache in milliseconden. Voor accounts die zijn geconfigureerd voor het gebruik van de geïntegreerde cache, met behulp van sessie- of uiteindelijkconsistentie, worden antwoorden gegarandeerd niet verlopen dan deze waarde.

Retouren

Dict die het item vertegenwoordigt dat moet worden opgehaald.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

Het opgegeven item kan niet worden opgehaald.

Voorbeelden

Haal een item op uit de database en werk een van de eigenschappen bij:

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

read_offer

Haal het object ThroughputProperties voor deze container op. Als er nog geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd. :keyword Callable response_hook: een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord. :retourneert: Doorvoer voor de container. :genereert ~azure.cosmos.exceptions.CosmosHttpResponseError: er bestaan geen doorvoereigenschappen voor de container of

de doorvoereigenschappen kunnen niet worden opgehaald.

read_offer(**kwargs: Any) -> Offer

Retourtype

ThroughputProperties

Uitzonderingen

CosmosHttpResponseError

Het item met de opgegeven id bestaat al.

replace_item

Vervangt het opgegeven item als het in de container bestaat.

Als het item nog niet in de container bestaat, wordt er een uitzondering gegenereerd.

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]

Parameters

item

Vereist

De id (naam) of de dicteerfunctie die het item vertegenwoordigt dat moet worden vervangen.

body

Vereist

Een dicteerobject dat het item vertegenwoordigt dat moet worden vervangen.

pre_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger vóór de bewerking.

post_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

Retouren

Een dicteerfunctie die het item vertegenwoordigt nadat de vervanging is uitgevoerd.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

De vervanging is mislukt of het item met de opgegeven id bestaat niet.

replace_throughput

Vervang de doorvoer van de container.

Als er nog geen ThroughputProperties voor de container bestaan, wordt er een uitzondering gegenereerd.

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

Parameters

throughput

Vereist

De in te stellen doorvoer (een geheel getal).

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

Retouren

DoorvoerEigenschappen voor de container, bijgewerkt met nieuwe doorvoer.

Retourtype

ThroughputProperties

Uitzonderingen

CosmosHttpResponseError

Er zijn geen doorvoereigenschappen voor de container of de doorvoereigenschappen kunnen niet worden bijgewerkt.

upsert_item

Het opgegeven item invoegen of bijwerken.

Als het item al in de container bestaat, wordt het vervangen. Als het item nog niet bestaat, wordt het ingevoegd.

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]

Parameters

body

Vereist

Een dicteerobject dat het item vertegenwoordigt dat moet worden bijgewerkt of ingevoegd.

pre_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger vóór de bewerking.

post_trigger_include

Vereist

trigger-id die moet worden gebruikt als trigger na de bewerking.

session_token

str

Token voor gebruik met sessieconsistentie.

initial_headers

dict[str,str]

Eerste headers die moeten worden verzonden als onderdeel van de aanvraag.

etag

str

Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.

response_hook

Callable

Een aanroepbare die wordt aangeroepen met de metagegevens van het antwoord.

Retouren

Een dicteerfunctie die het upserte item vertegenwoordigt.

Retourtype

dict[str, Any]

Uitzonderingen

CosmosHttpResponseError

Het opgegeven item kan niet worden geupert.

Kenmerken

is_system_key

scripts