雜項功能

其他函數則提供應用程式設計介面之類別、方法、屬性及參數的語法與描述。

其他函數則提供應用程式設計介面之類別、方法、屬性及參數的語法與描述。

表格清單程序

傳回表格清單。

語法

Misc.list_tables(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)

參數：

  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以取得檢視清單：

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 ：此欄位顯示實體的名稱。
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以檢視表格 'TEST' 的 DDL：

adp.Misc.get_entity_ddl('TABLE', 'TEST')
執行查詢程序

傳回查詢結果。

語法

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

參數：

  • 敘述句：此欄位顯示要執行的 SQL 敘述句
  • 偏移量：此欄位會顯示顯示記錄的偏移量。如果缺少此欄位，則工具會使用 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 :
  • 結果註釋：

範例

在此範例中，您可以刪除檢視：
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 ：此欄位會顯示表格的名稱。
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。
  • 限制：要顯示的資料欄數目上限。預設值為 256。
  • 偏移：欄的偏移。預設值為 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 ：此欄位會顯示表格的名稱。
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。
  • 限制：要顯示的資料欄數目上限。預設值為 256。
  • 位移：欄的位移。預設值為 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 ，...}。
  • 對應：將資料中的資料欄名稱對應至表格的資料欄名稱。如果缺少此欄位，則工具會使用表格的資料欄名稱
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以檢視插入資料列至表格 '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 子句中將使用 columnt hat 的名稱。此資料欄的值應位於 data 中
  • 對應：將資料中的資料欄名稱對應至表格的資料欄名稱。如果缺少此欄位，則工具會使用表格的資料欄名稱
  • 所有者：此欄位顯示物件的擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例

在此範例中，您可以檢視插入資料列至表格 '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"})

父項主題：使用 Python Data Studio API for Autonomous Database