Funções de View Analítica

A classe Adp.Analytics fornece a sintaxe e as descrições das classes, métodos, atributos e parâmetros da interface de programação do aplicativo para a ferramenta Views Analíticas do Conjunto de ferramentas do Data Studio. Se a view analítica solicitada não existir (exceto criar), todas as funções retornarão a mensagem Analytic view does not exist.

Lista de Procedimento de Nomes de View Analítica

Retorna a lista de nomes de View Analítica.

Analytics.get_list(owner)

Parâmetros:

  • proprietário: Este campo exibe o proprietário do Link de Banco de Dados. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter a lista de Views 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"
      }
    },...
    ]
}

Criar o Procedimento de View Analítica

Crie a View Analítica com base na lista de tabelas de dimensão e na lista de medidas.

Sintaxe

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

Parâmetros:

  • fact_table: O nome da tabela de fatos.
  • dimensions é a lista de nomes de tabela de dimensões. Se a tabela de dimensões não tiver junções com nenhuma chave na tabela de fatos, o erro será gerado.
  • medidas: Este campo especifica a lista das colunas da tabela de fatos que serão usadas para agregação.
  • av_name: Este campo é um nome de View Analítica. Se esse parâmetro estiver ausente, use o nome de view analítica padrão com base no nome da tabela de fatos: "<fact_table>_AV".
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode criar a View Analítica com base em quatro dimensões e duas medidas:

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

Procedimento Create the Analytic View Automatically

Crie a View Analítica com base na tabela de fatos. As medidas são selecionadas automaticamente com base nas colunas da tabela de fatos. As dimensões são selecionadas em tabelas de dimensões adequadas.

A função usa o nome da view analítica padrão com base no nome da tabela de fatos: "<fact_table>_AV".

Sintaxe

Analytics.create_auto(fact_table, skip_dimensions,
                      owner)

Parâmetros:

  • fact_table: O nome da tabela de fatos.
  • skip_dimensions: Se o valor do campo for Verdadeiro, as colunas da tabela de fatos serão selecionadas como dimensões. O valor padrão é Falso.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode criar a View Analítica:
Analytics.create_auto('COSTS', False) // Output success

Excluir o Procedimento da view Analítica

Excluir a view Analítica com o nome especificado

Sintaxe

Analytics.drop(model_name, delete_objects)

Parâmetros:

  • model_name: O nome da View Analítica.
  • delete_objects: Se o valor do campo for Verdadeiro, todos os objetos relacionados (dimensões e medidas) serão eliminados. O valor padrão é Falso.

Exemplo

Neste exemplo, você pode eliminar a View Analítica:

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

Compilar o Procedimento de View Analítica

Compile a View Analítica. Ele otimiza a consulta para recuperar dados de forma eficiente das tabelas de fatos.

Sintaxe
Analytics.compile(av_name, owner)

Parâmetros:

  • av_name: O nome da View Analítica.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode compilar a View Analítica:

adp.Analytics.compile('COSTS_AV')

Obter Procedimento da Lista de Medidas

Obtenha a lista de medidas da View Analítica especificada.

Sintaxe

Analytics.get_measures_list(av_name, owner)

Parâmetros:

  • av_name: O nome da View Analítica.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter a lista de medidas da View 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"
      }
    },...
    ]
}

Obter Procedimento de Visualização

Retorna os metadados da View Analítica (hierarquias (nome e legenda) e medidas), dados agregados e consulta sql para selecionar dados da View Analítica.

Sintaxe

Analytics.get_data_preview(entity_name, owner)

Parâmetros:

  • entity_name: O nome da View Analítica.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter dados de visualização da View 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": "..."
}

Obter Procedimento de Metadados

Retorna metadados detalhados da View Analítica.

Sintaxe

Analytics.get_metadata(av_name, owner)

Parâmetros:

  • av_name: O nome da View Analítica.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Retorna metadados detalhados da View Analítica no esquema do proprietário (se estiver faltando ou definido como Nenhum, use o esquema atual).

Exemplo

Neste exemplo, você pode obter metadados da View Analítica:

adp.Analytics.get_metadata('COSTS_AV')

Procedimento de Nomes de Dimensão

Retorna o array de nomes de dimensão da View Analítica

Sintaxe

Analytics.get_dimension_names(av_name)

Parâmetros:

  • av_name: O nome da View Analítica.

Exemplo

Neste exemplo, você pode obter nomes de dimensão da View Analítica:

adp.Analytics.get_dimension_names('COSTS_AV')

Procedimento de Nome da Tabela de Fatos

Retorna o nome da tabela de fatos da View Analítica.

Sintaxe
Analytics.get_fact_table_name(av_name)

Parâmetros:

  • av_name: o nome da View Analítica.

Exemplo

Neste exemplo, você pode obter o nome da tabela de fatos da View Analítica:

adp.Analytics.get_fact_table_name('COSTS_AV')

Obter Classes de Erro do Procedimento de Dimensões

Retorna as informações sobre erros na dimensão especificada durante a análise da View Analítica. Este método é usado para verificar se a dimensão da View Analítica não tem erros. No caso de erro ERROR_COUNT não é 0 e errorData não está vazio e contém ERROR_MESSAGE (Representação de texto do erro), ERROR_NUMBER(código de erro Oracle).

Sintaxe

Analytics.get_error_classes_from_dim(av_name,
                      dimension)

Parâmetros:

  • av_name: o nome da View Analítica.
  • dimensão: nome da dimensão.

Exemplo

Neste exemplo, você pode obter o nome das classes de erro das dimensões da View Analítica:

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

Obter Classes de Erro do Procedimento da Tabela de Fatos

Retorna as informações sobre erros na tabela de fatos especificada durante a análise da View Analítica. Este método é usado para verificar se a tabela de fatos da View Analítica não tem erros. No caso do erro ERROR_COUNT não é 0, e errorData não está vazio e contém ERROR_MESSAGE (Representação de texto do erro) e ERROR_NUMBER (código de erro Oracle).

Sintaxe

Analytics.get_error_classes_from_fact_tab(av_name,
                      fact_tab)

Parâmetros:

  • av_name: O nome da View Analítica.
  • fact_table: O nome da tabela de fatos.

Exemplo

Neste exemplo, você pode obter classes de erro do nome da tabela de fatos da View Analítica:
adp.Analytics.get_error_classes_from_fact_tab('COSTS_AV', 'COSTS')

Retorna as informações sobre erros na tabela de fatos especificada durante a análise da View Analítica. Este método é usado para verificar se a tabela de fatos da View Analítica não tem erros. No caso de erro ERROR_COUNT não é 0, e errorData não está vazio, e contém ERROR_MESSAGE (Representação de texto do erro) e ERROR_NUMBER (código de erro Oracle).

Procedimento do relatório de qualidade

Retorna as informações sobre erros na view analítica especificada por av_name. Este método verifica a tabela de fatos e as dimensões da View Analítica. No caso de texto de erro, a representação dos erros é incluída no relatório.

Sintaxe

Analytics.quality_report(av_name)

Parâmetros:

  • av_name: O nome da View Analítica.

Exemplo

Neste exemplo, você pode obter o relatório de qualidade da View 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"
]

Obter Procedimento de Dados

Retorna os dados agregados da View Analítica. O valor de retorno é a lista de resultados da consulta.

Sintaxe

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

Parâmetros:

  • níveis: O nível da View Analítica.
  • column_names: A matriz de colunas.
  • entity_name: O nome da View Analítica.
  • hierarquias: A matriz de hierarquias selecionadas.
  • medidas: A matriz de medidas.
  • where_condition: é a matriz de condições, cada condição tem 4 campos: hierarquia, coluna, operador e valor.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter o relatório de qualidade da View 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},...},

Procedimento de Consulta SQL

Retornar Consulta SQL usada em get_data.

Sintaxe

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

Parâmetros:

  • níveis: O nível da View Analítica.
  • column_names: A matriz de colunas.
  • entity_name: O nome da View Analítica.
  • hierarquias: A matriz de hierarquias selecionadas.
  • medidas: A matriz de medidas.
  • where_condition: é a matriz de condições, cada condição tem 4 campos: hierarquia, coluna, operador e valor.
  • proprietário: Este campo exibe o proprietário da View Analítica. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode obter SQL para dados agregados da View 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')
    )
  )

Tópico principal: Como Trabalhar com a API do Python Data Studio para o Autonomous Database