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 データベース サービスのサービス固有の例外。 .. warning:: このモジュールは非推奨です。 代わりに、 |
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、ConsistentPrefix、および Eventual です。 |
ContainerProxy |
特定の DB コンテナーと対話するためのインターフェイス。 このクラスを直接インスタンス化しないでください。 代わりに、 メソッドを get_container_client 使用して既存のコンテナーを取得するか、 メソッドを create_container 使用して新しいコンテナーを作成します。 Azure Cosmos DB SQL API データベース内のコンテナーはドキュメントのコレクションであり、それぞれが Item として表されます。 |
CosmosClient |
Azure Cosmos DB アカウントのクライアント側の論理表現。 このクライアントを使用して、Azure Cosmos DB サービスに対する要求を構成して実行します。 アプリケーションの有効期間ごとに CosmosClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 CosmosClient の初期化は負荷の高い操作です。資格情報やネットワーク接続の検証には、初期化 CosmosClient インスタンスを使用しないでください。 新しい CosmosClient をインスタンス化します。 |
DataType |
インデックス スペックのデータ型を指定します。 |
DatabaseAccount |
データベース アカウント。 DatabaseAccount は、データベースのコンテナーです。 |
DatabaseProxy |
特定のデータベースと対話するためのインターフェイス。 このクラスを直接インスタンス化しないでください。 代わりに、 メソッドを使用します get_database_client 。 データベースには 1 つ以上のコンテナーが含まれており、それぞれに項目、ストアド プロシージャ、トリガー、およびユーザー定義関数を含めることができます。 データベースには関連付けられたユーザーを含めることもできます。各ユーザーは、特定のコンテナー、ストアド プロシージャ、トリガー、ユーザー定義関数、または項目にアクセスするための一連のアクセス許可で構成されます。 Azure Cosmos DB SQL API データベースには、システムによって生成される次のプロパティがあります。 これらのプロパティは読み取り専用です。
|
IndexKind |
インデックス スペックのインデックスの種類を指定します。 |
IndexingMode |
サポートされているインデックス作成モードを指定します。 |
PartitionKey |
コンテナーを論理パーティションにパーティション分割するために使用されるキー。 パーティション キーを選択する方法については、「」を参照してください https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey 。 |
Permission |
Azure Cosmos DB SQL API サービスの Permission オブジェクトを表します。 |
PermissionMode |
アクセス許可の適用性を指定する列挙。 |
ProxyConfiguration |
プロキシの構成。 |
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 。 |
Azure SDK for Python