airflow.providers.microsoft.azure.hooks.cosmos¶

此模組包含與 Azure CosmosDB 的整合。

AzureCosmosDBHook 透過 Azure Cosmos 庫進行通訊。請確保存在型別為 azure_cosmos 的 Airflow 連線。授權可以透過提供 login (=Endpoint uri)、password (=secret key) 以及 extra 欄位 database_name 和 collection_name 來完成，以指定要使用的預設資料庫和集合（示例請參見連線 azure_cosmos_default）。

屬性¶

PartitionKeyType

類¶

AzureCosmosDBHook

與 Azure CosmosDB 互動。

函式¶

`get_database_link`(database_id)	獲取 Azure CosmosDB 資料庫連結。
`get_collection_link`(database_id, collection_id)	獲取 Azure CosmosDB 集合連結。
`get_document_link`(database_id, collection_id, document_id)	獲取 Azure CosmosDB 文件連結。

模組內容¶

airflow.providers.microsoft.azure.hooks.cosmos.PartitionKeyType[source]¶

class airflow.providers.microsoft.azure.hooks.cosmos.AzureCosmosDBHook(azure_cosmos_conn_id=default_conn_name)[source]¶

Bases: airflow.hooks.base.BaseHook

與 Azure CosmosDB 互動。

login 應該是 endpoint uri，password 應該是 master key。可選地，您可以使用以下 extra 來設定這些值的預設值 {“database_name”: “<DATABASE_NAME>”, “collection_name”: “COLLECTION_NAME”}。

引數:: azure_cosmos_conn_id (str) – 對 Azure CosmosDB 連線的引用。

conn_name_attr = 'azure_cosmos_conn_id'[source]¶

default_conn_name = 'azure_cosmos_default'[source]¶

conn_type = 'azure_cosmos'[source]¶

hook_name = 'Azure CosmosDB'[source]¶

classmethod get_connection_form_widgets()[source]¶

返回新增到連線表單的連線控制元件。

classmethod get_ui_field_behaviour()[source]¶

返回自定義欄位行為。

conn_id = 'azure_cosmos_default'[source]¶

default_database_name = None[source]¶

default_collection_name = None[source]¶

default_partition_key = None[source]¶

get_conn()[source]¶

返回 Cosmos DB 客戶端。

does_collection_exist(collection_name, database_name)[source]¶

檢查 CosmosDB 中是否存在集合。

create_collection(collection_name, database_name=None, partition_key=None)[source]¶

在 CosmosDB 資料庫中建立一個新集合。

does_database_exist(database_name)[source]¶

檢查 CosmosDB 中是否存在資料庫。

create_database(database_name)[source]¶

在 CosmosDB 中建立一個新資料庫。

delete_database(database_name)[source]¶

刪除 CosmosDB 中現有的資料庫。

delete_collection(collection_name, database_name=None)[source]¶

刪除 CosmosDB 資料庫中現有的集合。

upsert_document(document, database_name=None, collection_name=None, document_id=None)[source]¶: 在 CosmosDB 資料庫中現有的集合中插入或更新文件。

insert_documents(documents, database_name=None, collection_name=None)[source]¶

在 CosmosDB 資料庫中現有的集合中插入新的文件列表。

delete_document(document_id, database_name=None, collection_name=None, partition_key=None)[source]¶

從 CosmosDB 資料庫中的集合中刪除現有的文件。

get_document(document_id, database_name=None, collection_name=None, partition_key=None)[source]¶

從 CosmosDB 資料庫中現有的集合獲取文件。

get_documents(sql_string, database_name=None, collection_name=None, partition_key=None)[source]¶

透過 SQL 查詢從 CosmosDB 資料庫中現有的集合獲取文件列表。

test_connection()[source]¶: 測試已配置的 Azure Cosmos 連線。

airflow.providers.microsoft.azure.hooks.cosmos.get_database_link(database_id)[source]¶

獲取 Azure CosmosDB 資料庫連結。

airflow.providers.microsoft.azure.hooks.cosmos.get_collection_link(database_id, collection_id)[source]¶

獲取 Azure CosmosDB 集合連結。

airflow.providers.microsoft.azure.hooks.cosmos.get_document_link(database_id, collection_id, document_id)[source]¶

獲取 Azure CosmosDB 文件連結。