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')[源代码]

基类: airflow.hooks.base.BaseHook

与 Azure 文件共享存储交互。

参数

azure_fileshare_conn_id (str) – 指向应该使用的 Azure 账户的 Azure 文件共享连接 ID 的引用。

property share_service_client[源代码]
property share_directory_client[源代码]
property share_file_client[源代码]
conn_name_attr = 'azure_fileshare_conn_id'[源代码]
default_conn_name = 'azure_fileshare_default'[源代码]
conn_type = 'azure_fileshare'[源代码]
hook_name = 'Azure FileShare'[源代码]
classmethod get_connection_form_widgets()[源代码]

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

classmethod get_ui_field_behaviour()[源代码]

返回自定义字段行为。

get_conn()[源代码]

返回钩子的连接。

check_for_directory()[源代码]

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

list_directories_and_files()[源代码]

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

list_files()[源代码]

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

create_share(share_name, **kwargs)[源代码]

创建新的 Azure 文件共享。

参数

share_name (str) – 共享的名称。

返回

如果创建了共享,则返回 True;如果共享已存在,则返回 False。

返回类型

bool

delete_share(share_name, **kwargs)[源代码]

删除现有的 Azure 文件共享。

参数

share_name (str) – 共享的名称。

返回

如果删除了共享,则返回 True;如果共享不存在,则返回 False。

返回类型

bool

create_directory(**kwargs)[源代码]

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

get_file(file_path, **kwargs)[源代码]

从 Azure 文件共享下载文件。

参数

file_path ( str ) – 文件存储的位置。

get_file_to_stream(stream, **kwargs)[源代码]

从 Azure 文件共享下载文件。

参数

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

load_file(file_path, **kwargs)[源代码]

上传文件到 Azure 文件共享。

参数

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

load_data(string_data, **kwargs)[源代码]

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

参数

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

test_connection()[源代码]

测试 Azure 文件共享连接。

这个条目是否有帮助?