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]¶