Fonctions diverses

Diverses fonctions fournissent la syntaxe et les descriptions des classes, méthodes, attributs et paramètres de l'interface de programmation d'application.

Diverses fonctions fournissent la syntaxe et les descriptions des classes, méthodes, attributs et paramètres de l'interface de programmation d'application.

Procédure de liste des tables

Renvoyer la liste des tables.

Syntaxe

Misc.list_tables(owner)

Paramètres:

  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez obtenir la liste des tables :
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"
      }
    },...
    ]
}
Procédure de liste de vues

Renvoyer la liste des vues.

Syntaxe

Misc.list_views(owner)

Paramètres:

  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez obtenir la liste des vues :

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"
      },...
    ]
}
Procédure de suppression de table

Supprimez la table indiquée.

Syntaxe

Misc.drop_table(table_name)

Paramètres:

  • table_name : ce champ affiche le nom de la table à supprimer.

Exemple

Dans cet exemple, vous pouvez supprimer la table 'TEST' :

adp.Misc.drop_table('TEST')
Procédure Drop View

Supprimez la vue indiquée.

Syntaxe

Misc.drop_view(view_name)

Paramètres:

  • view_name : Ce champ affiche le nom de la vue à supprimer.

Exemple

Dans cet exemple, vous pouvez supprimer la vue 'VIEW_TEST' :
adp.Misc.drop_view('VIEW_TEST')
Procédure de suppression de tables

Supprimer les tables indiquées

Syntaxe

Misc.drop_tables(table_names)

Paramètres:

  • table_names : ce champ affiche le tableau des noms de la table à supprimer.

Exemple

Dans cet exemple, vous pouvez supprimer la table 'TEST' :

dp.Misc.drop_tables(['TEST'])
Procédure de suppression de vues

Supprimez les vues spécifiées.

Syntaxe

Misc.drop_views(view_names)

Paramètres:

  • view_names : Ce champ affiche le tableau des noms des vues à supprimer.

Exemple

Dans cet exemple, vous pouvez supprimer des vues 'VIEW_TEST' :

Obtenir une procédure DDL d'entité

Générer du DDL pour la création ou le remplacement d'une entité (TABLE ou VIEW)

Syntaxe

Misc.get_entity_ddl(entity_type, entity_name,
                    owner)

Paramètres:

  • entity_type : ce champ affiche le type de l'entité. Il peut s'agir de "TABLE" ou de "VIEW"
  • nom_entité : ce champ affiche le nom de l'entité.
  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez afficher le code LDD de la table 'TEST' :

adp.Misc.get_entity_ddl('TABLE', 'TEST')
Exécuter la procédure de requête

Renvoyer les résultats de la requête.

Syntaxe

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

Paramètres:

  • instruction : ce champ affiche l'instruction SQL à exécuter
  • décalage : Ce champ affiche le décalage vers l'enregistrement affiché. Si ce champ est manquant, l'outil utilise 0 comme décalage.
  • limit : Ce champ affiche le nombre maximum d'enregistrements à afficher. Si ce champ est manquant, l'outil affiche tous les enregistrements.
  • asof : instruction AS OF pour afficher les données historiques. Si ce champ est manquant, l'outil n'utilise pas cette fonctionnalité.

Exemple

Dans cet exemple, vous pouvez supprimer la vue :

adp.Misc.run_query('DROP VIEW "VIEW_TEST"')
Procédure de recherche globale

Renvoie le résultat de la recherche de bases de données, de tables et d'autres artefacts à partir de Data Studio.

Syntaxe

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

Paramètres:

  • search_string : chaîne à rechercher. Il doit se présenter sous la forme "( propriétaire : ADPTEST ) ( type : TABLE ) ( application : DATABASE )
  • rowstart : premier index de recherche
  • numrow : nombre de lignes renvoyées
  • sortBy : liste de tri, par exemple [{column : "entity_name", direction : "asc"}]
  • hideSystemTables : si ce champ est manquant, la recherche des tables système doit également être effectuée.
  • hidePrivateTables : Si ce champ est manquant, la recherche doit également porter sur les tables système.
  • resultapp :
  • résultat :

Exemple

Dans cet exemple, vous pouvez supprimer la vue :
adp.Misc.global_search('( owner: ADMIN ) ( type: TABLE ) ( application: DATABASE )', 1, 20001, [], TRUE, True, resultapp="ADPINS")
Obtenir les colonnes de table - Procédure

Cette fonction renvoie la liste des informations de colonne de la table.

Syntaxe

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

Paramètres:

  • table_name : ce champ affiche le nom de la table.
  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
  • limit : nombre maximal de colonnes à afficher. La valeur par défaut est 256.
  • décalage : décalage des colonnes. La valeur par défaut est 0.

Exemple

Dans cet exemple, vous pouvez afficher les colonnes de la table '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
  }
]
Procédure d'obtention de contraintes de table

Cette fonction renvoie la liste des contraintes de la table.

Syntaxe

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

Paramètres:

  • table_name : ce champ affiche le nom de la table.
  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.
  • limit : nombre maximal de colonnes à afficher. La valeur par défaut est 256.
  • décalage : décalage des colonnes. La valeur par défaut est 0.

Exemple

Dans cet exemple, vous pouvez afficher les contraintes de la table 'PERSONS' :

adp.Misc.get_table_constraints('PERSONS')
 
Output:
 
[
  {
    "constraint_name": "SYS_C0056209",
    "constraint_type": "Check",
    "search_condition": "\"PERSON_ID\" IS NOT NULL",
...
  }
]
Procédure d'insertion de ligne

La fonction insère une ligne dans la table.

Syntaxe

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

Paramètres:

  • table_name : ce champ affiche le nom de la table.
  • data : valeurs de la ligne à insérer dans la table sous forme de {"data_column" : value,...}.
  • mapping : mappez les noms de colonne de données dans les données avec les noms de colonne de la table. Si ce champ est manquant, l'outil utilise les noms de colonne de la table
  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez afficher l'insertion d'une ligne dans la table "PERSONS", sans mappage ni mappage :

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

Procédure de mise à jour de ligne

La fonction met à jour la ligne existante dans la table.

Syntaxe

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

Paramètres:

  • table_name : ce champ affiche le nom de la table.
  • data : valeurs de la ligne à insérer dans la table sous forme de {"data_column" : value,...}.
  • where_col : le nom du chapeau de colonne sera utilisé dans la clause WHERE. La valeur de cette colonne doit être dans data
  • mapping : mappez les noms de colonne de données dans les données avec les noms de colonne de la table. Si ce champ est manquant, l'outil utilise les noms de colonne de la table
  • owner : Ce champ affiche le propriétaire de l'objet. Si ce champ est manquant, l'outil utilise le propriétaire de schéma actuel.

Exemple

Dans cet exemple, vous pouvez afficher l'insertion d'une ligne dans la table "PERSONS", sans mappage ni mappage :

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

Rubrique parent : Utilisation de l'API Python Data Studio pour Autonomous Database