Fonctions de partage de données

L'API (Application Programming Interface) Python Data Studio pour les fonctions de partage de données fournit la syntaxe et les descriptions des classes, méthodes, attributs et paramètres de l'interface de programmation d'application à l'outil de partage de données de la suite d'outils Data Studio.

Fonctions d'API Data Studio Data Share

La classe Adp.Share est utilisée pour travailler avec des partages de données. Cette classe contient un ensemble de fonctions de partage de données qui permettent de gérer les partages de données, les destinataires, etc.

Prérequis

Vous devez d'abord créer une instance ADP.

Les fonctions ont une valeur de retour de chaîne et des paramètres de chaîne.

Créer une procédure de partage

Cette fonction crée un partage de données basé sur la date de stockage d'objet et les associe à des destinataires.

Syntaxe

Share.create_share(name, objects, storage_link_name, publish_job_details, owner, type,
      storage_link_owner, description)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • objets : le dictionnaire d'objets de partage de données se compose des champs suivants :
    • [{"schemaName" : "schemaNameValue", "objects" : [{"objectName" : "objectNameValue", "objectOwner" : "objectOwnerValue", "shareObjectName"}, ...]}, ...]

    Ce champ est obligatoire.

  • storage_link_name : ce champ affiche le nom du lien de stockage cloud de partage de données.
  • publish_job_details : ce champ affiche le dictionnaire de détails du travail de publication de partage de données. Si ce champ est manquant, {"enabled": False} est utilisé.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
  • type : type du partage de données. Si ce champ est manquant, l'outil utilise le champ VERSIONED.
  • storage_link_owner : propriétaire du lien Stockage cloud de partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
  • description : Ce champ affiche la description du partage de données. Si ce champ est manquant, l'outil utilise une chaîne vide.

Exemple
Dans cet exemple, vous pouvez créer un partage de données :
name = 'share_py_api_7'
desc = 'desc_share_py_api_7'
link = '"food_cred"'
share_objects = json.dumps([{"schemaName" : "ADMIN",
           "objects" : [{"objectName"      : "IRIS",
                         "objectOwner"     : "ADMIN",
                         "shareObjectName" : "IRIS_SHARE"},
                        {"objectName"      : "DEMO_FOOD_SAMPLE",
                         "objectOwner"     : "ADMIN",
                         "shareObjectName" : "DEMO_FOOD_SAMPLE_SHARE"}
                         ]}])
job = json.dumps({"enabled" : False})

adp.Share.create_share(
    name                = name,
    description         = desc,
    storage_link_name   = link,
    objects             = share_objects,
    publish_job_details = job)

//Output:
{"createdShare":true,"notifyRecipients":false,"shareId":40295,"sharetablename_":"DEMO_FOOD_SAMPLE_SHARE"}

Procédure Mettre à jour des objets de partage de données

Cette fonction met à jour les objets de partage de données.

Syntaxe

Share.update_share_objects(name, objects, publish_job_details, owner,
    description)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • objets : le dictionnaire d'objets de partage de données se compose des champs suivants :
    • [{"schemaName" : "schemaNameValue", "objects" : [{"objectName" : "objectNameValue", "objectOwner" : "objectOwnerValue", "shareObjectName"}, ...]}, ...]

    Ce champ est obligatoire.

  • publish_job_details : ce champ affiche le dictionnaire de détails du travail de publication de partage de données. Si ce champ est manquant, {"enabled": False} est utilisé.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
  • description : Ce champ affiche la description du partage de données. Si ce champ est manquant, l'outil utilise une chaîne vide.

Exemple
Dans cet exemple, vous pouvez mettre à jour un objet de partage de données :
name = 'share_py_api_7'
objects = json.dumps([{"schemaName" : "ADMIN",
           "objects" : [{"objectName"      : "WINE",
                         "objectOwner"     : "ADMIN",
                         "shareObjectName" : "WINE_SHARE"}
                         ]}])

adp.Share.update_share_objects(name = name, objects = objects)

//Output:
'{"sharetablename_":"WINE_SHARE"}'

Procédure de suppression de partage de données

Cette fonction supprime le partage de données.

Syntaxe

Share.delete_share(name, owner)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez supprimer un objet de partage de données :
adp.Share.delete_share('share_py_api_7_1')

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

Renommer la procédure de partage de données

Cette fonction renomme le partage de données.

Syntaxe

Share.rename_share(name, new_name, owner)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • new_name : nouveau nom souhaité pour le partage de données. Ce champ est obligatoire.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez renommer un partage de données :
adp.Share.rename_share (name = 'share_py_api_7', new_name = 'share_py_api_7_1')

'{ "status": true }'

Procédure de publication du partage de données

Cette fonction publie le partage de données.

Syntaxe

Share.publish_share(name, owner)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez publier un partage de données :
adp.Share.publish_share(name='share_py_api_7_1')
//Output:
'{"publishShare":true}'

Annuler la publication du partage de données

Cette fonction publie le partage de données.

Syntaxe

Share.unpublish_share(name, owner)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez annuler la publication d'un partage de données :
adp.Share.unpublish_share(name ='share_py_api_7_1')

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

Obtenir la procédure de partage

Cette fonction reçoit les détails du partage de données.

Syntaxe

Share.get_share(name, owner)
Ses paramètres et descriptions sont les suivants :
  • name : nom du partage de données. Ce champ est obligatoire.
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez recevoir les détails de partage de données :
s = adp.Share.get_share(name = 'share_py_api_7_1')
json.loads(s)

//Output:
{'id': 40415,
 'name': 'SHARE_PY_API_7_1',
 'owner': 'ADMIN',
 'description': 'desc_share_py_api_7',
 'publicDescription': 'desc_share_py_api_7',
 'type': 'VERSIONED',
 'version': None,
 'tablesCount': 3,
 'recipientsCount': 0,
 'lastExportTime': None,
 'objects': [{'id': 40416,
   'schemaName': 'ADMIN',
   'objects': [{'id': 40435,
     'shareObjectName': 'WINE_SHARE',
     'objectName': 'WINE',
     'objectOwner': 'ADMIN',
     'objectType': 'TABLE'},
    {'id': 40417,
     'shareObjectName': 'IRIS_SHARE',
     'objectName': 'IRIS',
     'objectOwner': 'ADMIN',
     'objectType': 'TABLE'},
    {'id': 40418,
     'shareObjectName': 'DEMO_FOOD_SAMPLE_SHARE',
     'objectName': 'DEMO_FOOD_SAMPLE',
     'objectOwner': 'ADMIN',
     'objectType': 'TABLE'}]}],
 'recipients': None,
 'storageLinkName': 'food_cred',
 'schedule': {'enabled': 'FALSE',
  'startDate': None,
  'endDate': None,
  'repeatInterval': None}}

Procédure Get Shares

Cette fonction reçoit la liste Partage de données en fonction du propriétaire du partage de données.

Syntaxe

Share.get_shares(owner)
Ses paramètres et descriptions sont les suivants :
  • owner : Ce champ affiche le propriétaire du partage de données. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple
Dans cet exemple, vous pouvez recevoir la liste Partage de données :
s = adp.Share.get_shares()
json.loads(s)

//Output:
[{'id': 40415,
  'name': 'SHARE_PY_API_7_1',
  'owner': 'ADMIN',
  'description': 'desc_share_py_api_7',
  'type': 'VERSIONED',
  'tablesCount': 3,
  'version': None}]
Vous pouvez également consulter les rubriques qui couvrent les procédures répertoriées ci-dessous :

Rubrique parent : Utilisation de l'API Python Data Studio pour Autonomous Database