Funciones de vista analítica

La clase Adp.Analytics 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 de vistas analíticas de Data Studio Suite de herramientas. Si la vista analítica solicitada no existe (excepto crear), todas las funciones devuelven el mensaje Analytic view does not exist.

Procedimiento de lista de nombres de vistas analíticas

Devuelve la lista de nombres de vistas analíticas.

Analytics.get_list(owner)

Parámetros:

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

Ejemplo

En este ejemplo, puede ver la lista de vistas analíticas:

Analytics.get_list()
 
{
  "nodes": [
    {
      "label": "ANALYTIC_VIEW1",
      "type": "ANALYTIC_VIEW",
      "id": "\"ADMIN\".\"DB\".\"ANALYTIC_VIEW1\"",
      "data": {
        "name": "ANALYTIC_VIEW1",
        "namespace": "DB",
        "path": "\"DB\".\"ANALYTIC_VIEW1\"",
        "schema": "ADMIN",
        "classifications": {
          "CAPTION": "Analytic View1",
          "DESCRIPTION": "Analytic View1"
        },
        "application": "DATABASE",
        "created": "2021-06-09T14:19:06Z",
        "updated": "2021-06-15T10:23:07Z"
      }
    },...
    ]
}

Crear el procedimiento de vista analítica

Cree la vista analítica basada en la lista de tablas de dimensiones y la lista de medidas.

Sintaxis

Analytics.create(fact_table, dimensions, measures, av_name,
                        owner)

Parámetros:

  • fact_table: nombre de la tabla de hechos.
  • dimensiones es la lista de nombres de tabla de dimensiones. Si la tabla de dimensiones no tiene uniones con ninguna clave de la tabla de hechos, devuelve el error.
  • medidas: este campo especifica la lista de las columnas de la tabla de hechos que se utilizarán para la agregación.
  • av_name: este campo es un nombre de vista analítica. Si falta este parámetro, utilice el nombre de vista analítica por defecto basado en el nombre de la tabla de hechos: "<fact_table>_AV".
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede crear la vista analítica basada en cuatro dimensiones y dos medidas:

tables = ["CHANNELS","PRODUCTS","PROMOTIONS","TIMES"]
measures = [ 'UNIT_COST', 'UNIT_PRICE']
adp.Analytics.create('COSTS', tables, measures)
 
// Output
 
success

Creación Automática de la Vista Analítica

Cree la vista analítica basada en la tabla de hechos. Las medidas se seleccionan automáticamente en función de las columnas de la tabla de hechos. Las dimensiones se seleccionan de las tablas de dimensiones adecuadas.

La función utiliza el nombre de vista analítica por defecto basado en el nombre de la tabla de hechos: "<fact_table>_AV".

Sintaxis

Analytics.create_auto(fact_table, skip_dimensions,
                      owner)

Parámetros:

  • fact_table: nombre de la tabla de hechos.
  • skip_dimensions: si el valor del campo es True, las columnas de la tabla de hechos se seleccionan como dimensiones. El valor por defecto es Falso.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede crear la vista analítica:
Analytics.create_auto('COSTS', False) // Output success

Supresión del procedimiento de vista analítica

Suprimir la vista analítica con el nombre especificado

Sintaxis

Analytics.drop(model_name, delete_objects)

Parámetros:

  • model_name: nombre de la vista analítica.
  • delete_objects: si el valor del campo es True, se borrarán todos los objetos relacionados (dimensiones y medidas). El valor por defecto es Falso.

Ejemplo

En este ejemplo, puede borrar la vista analítica:

adp.Analytics.drop('COSTS_AV', True)

Compilación del Procedimiento de Vista Analítica

Compile la vista analítica. Optimiza la consulta para recuperar de forma eficaz los datos de las tablas de hechos.

Sintaxis
Analytics.compile(av_name, owner)

Parámetros:

  • av_name: nombre de la vista analítica.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede compilar la vista analítica:

adp.Analytics.compile('COSTS_AV')

Obtener procedimiento de lista de medidas

Obtenga la lista de medidas de la vista analítica especificada.

Sintaxis

Analytics.get_measures_list(av_name, owner)

Parámetros:

  • av_name: nombre de la vista analítica.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener la lista de medidas de la vista analítica:

adp.Analytics.get_measures_list('COSTS_AV')
 
// Output
 
{
  "nodes": [
    {
      "label": "UNIT_COST",
      "type": "MEASURE",
      "id": "\"ADMIN\".\"DB\".\"COSTS_AV\".\"MEASURE\".\"UNIT_COST\"",
      "data": {
        "name": "UNIT_COST",
        "namespace": "MEASURE",
        "path": "\"DB\".\"COSTS_AV\".\"MEASURE\".\"UNIT_COST\"",
        "schema": "ADMIN",
        "application": "DATABASE",
        "created": "2022-08-16T17:04:08Z",
        "updated": "2022-08-16T17:04:08Z"
      }
    },...
    ]
}

Obtener procedimiento de vista previa

Devuelve los metadatos de la vista analítica (jerarquías (nombre y título) y medidas), los datos agregados y la consulta SQL para seleccionar datos de la vista analítica.

Sintaxis

Analytics.get_data_preview(entity_name, owner)

Parámetros:

  • entity_name: nombre de la vista analítica.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener datos de vista previa de la vista analítica:

adp.Analytics.get_data_preview('COSTS_AV')
 
// Output
 
{
  "av": "COSTS_AV",
  "caption": null,
  "description": null,
  "metadata": {
    "hierarchies": [
      {
        "name": "CHANNEL_ID",
        "caption": "CHANNEL_ID"
      },
      {
        "name": "PROD_ID",
        "caption": "PROD_ID"
      }
    ],
    "measures": [
      {
        "name": "UNIT_COST",
        "caption": "UNIT_COST"
      },
      {
        "name": "UNIT_PRICE",
        "caption": "UNIT_PRICE"
      }
    ]
  },
  "data": [...],
  "SQL": "..."
}

Obtener procedimiento de metadatos

Devolver metadatos detallados de la vista analítica.

Sintaxis

Analytics.get_metadata(av_name, owner)

Parámetros:

  • av_name: nombre de la vista analítica.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Devolver metadatos detallados de la vista analítica en el esquema del propietario (si falta o se define en Ninguno, utilice el esquema actual).

Ejemplo

En este ejemplo, puede obtener metadatos de la vista analítica:

adp.Analytics.get_metadata('COSTS_AV')

Procedimiento de nombres de dimensión

Devuelve la matriz de nombres de dimensión de la vista analítica

Sintaxis

Analytics.get_dimension_names(av_name)

Parámetros:

  • av_name: nombre de la vista analítica.

Ejemplo

En este ejemplo, puede obtener los nombres de dimensión de la vista analítica:

adp.Analytics.get_dimension_names('COSTS_AV')

Procedimiento de Nombre de Tabla de Hecho

Devuelve el nombre de la tabla de hechos de la vista analítica.

Sintaxis
Analytics.get_fact_table_name(av_name)

Parámetros:

  • av_name: nombre de la vista analítica.

Ejemplo

En este ejemplo, puede obtener el nombre de la tabla de hechos de la vista analítica:

adp.Analytics.get_fact_table_name('COSTS_AV')

Procedimiento para obtener clases de error de dimensiones

Devuelve la información sobre los errores en la dimensión especificada durante el análisis de la vista analítica. Este método se utiliza para comprobar que la dimensión de la vista analítica no tiene errores. En caso de error, ERROR_COUNT no es 0 y errorData no está vacío y contiene ERROR_MESSAGE (representación de texto del error), ERROR_NUMBER (código de error de Oracle).

Sintaxis

Analytics.get_error_classes_from_dim(av_name,
                      dimension)

Parámetros:

  • av_name: nombre de la vista analítica.
  • dimensión: nombre de dimensión.

Ejemplo

En este ejemplo, puede obtener el nombre de las clases de error de las dimensiones de la vista analítica:

adp.Analytics.get_error_classes_from_dim('COSTS_AV', 'CHANNELS')

Obtener clases de error de procedimiento de tabla de hechos

Devolver la información sobre los errores en la tabla de hechos especificada durante el análisis de la vista analítica. Este método se utiliza para comprobar que la tabla de hechos de la vista analítica no tiene errores. En el caso del error, ERROR_COUNT no es 0 y errorData no está vacío y contiene ERROR_MESSAGE (representación de texto del error) y ERROR_NUMBER (código de error de Oracle).

Sintaxis

Analytics.get_error_classes_from_fact_tab(av_name,
                      fact_tab)

Parámetros:

  • av_name: nombre de la vista analítica.
  • fact_table: nombre de la tabla de hechos.

Ejemplo

En este ejemplo, puede obtener clases de error del nombre de la tabla de hechos de la vista analítica:
adp.Analytics.get_error_classes_from_fact_tab('COSTS_AV', 'COSTS')

Devolver la información sobre los errores en la tabla de hechos especificada durante el análisis de la vista analítica. Este método se utiliza para comprobar que la tabla de hechos de la vista analítica no tiene errores. En el caso del error, ERROR_COUNT no es 0 y errorData no está vacío y contiene ERROR_MESSAGE (representación de texto del error) y ERROR_NUMBER (código de error de Oracle).

Procedimiento de informe de calidad

Devuelve la información sobre los errores en la vista analítica especificada por av_name. Este método comprueba la tabla de hechos y las dimensiones de la vista analítica. En caso de error, la representación de texto de los errores se incluye en el informe.

Sintaxis

Analytics.quality_report(av_name)

Parámetros:

  • av_name: nombre de la vista analítica.

Ejemplo

En este ejemplo, puede obtener un informe de calidad de la vista analítica:

adp.Analytics.quality_report('COSTS_AV')
 
// Output
 
[
    "Fact table COSTS has no errors",
    "Dimension COSTS_AV_CHANNELS_AD has no errors",
    "Dimension COSTS_AV_PRODUCTS_AD has no errors",
    "Dimension COSTS_AV_PROMOTIONS_AD has no errors",
    "Dimension COSTS_AV_TIMES_AD has no errors"
]

Obtener procedimiento de datos

Devuelve los datos agregados de la vista analítica. El valor devuelto es la lista de resultados de la consulta.

Sintaxis

Analytics.get_data(levels, column_names, entity_name, hierarchies,
                          measures, where_condition, owner)

Parámetros:

  • niveles: nivel de la vista analítica.
  • column_names: matriz de columnas.
  • entity_name: nombre de la vista analítica.
  • jerarquías: matriz de jerarquías seleccionadas.
  • medidas: matriz de medidas.
  • where_condition: es la matriz de condiciones, cada condición tiene 4 campos: hierarchy, column, operator y value.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener un informe de calidad de la vista analítica:

adp.Analytics.get_data(True,
    ["COSTS_AV_PROD_HIER_PROD_ID_ATTR",
     "UNIT_COST",
     "COSTS_AV_PROD_HIER_DEPTH"], 'COSTS_AV',
     ["COSTS_AV_PROD_ID_HIER"],
     ["UNIT_COST", "UNIT_PRICE"],
    [{"hierarchy": "COSTS_AV_PROD_ID_HIER", "column": "LEVEL_NAME", "operator": "=", "value": "ALL:PROD_ID"}])
 
//Output
 
[{"UNIT_COST":808685.68},{"UNIT_COST":213170.06},{"UNIT_COST":16778.02},...},

Procedimiento de Consulta SQL

Devuelve la consulta SQL que se utiliza en get_data.

Sintaxis

Analytics.get_sql(levels, column_names, entity_name, hierarchies,
                          measures, where_condition, owner)

Parámetros:

  • niveles: nivel de la vista analítica.
  • column_names: matriz de columnas.
  • entity_name: nombre de la vista analítica.
  • jerarquías: matriz de jerarquías seleccionadas.
  • medidas: matriz de medidas.
  • where_condition: es la matriz de condiciones, cada condición tiene 4 campos: hierarchy, column, operator y value.
  • owner (Propietario): este campo muestra el propietario de la vista analítica. Si falta este campo, la herramienta utiliza el propietario del esquema actual.

Ejemplo

En este ejemplo, puede obtener SQL para los datos agregados de la vista analítica:

adp.Analytics.get_sql(True,
    ["COSTS_AV_PROD_HIER_PROD_ID_ATTR",
     "UNIT_COST",
     "COSTS_AV_PROD_HIER_DEPTH"], 'COSTS_AV',
     ["COSTS_AV_PROD_ID_HIER"],
     ["UNIT_COST", "UNIT_PRICE"],
    [{"hierarchy": "COSTS_AV_PROD_ID_HIER", "column": "LEVEL_NAME", "operator": "=", "value": "ALL:PROD_ID"})
 
//Output
 
SELECT
  "MEASURES"."UNIT_COST" AS "UNIT_COST"
FROM "ADMIN"."COSTS_AV" HIERARCHIES(
    "PROD_ID"."PROD_ID")
WHERE
  (
    (
      "PROD_ID"."PROD_ID"."LEVEL_NAME" IN ('ALL', 'PROD_ID')
    )
  )

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