其他函数

其他函数提供应用程序编程接口的类、方法、属性和参数的语法和说明。

其他函数提供应用程序编程接口的类、方法、属性和参数的语法和说明。

表列表过程

返回表列表。

语法

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 ：此字段显示要删除的视图的名称。

示例

在本例中，可以删除视图“视图 _ 测试”：
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 过程

生成 DDL 以创建或替换实体（TABLE 或 VIEW）

语法

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)

参数：

  • 语句：此字段显示要运行的 SQL 语句
  • offset ：此字段显示所显示记录的偏移量。如果缺少此字段，则工具使用 0 作为偏移量。
  • 限制：此字段显示要显示的最大记录数。如果缺少此字段，该工具将显示所有记录。
  • 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。
  • 偏移：列的偏移量。默认值为 0。

示例

在此示例中，可以查看表“人”的列：

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。
  • 偏移：列的偏移量。默认值为 0。

示例

在本例中，可以查看表“人”的约束条件：

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 ，...｝。
  • 映射：将数据中的数据列名与表的列名进行映射。如果缺少此字段，该工具将使用表的列名
  • 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 ：columnt 帽的名称将在 where 子句中使用。此列的值应位于 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"})

父主题：使用适用于 Autonomous Database 的 Python Data Studio API