Funzioni varie

Funzioni varie forniscono la sintassi e le descrizioni delle classi, dei metodi, degli attributi e dei parametri dell'interfaccia di programmazione dell'applicazione.

Funzioni varie forniscono la sintassi e le descrizioni delle classi, dei metodi, degli attributi e dei parametri dell'interfaccia di programmazione dell'applicazione.

Procedura elenco tabelle

Restituisce l'elenco delle tabelle.

Sintassi

Misc.list_tables(owner)

Parametri:

  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile ottenere l'elenco delle tabelle:
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"
      }
    },...
    ]
}
Procedura elenco di visualizzazioni

Restituisce l'elenco di viste.

Sintassi

Misc.list_views(owner)

Parametri:

  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile ottenere l'elenco delle viste:

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"
      },...
    ]
}
Procedura di eliminazione tabella

Eliminare la tabella specificata.

Sintassi

Misc.drop_table(table_name)

Parametri:

  • table_name: questo campo visualizza il nome della tabella da eliminare.

Esempio

In questo esempio è possibile eliminare la tabella 'TEST':

adp.Misc.drop_table('TEST')
Procedura di eliminazione vista

Eliminare la vista specificata.

Sintassi

Misc.drop_view(view_name)

Parametri:

  • view_name: questo campo visualizza il nome della vista da eliminare.

Esempio

In questo esempio è possibile eliminare la vista 'VIEW_TEST':
adp.Misc.drop_view('VIEW_TEST')
Procedura di eliminazione delle tabelle

Elimina le tabelle specificate

Sintassi

Misc.drop_tables(table_names)

Parametri:

  • table_names: questo campo visualizza l'array di nomi della tabella da eliminare.

Esempio

In questo esempio è possibile eliminare la tabella 'TEST':

dp.Misc.drop_tables(['TEST'])
Procedura eliminazione viste

Eliminare le viste specificate.

Sintassi

Misc.drop_views(view_names)

Parametri:

  • view_names: questo campo visualizza l'array di nomi delle viste da eliminare.

Esempio

In questo esempio è possibile rilasciare le viste 'VIEW_TEST':

Recupera procedura DDL entità

Genera DDL per la creazione o la sostituzione dell'entità (TABLE o VIEW)

Sintassi

Misc.get_entity_ddl(entity_type, entity_name,
                    owner)

Parametri:

  • entity_type: questo campo visualizza il tipo dell'entità. Può essere 'TABLE' o 'VIEW'
  • nome_entità: in questo campo viene visualizzato il nome dell'entità.
  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile visualizzare il DDL della tabella 'TEST':

adp.Misc.get_entity_ddl('TABLE', 'TEST')
Esegui procedura query

Restituisce i risultati della query.

Sintassi

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

Parametri:

  • Istruzione: questo campo visualizza l'istruzione SQL da eseguire
  • offset: questo campo visualizza l'offset rispetto al record visualizzato. Se manca questo campo, lo strumento utilizza 0 come offset.
  • limite: questo campo visualizza il numero massimo di record da visualizzare. Se manca questo campo, lo strumento visualizza tutti i record.
  • asof: istruzione AS OF per visualizzare i dati cronologici. Se manca questo campo, lo strumento non utilizza questa funzione.

Esempio

In questo esempio è possibile rilasciare la vista:

adp.Misc.run_query('DROP VIEW "VIEW_TEST"')
Procedura di ricerca globale

Restituisce il risultato della ricerca di database, tabelle e altri artifact da Data Studio.

Sintassi

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

Parametri:

  • search_string: stringa da cercare. Dovrebbe essere nella forma "( proprietario: ADPTEST ) ( tipo: TABLE ) ( applicazione: DATABASE )
  • rowstart: primo indice della ricerca
  • numrow: numero di righe restituite
  • sortBy: lista di ordinamento, ad esempio [{column: "entity_name", direzione: "asc"}]
  • hideSystemTables: se manca questo campo, è necessario cercare anche le tabelle di sistema.
  • hidePrivateTables: se manca questo campo, è necessario eseguire la ricerca anche nelle tabelle di sistema.
  • resultapp:
  • possibilità di ottenere:

Esempio

In questo esempio è possibile rilasciare la vista:
adp.Misc.global_search('( owner: ADMIN ) ( type: TABLE ) ( application: DATABASE )', 1, 20001, [], TRUE, True, resultapp="ADPINS")
Procedura di recupero colonne tabella

Questa funzione restituisce l'elenco delle informazioni sulle colonne della tabella

Sintassi

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

Parametri:

  • table_name: in questo campo viene visualizzato il nome della tabella.
  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.
  • limite: il numero massimo di colonne da visualizzare. Il valore predefinito è 256.
  • offset: l'offset delle colonne. Il valore predefinito è zero.

Esempio

In questo esempio è possibile visualizzare le colonne della tabella '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
  }
]
Procedura di recupero dei vincoli della tabella

Questa funzione restituisce l'elenco dei vincoli della tabella.

Sintassi

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

Parametri:

  • table_name: in questo campo viene visualizzato il nome della tabella.
  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.
  • limite: il numero massimo di colonne da visualizzare. Il valore predefinito è 256.
  • offset: l'offset delle colonne. Il valore predefinito è zero.

Esempio

In questo esempio è possibile visualizzare i vincoli della tabella 'PERSONS':

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

La funzione inserisce una riga nella tabella

Sintassi

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

Parametri:

  • table_name: in questo campo viene visualizzato il nome della tabella.
  • dati: valori della riga da inserire nella tabella come form {"data_column": valore,...}.
  • mapping: mappa i nomi delle colonne di dati in dati con i nomi delle colonne della tabella. Se manca questo campo, lo strumento utilizza i nomi di colonna della tabella
  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile visualizzare l'inserimento di una riga nella tabella 'PERSONS', senza mappare e utilizzando il mapping:

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

Aggiorna procedura riga

La funzione aggiorna la riga esistente nella tabella.

Sintassi

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

Parametri:

  • table_name: in questo campo viene visualizzato il nome della tabella.
  • dati: valori della riga da inserire nella tabella come form {"data_column": valore,...}.
  • where_col: il nome del cappello di colonna verrà utilizzato nella clausola where. Il valore di questa colonna deve essere in dati
  • mapping: mappa i nomi delle colonne di dati in dati con i nomi delle colonne della tabella. Se manca questo campo, lo strumento utilizza i nomi di colonna della tabella
  • Proprietario: questo campo visualizza il proprietario dell'oggetto. Se manca questo campo, lo strumento utilizza il proprietario dello schema corrente.

Esempio

In questo esempio è possibile visualizzare l'inserimento di una riga nella tabella 'PERSONS', senza mappare e utilizzando il mapping:

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