airflow.providers.alibaba.cloud.hooks.oss

模块内容

类

OSSHook

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

函数

provide_bucket_name(func)

如果提供了 key 但没有提供存储桶名称，则统一存储桶名称和 key。

unify_bucket_name_and_key(func)

如果提供了 key 但没有提供存储桶名称，则统一存储桶名称和 key。

属性

T

airflow.providers.alibaba.cloud.hooks.oss.T[源码]
airflow.providers.alibaba.cloud.hooks.oss.provide_bucket_name(func)[源码]

如果提供了 key 但没有提供存储桶名称，则统一存储桶名称和 key。

airflow.providers.alibaba.cloud.hooks.oss.unify_bucket_name_and_key(func)[源码]

如果提供了 key 但没有提供存储桶名称，则统一存储桶名称和 key。

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

基类: airflow.hooks.base.BaseHook

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

conn_name_attr = 'alibabacloud_conn_id'[源码]
default_conn_name = 'oss_default'[源码]
conn_type = 'oss'[源码]
hook_name = 'OSS'[源码]
get_conn()[源码]

返回 hook 的连接。

static parse_oss_url(ossurl)[源码]

将 OSS URL 解析为存储桶名称和 key。

参数

ossurl (str) – 要解析的 OSS URL。

返回

解析后的存储桶名称和 key

返回类型

元组

object_exists(key, bucket_name=None)[源码]

检查对象是否存在。

参数

  • key (str) – 对象的路径

  • bucket_name (str | None) – 存储桶的名称

返回

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

返回类型

bool

get_bucket(bucket_name=None)[源码]

返回 oss2.Bucket 对象。

参数

bucket_name (str | None) – 存储桶的名称

返回

到存储桶名称的存储桶对象。

返回类型

oss2.api.Bucket

load_string(key, content, bucket_name=None)[源码]

将字符串加载到 OSS。

参数

  • key (str) – 对象的路径

  • content (str) – 要设置为 key 内容的字符串。

  • bucket_name (str | None) – 存储桶的名称

upload_local_file(key, file, bucket_name=None)[源码]

将本地文件上传到 OSS。

参数

  • key (str) – 对象的 OSS 路径

  • file (str) – 要上传的本地文件。

  • bucket_name (str | None) – 存储桶的名称

download_file(key, local_file, bucket_name=None)[源代码]

从OSS下载文件。

参数

  • key ( str ) – 要下载的类文件对象的键。

  • local_file ( str ) – 本地路径 + 要保存的文件名。

  • bucket_name (str | None) – 存储桶的名称

返回

文件名。

返回类型

str | None

delete_object(key, bucket_name=None)[源代码]

从OSS删除对象。

参数

  • key ( str ) – 要删除的对象的键。

  • bucket_name (str | None) – 存储桶的名称

delete_objects(key, bucket_name=None)[源代码]

从OSS删除多个对象。

参数

  • key ( list ) – 要删除的对象的键列表。

  • bucket_name (str | None) – 存储桶的名称

delete_bucket(bucket_name=None)[源代码]

从OSS删除存储桶。

参数

bucket_name (str | None) – 存储桶的名称

create_bucket(bucket_name=None)[源代码]

创建存储桶。

参数

bucket_name (str | None) – 存储桶的名称

append_string(bucket_name, content, key, pos)[源代码]

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

参数

  • bucket_name (str | None) – 存储桶的名称

  • content ( str ) – 要追加的内容

  • key ( str ) – OSS存储桶键

  • pos ( int ) – 现有文件中将追加内容的位置

read_key(bucket_name, key)[源代码]

读取指定键的OSS远程对象内容。

参数

  • bucket_name (str | None) – 存储桶的名称

  • key ( str ) – OSS存储桶键

head_key(bucket_name, key)[源代码]

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

参数

  • bucket_name (str | None) – 存储桶的名称

  • key ( str ) – OSS存储桶键

key_exist(bucket_name, key)[源代码]

查找指定的键是否存在于OSS远程存储中。

参数

  • bucket_name (str | None) – 存储桶的名称

  • key ( str ) – OSS存储桶键

get_credential()[源代码]
get_default_region()[源代码]

此条目是否有帮助？