Funciones de uso compartido de datos

La interfaz de programación de aplicaciones (API) de Python Data Studio para las funciones de Data Share proporciona la sintaxis y las descripciones de las clases, los métodos, los atributos y los parámetros de la interfaz de programación de aplicaciones para la herramienta Data Share del conjunto de herramientas de Data Studio.

Funciones de API de Data Share de Data Studio

La clase Adp.Share se utiliza para trabajar con recursos compartidos de datos. Esta clase contiene un conjunto de funciones de uso compartido de datos que permite gestionar los recursos compartidos de datos, los destinatarios, etc.

Requisitos

Primero debe crear una instancia de ADP.

Las funciones tienen un valor de retorno de cadena y parámetros de cadena.

Crear procedimiento de uso compartido

Esta función crea un recurso compartido de datos basado en la fecha de almacenamiento de objetos y los asocia a los destinatarios.

Sintaxis

Share.create_share(name, objects, storage_link_name, publish_job_details, owner, type,
      storage_link_owner, description)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • objetos: el diccionario de objetos de Data Share consta de los siguientes campos:
    • [{"schemaName" : "schemaNameValue", "objects": [{"objectName": "objectNameValue", "objectOwner": "objectOwnerValue", "shareObjectName" : "shareObjectNameValue"}, ...]}, ...]

    Este campo es obligatorio.

  • storage_link_name: este campo muestra el nombre del enlace de almacenamiento en la nube del recurso compartido de datos.
  • publish_job_details: este campo muestra el diccionario de detalles del trabajo de publicación de uso compartido de datos. Si falta este campo, se utiliza {"enabled": False}.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • type: tipo del recurso compartido de datos. Si falta este campo, la herramienta utiliza el campo VERSIONED.
  • storage_link_owner: propietario del enlace de almacenamiento en la nube de Data Share. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • descripción: este campo muestra la descripción del recurso compartido de datos. Si falta este campo, la herramienta utiliza una cadena vacía.

Ejemplo
En este ejemplo, puede crear un recurso compartido de datos:
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"}

Procedimiento de actualización de objetos de uso compartido de datos

Esta función actualiza los objetos de uso compartido de datos.

Sintaxis

Share.update_share_objects(name, objects, publish_job_details, owner,
    description)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • objetos: el diccionario de objetos de Data Share consta de los siguientes campos:
    • [{"schemaName" : "schemaNameValue", "objects": [{"objectName": "objectNameValue", "objectOwner": "objectOwnerValue", "shareObjectName" : "shareObjectNameValue"}, ...]}, ...]

    Este campo es obligatorio.

  • publish_job_details: este campo muestra el diccionario de detalles del trabajo de publicación de uso compartido de datos. Si falta este campo, se utiliza {"enabled": False}.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • descripción: este campo muestra la descripción del recurso compartido de datos. Si falta este campo, la herramienta utiliza una cadena vacía.

Ejemplo
En este ejemplo, puede actualizar un objeto de recurso compartido de datos:
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"}'

Suprimir procedimiento de uso compartido de datos

Esta función suprime el recurso compartido de datos.

Sintaxis

Share.delete_share(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede suprimir un objeto de recurso compartido de datos:
adp.Share.delete_share('share_py_api_7_1')

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

Cambiar nombre de procedimiento de uso compartido de datos

Esta función cambia el nombre del recurso compartido de datos.

Sintaxis

Share.rename_share(name, new_name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • new_name: el nuevo nombre que desea para el recurso compartido de datos. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede cambiar el nombre de un recurso compartido de datos:
adp.Share.rename_share (name = 'share_py_api_7', new_name = 'share_py_api_7_1')

'{ "status": true }'

Procedimiento de publicación de uso compartido de datos

Esta función publica el recurso compartido de datos.

Sintaxis

Share.publish_share(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede publicar un recurso compartido de datos:
adp.Share.publish_share(name='share_py_api_7_1')
//Output:
'{"publishShare":true}'

Anular publicación de recurso compartido de datos

Esta función publica el recurso compartido de datos.

Sintaxis

Share.unpublish_share(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede anular la publicación de un recurso compartido de datos:
adp.Share.unpublish_share(name ='share_py_api_7_1')

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

Obtener procedimiento de uso compartido

Esta función recibe los detalles del recurso compartido de datos.

Sintaxis

Share.get_share(name, owner)
A continuación se muestran sus parámetros y descripciones:
  • name: nombre del recurso compartido de datos. Este campo es obligatorio.
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede recibir los detalles del recurso compartido de datos:
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}}

Procedimiento de obtención de recursos compartidos

Esta función recibe la lista de uso compartido de datos según el propietario del recurso compartido de datos.

Sintaxis

Share.get_shares(owner)
A continuación se muestran sus parámetros y descripciones:
  • owner (Propietario): este campo muestra el propietario del recurso compartido de datos. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo
En este ejemplo, puede recibir la lista Uso compartido de datos:
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}]
También puede ver los temas que tratan los procedimientos que se enumeran a continuación:

Tema principal: Trabajo con la API de Python Data Studio para Autonomous Database