共用方式為


cosmos 套件

套件

aio

單元

auth

Azure Cosmos 資料庫服務中的授權協助程式函式。

container

在 Azure Cosmos DB SQL API 服務中建立、讀取、更新和刪除專案。

cosmos_client

在 Azure Cosmos DB SQL API 服務中建立、讀取和刪除資料庫。

database

與 Azure Cosmos DB SQL API 服務中的資料庫互動。

diagnostics

Azure Cosmos 資料庫服務作業的診斷工具。

documents

Azure Cosmos 資料庫服務中檔的類別和列舉。

errors

Azure Cosmos 資料庫服務中的服務特定例外狀況。

.. 警告::此模組已被取代。 請改用 azure.cosmos.exceptions

exceptions

Azure Cosmos 資料庫服務中的服務特定例外狀況。

http_constants

Azure Cosmos 資料庫服務中的 HTTP 常數。

offer

在 Azure Cosmos DB SQL API 服務中建立輸送量屬性。

partition_key

在 Azure Cosmos DB SQL API 服務中建立分割區索引鍵。

permission

在 Azure Cosmos DB SQL API 服務中建立許可權。

scripts

在 Azure Cosmos DB SQL API 服務中建立、讀取、更新和執行腳本。

user

在 Azure Cosmos DB SQL API 服務中建立、讀取、更新和刪除使用者。

類別

ConnectionRetryPolicy
ConsistencyLevel

表示 Azure Cosmos 用戶端作業支援的一致性層級。

要求的 ConsistencyLevel 必須符合或比針對資料庫帳戶布建的還要弱。 一致性層級。

依強度順序的一致性層級為 Strong、BoundedStaleness、Session、ConsistencPrefix 和 Eventual。

ContainerProxy

與特定 DB 容器互動的介面。

此類別不應該直接具現化。 請改用 get_container_client 方法來取得現有的容器,或 create_container 建立新容器的方法。

Azure Cosmos DB SQL API 資料庫中的容器是檔的集合,每個檔都會以 Item 表示。

CosmosClient

Azure Cosmos DB 帳戶的用戶端邏輯標記法。

使用此用戶端來設定和執行對 Azure Cosmos DB 服務的要求。

建議在應用程式的每一存留期內維護 CosmosClient 的單一實例,以便有效率的連線管理和效能。

CosmosClient 初始化是繁重的作業 - 請勿使用初始化 CosmosClient 實例作為認證或網路連線驗證。

具現化新的 CosmosClient。

DataType

指定索引規格的資料類型。

DatabaseAccount

資料庫帳戶。

DatabaseAccount 是資料庫的容器。

DatabaseProxy

與特定資料庫互動的介面。

此類別不應該直接具現化。 請改用 get_database_client 方法。

資料庫包含一或多個容器,每個容器都可以包含專案、預存程式、觸發程式和使用者定義函式。

資料庫也可以有相關聯的使用者,每個使用者都會設定一組許可權來存取特定容器、預存程式、觸發程式、使用者定義函式或專案。

Azure Cosmos DB SQL API 資料庫具有下列系統產生的屬性。 這些屬性是唯讀的:

  • _rid:資源識別碼。

  • _ts:上次更新資源的時間。 值為時間戳記。

  • _self:資源的唯一可定址 URI。

  • _etag:開放式並行控制所需的資源 etag。

  • _colls:集合資源的可定址路徑。

  • _users:使用者資源的可定址路徑。

IndexKind

指定索引規格的索引種類。

IndexingMode

指定支援的索引編制模式。

PartitionKey

用來將容器分割成邏輯資料分割的索引鍵。

如需如何選擇分割區索引鍵的資訊,請參閱 https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey

Permission

表示 Azure Cosmos DB SQL API 服務中的 Permission 物件。

PermissionMode

列舉,指定許可權的適用性。

ProxyConfiguration

Proxy 的組態。

SSLConfiguration

SSL 連線的組態。

如需相關資訊,請參閱 https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification

ScriptsProxy

與預存程式互動的介面。

此類別不應該直接具現化。 請改用 scripts 屬性。

ThroughputProperties

表示 Azure Cosmos DB SQL API 容器中的輸送量屬性。

若要讀取和更新輸送量屬性,請使用 上的 <xref:Container> 相關聯方法。 如果設定自動調整,則必須設定 auto_scale_max_throughput ,而且也可以與它一起設定 auto_scale_increment_percent 。 不允許 將 offer_throughput 的值與自動調整設定一起設定。

TriggerOperation

指定應該執行觸發程式的作業。

TriggerType

指定觸發程式的型別。

UserProxy

與特定使用者互動的介面。

此類別不應該直接具現化。 請改用 get_user_client 方法。