airflow.providers.microsoft.azure.hooks.cosmos

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

AzureCosmosDBHook 透過 Azure Cosmos 程式庫進行溝通。請確保存在類型為 azure_cosmos 的 Airflow 連線。可以透過提供登入資訊 (=端點 URI)、密碼 (=密鑰) 以及額外欄位 database_name 和 collection_name 來進行授權，以指定要使用的預設資料庫和集合 (範例請參閱連線 azure_cosmos_default)。

模組內容

類別

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 文件連結。

屬性

PartitionKeyType

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

繼承自: airflow.hooks.base.BaseHook

與 Azure CosmosDB 互動。

登入資訊應為端點 URI，密碼應為主金鑰 (可選)。您可以選擇使用以下額外資訊來預設這些值：{“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]

傳回自訂欄位行為。

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 連線。

取得 Azure CosmosDB 資料庫連結。

取得 Azure CosmosDB 集合連結。

取得 Azure CosmosDB 文件連結。

這個條目是否有幫助？