ContainerProxy 類別

在容器中建立專案。

若要更新或取代現有的專案，請使用 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]

參數

傳回

表示新專案的聽寫。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

依分割區索引鍵刪除功能是非同步背景作業，可讓您使用 Cosmos SDK 刪除具有相同邏輯分割區索引鍵值的所有檔。 分割區索引鍵作業的刪除限制，每秒最多耗用 10% 的容器上可用的 RU/秒總數。 這有助於限制此背景工作所使用的資源。

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

參數

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

從容器中刪除指定的衝突。

如果容器中還沒有衝突，則會引發例外狀況。

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

參數

傳回類型

例外狀況

衝突未成功刪除。

此衝突不存在於容器中。

從容器中刪除指定的專案。

如果容器中還沒有任何專案存在，則會引發例外狀況。

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

參數

傳回類型

例外狀況

專案未成功刪除。

專案不存在於容器中。

取得衝突所識別的 衝突。

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

參數

傳回

表示擷取衝突的聽寫。

傳回類型

例外狀況

無法擷取指定的衝突。

取得此容器的 ThroughputProperties 物件。

如果容器中還沒有 ThroughputProperties，則會引發例外狀況。 ：keyword 可呼叫response_hook：使用回應中繼資料叫用的可呼叫。 ：returns：容器的輸送量。 ：raises ~azure.cosmos.exceptions.CosmosHttpResponseError：容器沒有輸送量屬性或

無法擷取輸送量屬性。

get_throughput(**kwargs: Any) -> ThroughputProperties

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

列出容器中的所有衝突。

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

參數

傳回

可反覆運算 (聽寫) 衝突。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

臨時方法 如果指定的專案存在於容器中，則會以提供的作業修補。

如果容器中還沒有任何專案存在，則會引發例外狀況。

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

參數

傳回

聽寫，表示修補作業完成之後的專案。

傳回類型

例外狀況

修補程式作業失敗，或具有指定識別碼的專案不存在。

傳回符合指定 查詢的所有衝突。

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

參數

傳回

可反覆運算 (聽寫) 衝突。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

傳回符合指定 查詢的所有結果。

您可以在 FROM 子句中使用容器名稱的任何值，但通常會使用容器名稱。 在下列範例中，容器名稱為 「products」，且別名為 「p」，以方便在 WHERE 子句中參考。

查詢回應中的回應接續權杖。 有效值為正整數。 值為 0 與未傳遞值相同， (預設沒有限制) 。 ：keyword int max_integrated_cache_staleness_in_ms：中整合式快取的最大快取過時

毫秒。 針對設定為使用整合式快取的帳戶，使用會話或最終一致性，回應保證不會超過此值。

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

傳回

可反覆運算 (聽寫) 的專案。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

範例

取得尚未停止的所有產品：

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

參數化查詢，以取得已停止的所有產品：

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

參數

傳回

可反覆運算 (聽寫) 的專案。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

讀取容器屬性。

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

參數

傳回

代表擷取容器的聽寫。

傳回類型

例外狀況

無法擷取容器時引發。 這包括容器不存在時。

列出容器中的所有專案。

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

參數

傳回

可反覆運算 (聽寫) 的專案。

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

取得專案所識別 的專案。

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]

參數

傳回

代表要擷取之專案的聽寫。

傳回類型

例外狀況

無法擷取指定的專案。

範例

從資料庫取得專案，並更新其中一個屬性：

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

取得此容器的 ThroughputProperties 物件。 如果容器中還沒有 ThroughputProperties，則會引發例外狀況。 ：keyword 可呼叫response_hook：使用回應中繼資料叫用的可呼叫。 ：returns：容器的輸送量。 ：raises ~azure.cosmos.exceptions.CosmosHttpResponseError：容器沒有輸送量屬性或

無法擷取輸送量屬性。

read_offer(**kwargs: Any) -> Offer

傳回類型

例外狀況

具有指定識別碼的專案已經存在。

如果指定的專案存在於容器中，則會取代它。

如果容器中還沒有任何專案存在，則會引發例外狀況。

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]

參數

傳回

聽寫，表示取代之後的專案。

傳回類型

例外狀況

取代失敗，或具有指定識別碼的專案不存在。

取代容器的輸送量。

如果容器中還沒有 ThroughputProperties，則會引發例外狀況。

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

參數

傳回

容器的 ThroughputProperties，以新的輸送量更新。

傳回類型

例外狀況

容器沒有輸送量屬性，或無法更新輸送量屬性。

插入或更新指定的專案。

如果專案已存在於容器中，則會加以取代。 如果專案不存在，則會插入該專案。

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]

參數

傳回

表示 upserted 專案的聽寫。

傳回類型

例外狀況

無法插入指定的專案。