数据湖 OpenLake：元数据API使用

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

• 操作：是指具体的权限点。

• 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

• 资源类型：是指操作中支持授权的资源类型。具体说明如下：

  • 对于必选的资源类型，用前面加 * 表示。

  • 对于不支持资源级授权的操作，用全部资源表示。

• 条件关键字：是指云产品自身定义的条件关键字。

• 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

返回值

示例

List<String> databases = restApi.listDatabases();

请求参数

返回值

示例

• 获取全部数据库列表

  int maxResults = 10;
  List<String> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<String> response = restApi.listDatabasesPaged(10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据数据库名称匹配分页获取数据库列表

  PagedList<String> pagedDatabases = restApi.listDatabasesPaged(10, null, "test_db%");

请求参数

返回值

异常说明

示例

Map<String, String> properties = new HashMap();
properties.put("k1", "v1");
api.createDatabase("db_demo", properties);

请求参数

返回值

异常说明

示例

 GetDatabaseResponse response = api.getDatabase(name);

请求参数

返回值

异常说明

示例

api.dropDatabase(name);

请求参数

返回值

异常说明

示例

List<String> removals = new ArrayList<>();
removals.add(“k1”)
Map<String, String> updates = new HashMap<>();
updates.put("k2", "v2")
api.alterDatabase(name, removals, updates);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
Schema schema =
            new Schema(
                    Lists.newArrayList(
                            new DataField(0, "pk", DataTypes.INT()),
                            new DataField(1, "col1", DataTypes.STRING()),
                            new DataField(2, "col2", DataTypes.STRING())),
                    Collections.emptyList(),
                    Collections.emptyList(),
                    Maps.newHashMap(),
                    "");
restApi.createTable(identifier, schema);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "new_table");
restApi.dropTable(identifier);

请求参数

返回值

异常说明

示例

Identifier fromIdentifier = Identifier.create("test_db", "old_table");
Identifier toIdentifier = Identifier.create("test_db", "new_table");
restApi.renameTable(fromIdentifier, toIdentifier);

请求参数

返回值

异常说明

示例

ArrayList<SchemaChange> schemaChanges = Lists.newArrayList(
                SchemaChange.addColumn("col2", DataTypes.DATE()),
                SchemaChange.addColumn("col3", DataTypes.STRING(), "col3 field"));
restApi.alterTable(
                identifier,
                schemaChanges);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
GetTableResponse response = restApi.getTable(identifier);

请求参数

返回值

异常说明

示例

String databaseName = "test_db";
List<String> tables = restApi.listTables(databaseName);

请求参数

返回值

异常说明

示例

• 获取全部表列表

  String databaseName = "db_test";
  int maxResults = 10;
  List<String> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<String> response = restApi.listTablesPaged(databaseName, 10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据表名称匹配分页获取表列表

  String databaseName = "test_db";
  PagedList<String> pagedTables = restApi.listTablesPaged(databaseName, 10, pageToken, "test_table%");

请求参数

返回值

异常说明

示例

• 获取全部表详情

  String databaseName = "test_db";
  int maxResults = 10;
  List<GetTableResponse> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<String> response = restApi.listTablesPaged(databaseName, 10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据表名称匹配分页获取表

  String databaseName = "test_db";
  PagedList<GetTableResponse> pagedTableDetails = restApi.listTablesPaged(databaseName, 10, pageToken, "test_table%");

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
restApi.loadSnapshot(identifier)

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
String version = "Latest";
restApi.loadSnapshot(identifier, version);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
int maxResults = 10;
List<Snapshot> results = new ArrayList<>();
Map<String, String> queryParams = Maps.newHashMap();
String pageToken = null;
do {
  PagedResponse<Snapshot> response = restApi.listSnapshotsPaged(identifier, maxResults, pageToken);
  pageToken = response.getNextPageToken();
  if (response.data() != null) {
    results.addAll(response.data());
  }
  if (pageToken == null || response.data() == null || response.data().isEmpty()) {
    break;
  }
} while (StringUtils.isNotEmpty(pageToken));

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
Instant instant = Instant.snapshot(snapshotId)
restApi.rollbackTo(identifier, instant);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "new_table");
restCatalog.createBranch(tableIdentifier, "test_branch", "tag_test");

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
restApi.dropBranch(identifier, "branch_test");

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
restApi.fastForward(identifier, "branch_test");

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "test_table");
List<String> branches = restApi.listBranches(identifier);

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "new_table");
List<Partition> tables = restApi.listPartitions(identifier);

请求参数

返回值

异常说明

示例

• 获取全部分区详情列表

  Identifier identifier = Identifier.create("test_db", "new_table");
  int maxResults = 10;
  List<String> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<Partition> response = restApi.listPartitionsPaged(identifier, 10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据分区名称匹配分页获取分区详情列表

  Identifier identifier = Identifier.create("test_db", "new_table");
  PagedList<Partition> pagedPartitions = restApi.listPartitionsPaged(identifier, 10, pageToken, "year=2025%");

请求参数

返回值

异常说明

示例

Identifier identifier = Identifier.create("test_db", "new_table");
List<Map<String, String>> partitions = new ArrayList<>();
LinkedHashMap<String, String> partition = new LinkedHashMap<>();
partition.put("year", "2025");
partition.put("month", "05");
restApi.markDonePartitions(identifier, partitions);

请求参数

返回值

异常说明

示例

 List<String> viewNames = api.listViews(name);

请求参数

返回值

异常说明

示例

• 获取全部表列表

  String databaseName = "db_test";
  int maxResults = 10;
  List<String> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<String> response = restApi.listViewsPaged(databaseName, 10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据表名称匹配分页获取表列表

  String databaseName = "test_db";
  PagedList<String> pagedViews = restApi.listViewsPaged(databaseName, 10, null, "test_v%");

请求参数

返回值

异常说明

示例

• 获取全部表列表

  String databaseName = "db_test";
  int maxResults = 10;
  List<GetViewResponse> results = new ArrayList<>();
  Map<String, String> queryParams = Maps.newHashMap();
  String pageToken = null;
  do {
    PagedResponse<GetViewResponse> response = restApi.listViewDetailsPaged(databaseName, 10, pageToken, null);
    pageToken = response.getNextPageToken();
    if (response.data() != null) {
      results.addAll(response.data());
    }
    if (pageToken == null || response.data() == null || response.data().isEmpty()) {
      break;
    }
  } while (StringUtils.isNotEmpty(pageToken));

• 根据表名称匹配分页获取表列表

  String databaseName = "test_db";
  PagedList<GetViewResponse> pagedViewDetails = restApi.listViewDetailsPaged(databaseName, 10, null, "test_v%");

请求参数

异常说明

示例

Identifier identifier = new Identifier(databaseName, "my_view");
RowType rowType = RowType.builder().field("str",DataTypes.STRING()).build();
String query = "SELECT * FROM OTHER_TABLE";
Map<String, String> option = new HashMap<>();
Map<String, String> dialects = new HashMap<>();
dialects.put("spark", "SELECT * FROM SPARK_TABLE");
ViewSchema schema =
        new ViewSchema(
                rowType.getFields(),
                query,
                dialects,
                "comment",
                option));
api.createView(identifier, schema);

请求参数

返回值

异常说明

示例

Identifier identifier = new Identifier(databaseName, "my_view");
GetViewResponse response = api.getView(identifier);

请求参数

返回值

异常说明

示例

Identifier identifier = new Identifier(databaseName, "my_view");
api.dropView(identifier);

请求参数

返回值

异常说明

示例

Identifier fromView = new Identifier(databaseName, "from_view");
Identifier toView = new Identifier(databaseName, "to_view");
api.renameView(fromView, toView);