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);