提供者資料共用功能

此處列出的程序涵蓋了 Data Share 提供者所需的所有功能。

建立提供者程序

此功能會建立「資料共用收件人」。

語法

Share.create_provider(name, endpoint, share_links, provider_type, bearer, client_id,
      client_secret, token_endpoint, description, owner )
以下是參數和描述：
  • name ：收件者名稱。您必須在此欄位中輸入值。
  • 端點：此欄位顯示「提供者資料共用」服務的端點。此為必要欄位。
  • share_links ：提供者共用連結說明具有下列欄位：
    • [{"shareName":"shareNameValue", "shareLinkName":"shareLinkNameValue"}]

    您必須在此欄位中輸入值。

  • provider_type *：此欄位顯示提供者資料共用類型的類型。您可以有兩個值：DELTA 或 LIVE。
  • bearer ：此欄位顯示提供者「資料共用」持有者記號。您必須在此欄位中輸入值。
  • client_id ：此欄位顯示提供者「資料共用從屬端 ID」位址。您必須在此欄位中輸入值。
  • client_secret ：此欄位顯示提供者「資料共用從屬端加密密碼」記號。您必須在此欄位中輸入值。
  • token_endpoint ：此欄位顯示提供者資料共用權杖端點位址。您必須在此欄位中輸入值。
  • 電子郵件：此欄位顯示「收件者」的電子郵件地址。
  • 說明：此欄位顯示「提供者」的說明。如果缺少此欄位，則工具會使用空白字串。
  • 擁有者：此欄位顯示「提供者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以建立「資料共用提供者」：
provider_json = {
  "shareCredentialsVersion": 1,
  "endpoint": "https://abcd/delta-sharing/",
  "bearerToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

bearer_token   = provider_json['bearerToken']
endpoint       = provider_json['endpoint']
provider_name  = "provider_demo_delta_sharing_1"
description    = "provider demo delta sharing desc"
owner          = "ADMIN"
provider_type  = "DELTA"
share_links    = json.dumps([{"shareName":"DELTA_SHARING",
                              "shareLinkName":"DEMO_DELTA_SHARING"}])

adp.Share.create_provider (
    bearer         = bearer_token,
    description    = description,
    endpoint       = endpoint,
    name           = provider_name,
    owner          = owner,
    provider_type  = provider_type,
    share_links    = share_links)

//Output:
'{ "CreateShareProvider": true }'

刪除提供者程序

此函數會刪除資料共用提供者。

語法

Share.delete_provider(name, owner)
以下是參數和描述：
  • 名稱：收件者名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「提供者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以刪除資料共用提供者：
adp.Share.delete_provider(name  = 'provider_demo_delta_sharing_2')

//Output:
'{ "status": true }'

重新命名提供者程序

此函數會重新命名資料共用提供者。

語法

Share.rename_provider(name, new_name, owner)
以下是參數和描述：
  • name ：「提供程式」的名稱。您必須在此欄位中輸入值。
  • new_name ：此欄位顯示您選擇的「資料共用提供者」名稱。此為必要欄位。
  • 擁有者：此欄位顯示「提供者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以重新命名「資料共用提供者」：
adp.Share.rename_provider (name = 'provider_demo_delta_sharing_1', new_name = 'provider_demo_delta_sharing_2')

//Output:
'{ "status": true }'

取得提供者程序

此功能會接收資料共用提供者的明細。

語法

Share.get_provider(name, owner)
以下是參數和描述：
  • name ：「提供程式」的名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「提供者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以接收「資料共用提供者」的詳細資訊：
name = 'provider_demo_delta_sharing_2'
s = adp.Share.get_provider(name)
json.loads(s)

//Output:
{'name': 'PROVIDER_DEMO_DELTA_SHARING_2',
 'id': 40437,
 'endpoint': 'https://abcd/',
 'shareType': 'DELTA',
 'tokenEndPoint': None,
 'shareLinks': [{'name': 'DEMO_DELTA_SHARING',
   'id': 40438,
   'shareType': 'DELTA',
   'shareName': 'DELTA_SHARING'}]}

取得提供者

此函數會根據提供者擁有者接收「資料共用提供者」清單。

語法

Share.get_providers(owner)
以下是參數和描述：
  • name ：「提供程式」的名稱。您必須在此欄位中輸入值。
  • 端點：此欄位顯示「提供者資料共用」服務的端點。此為必要欄位。
  • share_links ：提供者共用連結說明具有下列欄位：
    • [{"shareName":"shareNameValue", "shareLinkName":"shareLinkNameValue"}]

    您必須在此欄位中輸入值。

  • 擁有者：此欄位顯示「提供者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以接收「資料共用提供者」清單：
s = adp.Share.get_providers()
json.loads(s)

//Output:
[{'id': 40437,
  'name': 'PROVIDER_DEMO_DELTA_SHARING_2',
  'owner': 'ADMIN',
  'endpoint': 'https://abcd/delta-sharing/',
  'shareType': 'DELTA'}]

父項主題：資料共用函數