Otras funciones

Otras funciones proporcionan la sintaxis y las descripciones de las clases, métodos, atributos y parámetros de la interfaz de programación de aplicaciones.

Otras funciones proporcionan la sintaxis y las descripciones de las clases, métodos, atributos y parámetros de la interfaz de programación de aplicaciones.

Procedimiento de lista de tablas

Devolver lista de tablas.

Sintaxis

Misc.list_tables(owner)

Parámetros:

  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener una lista de tablas:
adp.Misc.list_tables()
 
// Output
 
{
  "nodes": [
    {
 "label": "COSTS",
      "type": "TABLE",
      "id": "\"ADMIN\".\"DB\".\"COSTS\"",
      "data": {
        "name": "COSTS",
        "namespace": "DB",
        "path": "\"DB\".\"COSTS\"",
        "schema": "ADMIN",
        "annotation": {
          "numRows": 82112,
          "status": "VALID",
          "blocks": 370,
          "avgRowLen": 26,
          "partitioned": "NO",
          "external": "NO",
          "sharded": "N",
          "tablespace": "DATA",
          "hasSensitiveColumn": "NO",
          "compression": "DISABLED"
        },
        "application": "DATABASE",
        "created": "2021-06-09T09:16:49Z",
        "updated": "2021-06-09T09:16:49Z",
        "catalog": "LOCAL"
      }
    },...
    ]
}
Procedimiento de Lista de Vistas

Devolver lista de vistas.

Sintaxis

Misc.list_views(owner)

Parámetros:

  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener la lista de vistas:

adp.Misc.list_views()
 
// Output
{
  "nodes": [
   {
      "label": "COSTS_AVVIEW",
      "type": "VIEW",
      "id": "\"ADMIN\".\"DB\".\"COSTS_AVVIEW\"",
      "data": {
        "name": "COSTS_AVVIEW",
        "namespace": "DB",
        "path": "\"DB\".\"COSTS_AVVIEW\"",
        "schema": "ADMIN",
        "application": "DATABASE",
        "created": "2024-11-21T10:00:16Z",
        "updated": "2024-11-21T10:00:16Z",
        "catalog": "LOCAL"
      },...
    ]
}
Borrar procedimiento de tabla

Borre la tabla especificada.

Sintaxis

Misc.drop_table(table_name)

Parámetros:

  • table_name: este campo muestra el nombre de la tabla que se va a borrar.

Ejemplo

En este ejemplo, puede borrar la tabla 'TEST':

adp.Misc.drop_table('TEST')
Procedimiento de Borrado de Vista

Borre la vista especificada.

Sintaxis

Misc.drop_view(view_name)

Parámetros:

  • view_name: este campo muestra el nombre de la vista que se va a soltar.

Ejemplo

En este ejemplo, puede borrar la vista 'VIEW_TEST':
adp.Misc.drop_view('VIEW_TEST')
Procedimiento para Borrar Tablas

Borrar las tablas especificadas

Sintaxis

Misc.drop_tables(table_names)

Parámetros:

  • table_names: este campo muestra la matriz de nombres de la tabla que se va a borrar.

Ejemplo

En este ejemplo, puede borrar la tabla 'TEST':

dp.Misc.drop_tables(['TEST'])
Procedimiento de Borrado de Vistas

Borre las vistas especificadas.

Sintaxis

Misc.drop_views(view_names)

Parámetros:

  • view_names: este campo muestra la matriz de nombres de las vistas que se van a borrar.

Ejemplo

En este ejemplo, puede borrar las vistas 'VIEW_TEST':

Obtener procedimiento DDL de entidad

Generar DDL para crear o sustituir entidad (TABLE o VIEW)

Sintaxis

Misc.get_entity_ddl(entity_type, entity_name,
                    owner)

Parámetros:

  • entity_type: este campo muestra el tipo de entidad. Puede ser 'TABLE' o 'VIEW'
  • entity_name: este campo muestra el nombre de la entidad.
  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede ver el DDL de la tabla 'TEST':

adp.Misc.get_entity_ddl('TABLE', 'TEST')
Ejecutar procedimiento de consulta

Devolver los resultados de la consulta.

Sintaxis

Misc.run_query(statement, offset, limit, asof)

Parámetros:

  • sentencia: este campo muestra la sentencia SQL que se va a ejecutar
  • desplazamiento: este campo muestra el desplazamiento para el registro mostrado. Si falta este campo, la herramienta utiliza 0 como desviación.
  • límite: este campo muestra el número máximo de registros que se mostrarán. Si falta este campo, la herramienta muestra todos los registros.
  • a partir de: sentencia AS OF para mostrar datos históricos. Si falta este campo, la herramienta no utiliza esta función.

Ejemplo

En este ejemplo, puede borrar la vista:

adp.Misc.run_query('DROP VIEW "VIEW_TEST"')
Procedimiento de búsqueda global

Devuelve el resultado de la búsqueda de bases de datos, tablas y otros artefactos de Data Studio.

Sintaxis

Misc.global_search(search_string, rowstart, numrow, sortBy,
                          hide_system_tables, hide_private_tables, resultapp,
                          resultannotation)

Parámetros:

  • search_string: cadena que desea buscar. Debe tener el formato "( propietario: ADPTEST ) ( tipo: TABLE ) ( aplicación: DATABASE )
  • rowstart: primer índice de búsqueda
  • numrow: número de filas devueltas
  • sortBy: lista de ordenación, por ejemplo, [{column: "entity_name", direction: "asc"}]
  • hideSystemTables: si falta este campo, también se deben buscar las tablas del sistema.
  • hidePrivateTables: si falta este campo, también se deben buscar las tablas del sistema.
  • resultapp:
  • resultannotation (resultannotación):

Ejemplo

En este ejemplo, puede borrar la vista:
adp.Misc.global_search('( owner: ADMIN ) ( type: TABLE ) ( application: DATABASE )', 1, 20001, [], TRUE, True, resultapp="ADPINS")
Procedimiento Obtener columnas de tabla

Esta función devuelve la lista de la información de columnas de la tabla

Sintaxis

Misc.get_table_columns(table_name, owner, limit,
                      offset)

Parámetros:

  • table_name: este campo muestra el nombre de la tabla.
  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • limit: número máximo de columnas que se van a mostrar. El valor por defecto es 256.
  • desplazamiento: el desplazamiento de las columnas. El valor por defecto es 0.

Ejemplo

En este ejemplo, puede ver las columnas de la tabla 'PERSONS':

adp.Misc.get_table_columns('PERSONS')
 
Output:
[
  {
    "column_name": "PERSON_ID",
    "data_type": "NUMBER",
    "nullable": "No",
    "data_default": "\"ADMIN\".\"ISEQ$$_329201\".nextval",
    "column_id": 1,
    "comments": null
  },
  {
    "column_name": "FIRST_NAME",
    "data_type": "VARCHAR2(50 BYTE)",
    "nullable": "No",
    "data_default": null,
    "column_id": 2,
    "comments": null
  },
  {
    "column_name": "LAST_NAME",
    "data_type": "VARCHAR2(50 BYTE)",
    "nullable": "No",
    "data_default": null,
    "column_id": 3,
    "comments": null
  }
]
Obtener procedimiento de restricciones de tabla

Esta función devuelve la lista de restricciones de la tabla.

Sintaxis

Misc.get_table_constraints(table_name, owner, limit,
                      offset)

Parámetros:

  • table_name: este campo muestra el nombre de la tabla.
  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.
  • limit: número máximo de columnas que se van a mostrar. El valor por defecto es 256.
  • desplazamiento: el desplazamiento de las columnas. El valor por defecto es 0.

Ejemplo

En este ejemplo, puede ver las restricciones de la tabla 'PERSONS':

adp.Misc.get_table_constraints('PERSONS')
 
Output:
 
[
  {
    "constraint_name": "SYS_C0056209",
    "constraint_type": "Check",
    "search_condition": "\"PERSON_ID\" IS NOT NULL",
...
  }
]
Insertar procedimiento de fila

La función inserta una fila en la tabla

Sintaxis

Misc.insert_row(table_name, data, mapping, owner)

Parámetros:

  • table_name: este campo muestra el nombre de la tabla.
  • data: valores de la fila que se va a insertar en la tabla como formulario {"data_column" : value,...}.
  • asignación: asigne nombres de columna de datos en datos con nombres de columna de la tabla. Si falta este campo, la herramienta utiliza los nombres de columna de la tabla
  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede ver la inserción de una fila en la tabla 'PERSONS', sin asignar ni utilizar la asignación:

adp.Misc.insert_row('PERSONS', {"PERSON_ID":1, "FIRST_NAME":"John", "LAST_NAME":"Smith"})
adp.Misc.insert_row('PERSONS', {"ID":1, "FIRST":"John", "LAST":"Smith"}, {"ID":"PERSON_ID", "FIRST":"FIRST_NAME", "LAST":"LAST_NAME"})

Actualizar procedimiento de fila

La función actualiza la fila existente en la tabla.

Sintaxis

Misc.update_row(table_name, data,  where_col, mapping,
                        owner)

Parámetros:

  • table_name: este campo muestra el nombre de la tabla.
  • data: valores de la fila que se va a insertar en la tabla como formulario {"data_column" : value,...}.
  • where_col: el nombre de columnt hat se utilizará en la cláusula where. El valor de esta columna debe estar en datos
  • asignación: asigne nombres de columna de datos en datos con nombres de columna de la tabla. Si falta este campo, la herramienta utiliza los nombres de columna de la tabla
  • owner (Propietario): este campo muestra el propietario del objeto. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede ver la inserción de una fila en la tabla 'PERSONS', sin asignar ni utilizar la asignación:

adp.Misc.update_row('PERSONS', {"PERSON_ID":1, "FIRST_NAME":"Adam"},  'PERSON_ID')
adp.Misc.update_row('PERSONS', {"ID":1, "FIRST":"Adam"}, 'ID', {"ID":"PERSON_ID", "FIRST":"FIRST_NAME"})

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