その他の関数

その他の関数は、アプリケーション・プログラミング・インタフェースのクラス、メソッド、属性およびパラメータの構文と説明を提供します。

その他の関数は、アプリケーション・プログラミング・インタフェースのクラス、メソッド、属性およびパラメータの構文と説明を提供します。

表のリスト・プロシージャ

表のリストを返します。

構文

Misc.list_tables(owner)

パラメータ:

  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

この例では、表のリストを取得できます:
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"
      }
    },...
    ]
}
ビューのリスト・プロシージャ

ビューのリストを返します。

構文

Misc.list_views(owner)

パラメータ:

  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

この例では、ビューのリストを取得できます:

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"
      },...
    ]
}
表の削除プロシージャ

指定された表を削除します。

構文

Misc.drop_table(table_name)

パラメータ:

  • table_name: このフィールドは、削除する表の名前を示します。

この例では、表'TEST'を削除できます:

adp.Misc.drop_table('TEST')
ビューの削除プロシージャ

指定されたビューを削除します。

構文

Misc.drop_view(view_name)

パラメータ:

  • view_name: このフィールドは、削除するビューの名前を示します。

この例では、ビュー'VIEW_TEST'を削除できます:
adp.Misc.drop_view('VIEW_TEST')
表(複数)の削除プロシージャ

指定された表(複数)を削除します

構文

Misc.drop_tables(table_names)

パラメータ:

  • table_names: このフィールドは、削除する表の名前の配列を示します。

この例では、表'TEST'を削除できます:

dp.Misc.drop_tables(['TEST'])
ビュー(複数)の削除プロシージャ

指定されたビュー(複数)を削除します。

構文

Misc.drop_views(view_names)

パラメータ:

  • view_names: このフィールドは、削除するビューの名前の配列を示します。

この例では、ビュー'VIEW_TEST'を削除できます:

エンティティDDLの取得プロシージャ

エンティティ(TABLEまたはVIEW)を作成または置換するためのDDLを生成します

構文

Misc.get_entity_ddl(entity_type, entity_name,
                    owner)

パラメータ:

  • entity_type: このフィールドは、エンティティのタイプを示します。'TABLE'または'VIEW'のいずれかです。
  • entity_name: このフィールドは、エンティティの名前を示します。
  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

この例では、表'TEST'のDDLを表示できます:

adp.Misc.get_entity_ddl('TABLE', 'TEST')
問合せの実行プロシージャ

問合せの結果を返します。

構文

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

パラメータ:

  • statement: このフィールドは、実行するSQL文を示します
  • offset: このフィールドは、表示されるレコードに対するオフセットを示します。このフィールドがない場合、0 (ゼロ)がオフセットとして使用されます。
  • limit: このフィールドは、表示するレコードの最大数を示します。このフィールドがない場合、すべてのレコードが表示されます。
  • asof: 履歴データを表示するAS OF文。このフィールドがない場合、この機能は使用されません。

この例では、ビューを削除できます:

adp.Misc.run_query('DROP VIEW "VIEW_TEST"')
グローバル検索プロシージャ

Data Studioからデータベース、表および別のアーティファクトを検索した結果を返します。

構文

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

パラメータ:

  • search_string: 検索する文字列。"( owner: ADPTEST ) ( type: TABLE ) ( application: DATABASE )"の形式にする必要があります
  • rowstart: 検索の最初のインデックス
  • numrow: 返される行数
  • sortBy: ソートのリスト。例: [{column: "entity_name", direction: "asc"}]
  • hideSystemTables: このフィールドがない場合、システム表も検索する必要があります。
  • hidePrivateTables: このフィールドがない場合、システム表も検索する必要があります。
  • resultapp:
  • resultannotation:

この例では、ビューを削除できます:
adp.Misc.global_search('( owner: ADMIN ) ( type: TABLE ) ( application: DATABASE )', 1, 20001, [], TRUE, True, resultapp="ADPINS")
表の列の取得プロシージャ

表の列情報のリストが返されます

構文

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

パラメータ:

  • table_name: このフィールドは、表の名前を示します。
  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。
  • limit: 表示する列の最大数。デフォルト値は256です。
  • offset: 列のオフセット。デフォルト値は0です。

この例では、表'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
  }
]
表の制約の取得プロシージャ

この関数は、表の制約のリストを返します。

構文

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

パラメータ:

  • table_name: このフィールドは、表の名前を示します。
  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。
  • limit: 表示する列の最大数。デフォルト値は256です。
  • offset: 列のオフセット。デフォルト値は0です。

この例では、表'PERSONS'の制約を表示できます:

adp.Misc.get_table_constraints('PERSONS')
 
Output:
 
[
  {
    "constraint_name": "SYS_C0056209",
    "constraint_type": "Check",
    "search_condition": "\"PERSON_ID\" IS NOT NULL",
...
  }
]
行の挿入プロシージャ

この関数は、表に行を挿入します。

構文

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

パラメータ:

  • table_name: このフィールドは、表の名前を示します。
  • data: 形式{"data_column" : value,...}として、表に挿入する行の値。
  • mapping: data のデータ列名を表の列名とマップします。このフィールドがない場合、表の列名が使用されます。
  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

この例では、マッピングを使用せずに、またはマッピングを使用して、表'PERSONS'への行を挿入できます:

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

行の更新プロシージャ

この関数は、表内の既存の行を更新します。

構文

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

パラメータ:

  • table_name: このフィールドは、表の名前を示します。
  • data: 形式{"data_column" : value,...}として、表に挿入する行の値。
  • where_col: where句で使用される列の名前。この列の値は、dataに存在する必要があります
  • mapping: data のデータ列名を表の列名とマップします。このフィールドがない場合、表の列名が使用されます。
  • owner: このフィールドは、オブジェクトの所有者を示します。このフィールドがない場合、現在のスキーマ所有者が使用されます。

この例では、マッピングを使用せずに、またはマッピングを使用して、表'PERSONS'への行を挿入できます:

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