airflow.providers.ftp.operators.ftp¶

此模块包含 FTP 操作符。

类¶

`FTPOperation`	可用于 FTP 的操作。
`FTPFileTransmitOperator`	FTPFileTransmitOperator 用于在远程主机与本地之间传输文件，或反向传输。
`FTPSFileTransmitOperator`	FTPSFileTransmitOperator 用于在远程主机与本地之间传输文件，或反向传输。

模块内容¶

class airflow.providers.ftp.operators.ftp.FTPOperation[source]¶

可用于 FTP 的操作。

PUT = 'put'[source]¶

GET = 'get'[source]¶

class airflow.providers.ftp.operators.ftp.FTPFileTransmitOperator(*, ftp_conn_id='ftp_default', local_filepath, remote_filepath, operation=FTPOperation.PUT, create_intermediate_dirs=False, **kwargs)[source]¶

Bases: airflow.providers.common.compat.sdk.BaseOperator

FTPFileTransmitOperator 用于在远程主机与本地之间传输文件，或反向传输。

此操作符使用 FTPHook 打开 FTP 传输通道，作为文件传输的基础。

另请参阅

有关如何使用此操作符的更多信息，请参阅指南： FTPFileTransmitOperator

参数:

ftp_conn_id (str) – 来自 FTP 连接 ID 的 airflow Connections。
local_filepath (str | list[str]) – 本地文件路径，用于获取或放置。（可模板化）
remote_filepath (str | list[str]) – 远程文件路径，用于获取或放置。（可模板化）
operation (str) – 指定操作 ‘get’ 或 ‘put’，默认是 put
create_intermediate_dirs (bool) –
在从远程复制到本地或反向复制时，创建缺失的中间目录。默认值为 False。

示例：以下任务将把 file.txt 复制到远程主机的 /tmp/tmp1/tmp2/，并在不存在时创建 tmp、tmp1 和 tmp2。如果未传递 create_intermediate_dirs 参数，则会因目录不存在而报错。
```
put_file = FTPFileTransmitOperator(
    task_id="test_ftp",
    ftp_conn_id="ftp_default",
    local_filepath="/tmp/file.txt",
    remote_filepath="/tmp/tmp1/tmp2/file.txt",
    operation="put",
    create_intermediate_dirs=True,
    dag=dag,
)
```

template_fields: collections.abc.Sequence[str] = ('local_filepath', 'remote_filepath')[source]¶

ftp_conn_id = 'ftp_default'[source]¶

operation = 'put'[source]¶

create_intermediate_dirs = False[source]¶

local_filepath[source]¶

remote_filepath[source]¶

property hook: airflow.providers.ftp.hooks.ftp.FTPHook[source]¶

创建并返回一个 FTPHook。

execute(context)[source]¶

在创建算子时派生。

执行任务的主要方法。Context 是与渲染 jinja 模板时使用的相同字典。

有关更多上下文，请参考 get_template_context。

get_openlineage_facets_on_start()[source]¶

返回 OpenLineage 数据集。

数据集将具有以下结构: 输入：file://hostname/path 输出 file://<conn.host>:<conn.port>/path.

class airflow.providers.ftp.operators.ftp.FTPSFileTransmitOperator(*, ftp_conn_id='ftp_default', local_filepath, remote_filepath, operation=FTPOperation.PUT, create_intermediate_dirs=False, **kwargs)[source]¶

Bases: FTPFileTransmitOperator

FTPSFileTransmitOperator 用于在远程主机与本地之间传输文件，或反向传输。

此操作符使用 FTPSHook 打开 FTPS 传输通道，作为文件传输的基础。

另请参阅

对于如何使用此操作符的更多信息，请参阅指南： FTPSFileTransmitOperator

property hook: airflow.providers.ftp.hooks.ftp.FTPSHook[source]¶

创建并返回一个 FTPSHook。