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 文档链接。