Funções diversas

Funções diversas fornecem a sintaxe e descrições das classes, métodos, atributos e parâmetros da interface de programação do aplicativo.

Funções diversas fornecem a sintaxe e descrições das classes, métodos, atributos e parâmetros da interface de programação do aplicativo.

Procedimento de Lista de Tabelas

Retornar lista de tabelas.

Sintaxe

Misc.list_tables(owner)

Parâmetros:

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

Exemplo

Neste exemplo, você pode obter uma lista de tabelas:
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"
      }
    },...
    ]
}
Procedimento de Lista de Views

Retornar lista de exibições.

Sintaxe

Misc.list_views(owner)

Parâmetros:

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

Exemplo

Neste exemplo, você pode obter a lista de views:

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"
      },...
    ]
}
Procedimento Eliminar Tabela

Elimine a tabela especificada.

Sintaxe

Misc.drop_table(table_name)

Parâmetros:

  • table_name: Este campo exibe o nome da tabela a ser eliminada.

Exemplo

Neste exemplo, você pode eliminar a tabela 'TEST':

adp.Misc.drop_table('TEST')
Procedimento de Exibição Eliminada

Elimine a view especificada.

Sintaxe

Misc.drop_view(view_name)

Parâmetros:

  • view_name: Este campo exibe o nome da view a ser eliminada.

Exemplo

Neste exemplo, você pode eliminar a view 'VIEW_TEST':
adp.Misc.drop_view('VIEW_TEST')
Procedimento Eliminar Tabelas

Eliminar as tabelas especificadas

Sintaxe

Misc.drop_tables(table_names)

Parâmetros:

  • table_names: Este campo exibe a matriz de nomes da tabela a ser eliminada.

Exemplo

Neste exemplo, você pode eliminar a tabela 'TEST':

dp.Misc.drop_tables(['TEST'])
Procedimento Eliminar Visualizações

Elimine as visualizações especificadas.

Sintaxe

Misc.drop_views(view_names)

Parâmetros:

  • view_names: Este campo exibe o array de nomes das views a serem eliminadas.

Exemplo

Neste exemplo, você pode eliminar as views 'VIEW_TEST':

Obter Procedimento DDL da Entidade

Gerar DDL para criar ou substituir entidade (TABLE ou VIEW)

Sintaxe

Misc.get_entity_ddl(entity_type, entity_name,
                    owner)

Parâmetros:

  • entity_type: Este campo exibe o tipo da entidade. Pode ser 'TABLE' ou 'VIEW'
  • entity_name: Este campo exibe o nome da entidade.
  • proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode exibir a DDL da tabela 'TEST':

adp.Misc.get_entity_ddl('TABLE', 'TEST')
Executar Procedimento de Consulta

Retornar os resultados da consulta.

Sintaxe

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

Parâmetros:

  • instrução: este campo exibe a instrução SQL a ser executada
  • deslocamento: Este campo exibe o deslocamento para o registro exibido. Se este campo estiver ausente, a ferramenta usará 0 como desvio.
  • limite: Este campo exibe o número máximo de registros a serem exibidos. Se este campo estiver ausente, a ferramenta exibirá todos os registros.
  • a partir de: instrução AS OF para exibir dados históricos. Se este campo estiver ausente, a ferramenta não usará este recurso.

Exemplo

Neste exemplo, você pode eliminar a view:

adp.Misc.run_query('DROP VIEW "VIEW_TEST"')
Procedimento de Pesquisa Global

Retorna o resultado da pesquisa de bancos de dados, tabelas e outros artefatos do Data Studio.

Sintaxe

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

Parâmetros:

  • search_string: string a ser pesquisada. Deve estar na forma "( proprietário: ADPTEST ) ( tipo: TABLE ) ( aplicação: DATABASE )
  • rowstart: primeiro índice de pesquisa
  • numrow: número de linhas retornadas
  • sortBy: lista de classificação, por exemplo, [{column: "entity_name", direction: "asc"}]
  • hideSystemTables: Se este campo estiver ausente, as tabelas do sistema também deverão ser pesquisadas.
  • hidePrivateTables: Se este campo estiver ausente, as tabelas do sistema também deverão ser pesquisadas.
  • aplicativo de resultados:
  • notação de resultado:

Exemplo

Neste exemplo, você pode eliminar a view:
adp.Misc.global_search('( owner: ADMIN ) ( type: TABLE ) ( application: DATABASE )', 1, 20001, [], TRUE, True, resultapp="ADPINS")
Procedimento Get Table Columns

Esta função retorna a lista de informações das colunas da tabela

Sintaxe

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

Parâmetros:

  • table_name: Este campo exibe o nome da tabela.
  • proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.
  • limite: O número máximo de colunas a serem exibidas. O valor padrão é 256.
  • deslocamento: a alternância das colunas. O valor padrão é 0.

Exemplo

Neste exemplo, você pode exibir colunas da tabela '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
  }
]
Obter Procedimento de Restrições da Tabela

Essa função retorna a lista de constraints da tabela.

Sintaxe

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

Parâmetros:

  • table_name: Este campo exibe o nome da tabela.
  • proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.
  • limite: O número máximo de colunas a serem exibidas. O valor padrão é 256.
  • deslocamento: a alternância das colunas. O valor padrão é 0.

Exemplo

Neste exemplo, você pode exibir restrições da tabela 'PERSONS':

adp.Misc.get_table_constraints('PERSONS')
 
Output:
 
[
  {
    "constraint_name": "SYS_C0056209",
    "constraint_type": "Check",
    "search_condition": "\"PERSON_ID\" IS NOT NULL",
...
  }
]
Procedimento Inserir Linha

A função insere uma linha na tabela

Sintaxe

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

Parâmetros:

  • table_name: Este campo exibe o nome da tabela.
  • data: valores da linha a ser inserida na tabela como um form {"data_column" : value,...}.
  • mapeamento: Mapeie nomes de coluna de dados em dados com nomes de coluna da tabela. Se este campo estiver ausente, a ferramenta usará nomes de coluna da tabela
  • proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode visualizar a inserção de uma linha na tabela 'PERSONS', sem mapeamento e usando mapeamento:

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"})

Atualizar Procedimento da Linha

A função atualiza a linha existente na tabela.

Sintaxe

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

Parâmetros:

  • table_name: Este campo exibe o nome da tabela.
  • data: valores da linha a ser inserida na tabela como um form {"data_column" : value,...}.
  • where_col: o nome da barra de coleta será usado na cláusula where. O valor desta coluna deve estar em dados
  • mapeamento: Mapeie nomes de coluna de dados em dados com nomes de coluna da tabela. Se este campo estiver ausente, a ferramenta usará nomes de coluna da tabela
  • proprietário: Este campo exibe o proprietário do objeto. Se este campo estiver ausente, a ferramenta usará o proprietário do esquema atual.

Exemplo

Neste exemplo, você pode visualizar a inserção de uma linha na tabela 'PERSONS', sem mapeamento e usando mapeamento:

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"})

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