airflow.providers.microsoft.azure.hooks.fileshare¶

类¶

AzureFileShareHook

与 Azure 文件共享存储交互。

模块内容¶

class airflow.providers.microsoft.azure.hooks.fileshare.AzureFileShareHook(share_name=None, file_path=None, directory_path=None, azure_fileshare_conn_id='azure_fileshare_default')[source]¶

基类: airflow.hooks.base.BaseHook

与 Azure 文件共享存储交互。

参数:: azure_fileshare_conn_id (str) – 引用要使用的 Azure 帐户的 Azure 文件共享连接 ID。

conn_name_attr = 'azure_fileshare_conn_id'[source]¶

default_conn_name = 'azure_fileshare_default'[source]¶

conn_type = 'azure_fileshare'[source]¶

hook_name = 'Azure FileShare'[source]¶

classmethod get_connection_form_widgets()[source]¶

返回添加到连接表单的连接小部件。

classmethod get_ui_field_behaviour()[source]¶

返回自定义字段行为。

share_name = None[source]¶

file_path = None[source]¶

directory_path = None[source]¶

get_conn()[source]¶

返回 hook 的连接。

property share_service_client[source]¶

property share_directory_client[source]¶

property share_file_client[source]¶

check_for_directory()[source]¶

检查 Azure 文件共享上是否存在目录。

list_directories_and_files()[source]¶

返回存储在 Azure 文件共享上的目录和文件列表。

list_files()[source]¶

返回存储在 Azure 文件共享上的文件列表。

create_share(share_name, **kwargs)[source]¶

创建新的 Azure 文件共享。

参数:: share_name (str) – 共享名称。
返回:: 如果共享已创建则返回 True，如果共享已存在则返回 False。
返回类型:: bool

delete_share(share_name, **kwargs)[source]¶

删除现有的 Azure 文件共享。

参数:: share_name (str) – 共享名称。
返回:: 如果共享已删除则返回 True，如果共享不存在则返回 False。
返回类型:: bool

create_directory(**kwargs)[source]¶

在 Azure 文件共享上创建新目录。

get_file(file_path, **kwargs)[source]¶

从 Azure 文件共享下载文件。

参数:: file_path (str) – 存储文件的路径。

get_file_to_stream(stream, **kwargs)[source]¶

从 Azure 文件共享下载文件。

参数:: stream (IO) – 用于存储文件的文件句柄。

load_file(file_path, **kwargs)[source]¶

上传文件到 Azure 文件共享。

参数:: file_path (str) – 要加载的文件的路径。

load_data(string_data, **kwargs)[source]¶

上传字符串到 Azure 文件共享。

参数:: string_data (bytes | str | IO) – 要加载的字符串/流。

test_connection()[source]¶: 测试 Azure 文件共享连接。