プロバイダ・データ共有関数

プロバイダの作成手順

この関数は、データ共有受信者を作成します。

構文

Share.create_provider(name, endpoint, share_links, provider_type, bearer, client_id,
      client_secret, token_endpoint, description, owner )

パラメータと説明を次に示します:

name: 受信者の名前。このフィールドは必須です。
endpoint: このフィールドには、プロバイダ・データ共有サービスのエンドポイントが表示されます。これは必須です。
share_links: プロバイダ共有リンク・ディクショナリには次のフィールドがあります:
- [{"shareName":"shareNameValue", "shareLinkName":"shareLinkNameValue"}]
このフィールドは必須です。
provider_type*: このフィールドには、プロバイダ・データ共有タイプのタイプが表示されます。DELTAまたはLIVEの2つの値を使用できます。
bearer: このフィールドには、プロバイダ・データ共有Bearerトークンが表示されます。このフィールドは必須です。
client_id: このフィールドには、プロバイダ・データ共有クライアントIDアドレスが表示されます。このフィールドは必須です。
client_secret: このフィールドには、プロバイダ・データ共有クライアント・シークレット・トークンが表示されます。このフィールドは必須です。
token_endpoint: このフィールドには、プロバイダ・データ共有トークン・エンドポイント・アドレスが表示されます。このフィールドは必須です。
email: このフィールドには、受信者のメール・アドレスが表示されます。
description: このフィールドには、プロバイダの説明が表示されます。このフィールドがない場合、空の文字列が使用されます。
owner: このフィールドには、プロバイダ所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有プロバイダを作成できます:

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)

パラメータと説明を次に示します:

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: このフィールドには、選択したデータ共有プロバイダの名前が表示されます。これは必須です。
owner: このフィールドには、プロバイダ所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有プロバイダの名前を変更できます:

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: プロバイダの名前。このフィールドは必須です。
owner: このフィールドには、プロバイダ所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有プロバイダの詳細を受け取ることができます:

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: プロバイダの名前。このフィールドは必須です。
endpoint: このフィールドには、プロバイダ・データ共有サービスのエンドポイントが表示されます。これは必須です。
share_links: プロバイダ共有リンク・ディクショナリには次のフィールドがあります:
- [{"shareName":"shareNameValue", "shareLinkName":"shareLinkNameValue"}]
このフィールドは必須です。
owner: このフィールドには、プロバイダ所有者が表示されます。このフィールドがない場合、現在のスキーマ所有者が使用されます。

例

この例では、データ共有プロバイダのリストを受け取ることができます:

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'}]