airflow.providers.alibaba.cloud.hooks.oss

模組內容

類別

OSSHook

使用 oss2 程式庫與 Alibaba Cloud OSS 互動。

函數

provide_bucket_name(func)

如果提供了金鑰但未提供儲存貯體名稱,則統一儲存貯體名稱和金鑰。

unify_bucket_name_and_key(func)

如果提供了金鑰但未提供儲存貯體名稱,則統一儲存貯體名稱和金鑰。

屬性

T

airflow.providers.alibaba.cloud.hooks.oss.T[原始碼]
airflow.providers.alibaba.cloud.hooks.oss.provide_bucket_name(func)[原始碼]

如果提供了金鑰但未提供儲存貯體名稱,則統一儲存貯體名稱和金鑰。

airflow.providers.alibaba.cloud.hooks.oss.unify_bucket_name_and_key(func)[原始碼]

如果提供了金鑰但未提供儲存貯體名稱,則統一儲存貯體名稱和金鑰。

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

基底類別: airflow.hooks.base.BaseHook

使用 oss2 程式庫與 Alibaba Cloud 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 解析為儲存貯體名稱和金鑰。

參數

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

返回

已解析的儲存貯體名稱和金鑰

返回類型

tuple

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) – 要設定為金鑰內容的字串。

  • 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()[原始碼]

此條目是否對您有幫助?