airflow.providers.alibaba.cloud.hooks.oss¶

属性¶

T

类¶

OSSHook

使用 oss2 库与阿里云 OSS 进行交互。

函数¶

`provide_bucket_name`(func)	如果提供了 key 但没有提供 bucket name，则统一 bucket name 和 key。
`unify_bucket_name_and_key`(func)	如果提供了 key 但没有提供 bucket name，则统一 bucket name 和 key。

模块内容¶

airflow.providers.alibaba.cloud.hooks.oss.T[source]¶

airflow.providers.alibaba.cloud.hooks.oss.provide_bucket_name(func)[source]¶

如果提供了 key 但没有提供 bucket name，则统一 bucket name 和 key。

airflow.providers.alibaba.cloud.hooks.oss.unify_bucket_name_and_key(func)[source]¶

如果提供了 key 但没有提供 bucket name，则统一 bucket name 和 key。

class airflow.providers.alibaba.cloud.hooks.oss.OSSHook(region=None, oss_conn_id='oss_default', *args, **kwargs)[source]¶

基类: airflow.hooks.base.BaseHook

使用 oss2 库与阿里云 OSS 进行交互。

conn_name_attr = 'alibabacloud_conn_id'[source]¶

default_conn_name = 'oss_default'[source]¶

conn_type = 'oss'[source]¶

hook_name = 'OSS'[source]¶

oss_conn_id = 'oss_default'[source]¶

oss_conn[source]¶

region[source]¶

get_conn()[source]¶

返回 hook 的连接。

static parse_oss_url(ossurl)[source]¶

将 OSS URL 解析为 bucket name 和 key。

参数:: ossurl (str) – 要解析的 OSS URL。
返回值:: 解析后的 bucket name 和 key
返回类型:: tuple

object_exists(key, bucket_name=None)[source]¶

检查对象是否存在。

参数:

key (str) – 对象的路径
bucket_name (str | None) – bucket 的名称

返回值:

如果存在则为 True，否则为 False。

返回类型:

bool

get_bucket(bucket_name=None)[source]¶

返回一个 oss2.Bucket 对象。

参数:: bucket_name (str | None) – bucket 的名称
返回值:: 对应于 bucket name 的 bucket 对象。
返回类型:: oss2.api.Bucket

load_string(key, content, bucket_name=None)[source]¶

将字符串加载到 OSS。

参数:

key (str) – 对象的路径
content (str) – 用作 key 内容的字符串。
bucket_name (str | None) – bucket 的名称

upload_local_file(key, file, bucket_name=None)[source]¶

上传本地文件到 OSS。

参数:

key (str) – 对象的 OSS 路径
file (str) – 要上传的本地文件。
bucket_name (str | None) – bucket 的名称

download_file(key, local_file, bucket_name=None)[source]¶

从 OSS 下载文件。

参数:

key (str) – 要下载的文件类对象的 key。
local_file (str) – 要保存的本地路径 + 文件名。
bucket_name (str | None) – bucket 的名称

返回值:

文件名。

返回类型:

str | None

delete_object(key, bucket_name=None)[source]¶

从 OSS 删除对象。

参数:

key (str) – 要删除的对象的 key。
bucket_name (str | None) – bucket 的名称

delete_objects(key, bucket_name=None)[source]¶

从 OSS 删除对象列表。

参数:

key (list) – 要删除的对象 key 列表。
bucket_name (str | None) – bucket 的名称

delete_bucket(bucket_name=None)[source]¶

从 OSS 删除 bucket。

参数:: bucket_name (str | None) – bucket 的名称

create_bucket(bucket_name=None)[source]¶

创建 bucket。

参数:: bucket_name (str | None) – bucket 的名称

append_string(bucket_name, content, key, pos)[source]¶

向远程现有文件追加字符串。

参数:

bucket_name (str | None) – bucket 的名称
content (str) – 要追加的内容
key (str) – oss bucket key
pos (int) – 内容将被追加到现有文件的位置

read_key(bucket_name, key)[source]¶

读取具有指定 key 的 oss 远程对象内容。

参数:

bucket_name (str | None) – bucket 的名称
key (str) – oss bucket key

head_key(bucket_name, key)[source]¶

获取指定远程对象的元信息。

参数:

bucket_name (str | None) – bucket 的名称
key (str) – oss bucket key

key_exist(bucket_name, key)[source]¶

查找 oss 远程存储中指定的 key 是否存在。

参数:

bucket_name (str | None) – bucket 的名称
key (str) – oss bucket key

get_credential()[source]¶

get_default_region()[source]¶