Data Lake Formation:CLI リファレンス

get - ロールの取得

ロールプリンシパルによって指定されたロールの詳細を取得します。

使用法

./dlf-cli/bin/dlf role get \
--role_principal <role_principal>

パラメーター

例

./dlf-cli/bin/dlf role get \
--role_principal 'acs:dlf::104568******:role/engineer' 

応答：

2025-07-07 17:12:02 : {
  "createdAt" : 1749435901626,
  "createdBy" : "xxxx",
  "description" : null,
  "displayName" : null,
  "isPredefined" : "false",
  "roleName" : "engineer",
  "rolePrincipal" : "xxxx",
  "updatedAt" : 1750404792198,
  "updatedBy" : "xxxx",
  "users" : [ {
    "createdAt" : 1744428101252,
    "createdBy" : "",
    "displayName" : "xxxx",
    "type" : "RAM_USER",
    "updatedAt" : 1744428101252,
    "updatedBy" : "",
    "userId" : "xxxx",
    "userName" : "xxxx",
    "userPrincipal" : "xxxx"
  }]
}

ロールの作成

新しいロールを作成します。ロール名、表示名、説明を指定できます。

概要

./dlf-cli/bin/dlf role create \
--role_name <role_name> \
--display_name <display_name> \
[--description <description>]

パラメーター

例

./dlf-cli/bin/dlf role create \
--role_name 'test_viewer' \
--display_name 'test viewer' \
--description 'test for viewer'

出力

2025-07-07 17:14:30 : success

alter - ロールの更新

指定されたロールの表示名または説明を更新します。

概要

./dlf-cli/bin/dlf role alter \
--role_principal <role_principal> \
--display_name <display_name> \
[--description <description>] 

パラメーター

例

./dlf-cli/bin/dlf role alter \
--role_principal 'acs:dlf::104568******:role/engineer' \
--display_name 'engineer role'

出力

2025-07-08 10:00:54 : success

drop - ロールの削除

指定されたロールを削除します。

使用法

./dlf-cli/bin/dlf role drop \
--role_principal <role_principal>

パラメーター

例

./dlf-cli/bin/dlf role drop \
--role_principal 'acs:dlf::104568******:role/test_viewer'

出力

2025-07-08 10:00:54 : success

list_users - ロールに関連付けられたユーザーのリスト

指定されたロールに関連付けられたユーザーのページ分割されたリストを取得します。

使用法

./dlf-cli/bin/dlf role list_users \
--role_principal <role_principal> \
[--max_results <max_results>] \
[--page_token <page_token>] 

パラメーター

例

./dlf-cli/bin/dlf role list_users \
--role_principal 'acs:dlf::1045689747920334:role/engineer'

出力

2025-07-08 09:59:58 : {
  "nextPageToken" : null,
  "users" : [ {
    "createdAt" : 1744428101252,
    "createdBy" : "",
    "displayName" : "dw_test",
    "type" : "RAM_USER",
    "updatedAt" : 1744428101252,
    "updatedBy" : "",
    "userId" : "205775142194523069",
    "userName" : "dw_test",
    "userPrincipal" : "acs:ram::1045689747920334:user/dw_test"
  } ]
}

ユーザーにロールを付与する

1 人以上のユーザーにロールを付与します。

概要

./dlf-cli/bin/dlf role grant_users \
--role_principal <role_principal> \
--user_principals <user_principals>

パラメーター

例

./dlf-cli/bin/dlf role grant_users \
--role_principal 'acs:dlf::1045689747920334:role/engineer' \
--user_principals '["acs:ram::104568******:user/starrocks_test"]'

出力

2025-07-08 10:00:54 : success

ロールからユーザーを除外する

指定されたユーザーとロールの関連付けを解除します。

使用法

./dlf-cli/bin/dlf role revoke_users \
--role_principal <role_principal> \
--user_principals <user_principals>

パラメーター

例

./dlf-cli/bin/dlf role revoke_users \
--role_principal 'acs:dlf::1045689747920334:role/engineer' \
--user_principals '["acs:ram::1045689747920334:user/starrocks_test"]'

出力

2025-07-08 10:14:37 : success

リスト

ユーザーをリストアップします。ユーザー名やユーザータイプなどの基準に基づいてリストをフィルターできます。このコマンドはページネーションをサポートします。

概要

./dlf-cli/bin/dlf user list \
[--user_name <user_name>] \
[--user_type <user_type>] \
[--max_results <max_results>] \
[--page_token <page_token>] 

パラメーター

例

./dlf-cli/bin/dlf user list \
--user_name 'starrocks_test' \
--user_type 'RAM_USER'

出力

2025-07-08 10:24:00 : {
  "nextPageToken" : null,
  "users" : [ {
    "createdAt" : 1744428101252,
    "createdBy" : "",
    "displayName" : "starrocks_test",
    "type" : "RAM_USER",
    "updatedAt" : 1744428101252,
    "updatedBy" : "",
    "userId" : "xxxxx",
    "userName" : "starrocks_test",
    "userPrincipal" : "acs:ram::104568******:user/starrocks_test"
  } ]
}

list_role

指定されたユーザーに関連付けられているロールをリストアップします。

概要

./dlf-cli/bin/dlf user list_role \
--user_principal <user_principal> \
[--max_results <max_results>] \
[--page_token <page_token>] 

パラメーター

例

./dlf-cli/bin/dlf user list_role \
--user_principal 'acs:ram::104568******:user/starrocks_test'

出力

2025-07-15 13:18:45 : {
  "nextPageToken" : null,
  "roles" : [{
    "createdAt" : 1749435901626,
    "createdBy" : "acs:ram::104568******:root",
    "description" : null,
    "displayName" : "enginer role",
    "isPredefined" : "false",
    "roleName" : "engineer",
    "rolePrincipal" : "acs:dlf::104568******:role/engineer",
    "updatedAt" : 1751960724469,
    "updatedBy" : "acs:ram::104568******:root",
    "users" : null
  }]
}

list - 権限のリスト

指定されたリソースタイプの権限をリストアップします。リソースタイプ (例： catalog、database、または table) やその他の条件で結果をフィルターできます。このコマンドはページネーションもサポートします。

概要

./dlf-cli/bin/dlf permission list \
--catalog <catalogName>  \
--resource_type <resource_type> \
[--database <database>] \
[--table <table>] \
[--principal <principal>] \
[--max_results <max_results>] \
[--page_token <page_token>] 

パラメーター

例

./dlf-cli/bin/dlf permission list \
--catalog test_paimon \
--resource_type database \
--database default

出力

2025-07-08 10:51:31 : {
  "nextPageToken" : null,
  "permissions" : [ {
    "access" : "ALTER",
    "columns" : null,
    "database" : "default",
    "function" : null,
    "principal" : "acs:ram::104568******:user/bennett-test",
    "resourceType" : "DATABASE",
    "table" : null,
    "view" : null
  }, {
    "access" : "SELECT",
    "columns" : null,
    "database" : "default",
    "function" : null,
    "principal" : "acs:ram::104568******:user/bennett-test",
    "resourceType" : "DATABASE_ALL",
    "table" : null,
    "view" : null
  } ]
}

grant - 権限の付与

指定されたプリンシパル (ユーザーまたはロール) に権限を付与します。

概要

./dlf-cli/bin/dlf permission grant \
--catalog <catalogName>  \
--permissions '<json_array>'

パラメーター

例

./dlf-cli/bin/dlf permission grant \
--catalog test_paimon  \
--permissions '[{"access" : "SELECT", "database" : "default", "principal" : "acs:ram::104568******:user/starrocks_test", "resourceType" : "DATABASE"}]'

出力

2025-07-08 10:53:41 : 成功

revoke - 権限の取り消し

指定されたプリンシパル (ユーザーまたはロール) からリソース権限を取り消します。

概要

./dlf-cli/bin/dlf permission revoke \
--catalog <catalogName>  \
--permissions '<json_array>'

パラメーター

例

./dlf-cli/bin/dlf permission revoke \
--catalog test_paimon  \
--permissions '[{"access" : "SELECT", "database" : "default", "principal" : "acs:ram::104568******:user/starrocks_test", "resourceType" : "DATABASE"}]'

出力

2025-07-08 10:53:41 : success

help - サポートされているカタログコマンドの一覧表示

./dlf-cli/bin/dlf catalog help

list - カタログの一覧表示

すべてのカタログを一覧表示します。ページネーションがサポートされています。

使用法

./dlf-cli/bin/dlf catalog list \
[--max_results <max_results>] \
[--page_token <page_token>]

パラメーター

例

./dlf-cli/bin/dlf catalog list

応答

2025-07-07 17:24:47 : {
  "catalogs" : [ {
    "createdAt" : 1748335426553,
    "createdBy" : "xxxx",
    "id" : "xxxxx",
    "name" : "xxxx",
    "options" : {
      "storage.data.redundancy.type" : "LRS",
      "comment" : "xxxx"
    },
    "owner" : "xxxx",
    "status" : "RUNNING",
    "type" : "PAIMON",
    "updatedAt" : 1748350097424,
    "updatedBy" : "xxxx"
  }, {
    "createdAt" : 1747885240095,
    "createdBy" : "xxxx",
    "id" : "xxxx",
    "name" : "xxxx",
    "options" : {
      "catalog.data.token.minExpireSeconds" : "43200",
      "storage.data.redundancy.type" : "LRS",
      "comment" : "xxxx",
      "catalog.data.token.isTable" : "true",
      "catalog.data.token.maxExpireSeconds" : "43200"
    },
    "owner" : "xxxx",
    "status" : "RUNNING",
    "type" : "PAIMON",
    "updatedAt" : 1751846858724,
    "updatedBy" : "acs:ram::104568******:root"
  } ],
  "nextPageToken" : null
}

get - カタログ詳細の取得

指定されたカタログの詳細を取得します。

使用方法

./dlf-cli/bin/dlf catalog get \
--catalog <catalog name>

パラメーター

例

./dlf-cli/bin/dlf catalog get \
--catalog test_paimon

レスポンス

2025-07-08 10:56:51 : {
  "createdAt" : 1747982344641,
  "createdBy" : "acs:ram::104568******:root",
  "id" : "clg-paimon-802dcc2xxxxx",
  "name" : "test_paimon",
  "options" : {
    "storage.data.redundancy.type" : "LRS",
    "comment" : ""
  },
  "owner" : "acs:ram::104568******:root",
  "status" : "RUNNING",
  "type" : "PAIMON",
  "updatedAt" : 1747982348385,
  "updatedBy" : "acs:ram::104568******:root"
}

create - カタログの作成

指定された名前とオプションで新しいカタログを作成します。

使用法

./dlf-cli/bin/dlf catalog create \
--catalog <catalog name> \
--options '{}'

パラメーター

例

./dlf-cli/bin/dlf catalog create \
--catalog test-cli \
--options '{"comment": "test"}'

レスポンス

2025-07-07 17:45:04 : success

alter - カタログの更新

指定されたカタログのプロパティを更新します。

使用法

./dlf-cli/bin/dlf catalog alter \
--catalog <catalog name> \
--removals '[]' \
--updates '{}'

パラメーター

例

./dlf-cli/bin/dlf catalog alter \
--catalog test-cli \
--removals '[]' \
--updates '{"comment": "new comment", "k1": "v1"}'

レスポンス

2025-07-07 17:45:04 : success

drop - カタログの削除

drop 操作が失敗しないようにするには、次の条件を満たす必要があります：

• カタログ内のすべてのテーブルとユーザー作成のデータベースが削除されていること。

• テーブルとデータベースが削除されてから 24 時間以上経過していること。

使用法

./dlf-cli/bin/dlf catalog drop \
--catalog <catalog name>

パラメーター

例

./dlf-cli/bin/dlf catalog drop \
--catalog test-cli

レスポンス

2025-07-07 17:45:04 : success

get_token - 一時的なアクセス認証情報の取得

指定されたカタログの一時的なアクセス認証情報を取得します。

使用方法

./dlf-cli/bin/dlf catalog get_token \
--catalog <catalog name>

パラメーター

例

./dlf-cli/bin/dlf catalog get_token \
--catalog test_paimon

レスポンス

2025-08-18 16:58:38 : {
  "expiresAtMillis" : 1755550718000,
  "token" : {
    "fs.oss.accessKeyId" : "STS.xxx",
    "fs.oss.accessKeySecret" : "xxx",
    "fs.oss.securityToken" : "xxx",
    "fs.oss.endpoint" : "xxx",
    "fs.oss.bucket.name" : "clg-paimon-xxx"
  }
}

help：データベースコマンドの一覧

./dlf-cli/bin/dlf database help

list - データベースのリスト

指定されたカタログ内のデータベース名をリストアップします。このコマンドはページネーションをサポートしています。

概要

./dlf-cli/bin/dlf database list \
--catalog [catalogName] \
[--max_results <max_results>] \
[--page_token <page_token>]

パラメーター

例

./dlf-cli/bin/dlf database list \
--catalog test-cli

出力

2025-07-08 10:59:26 : {
  "elements" : [ "default", "system", "test_db" ],
  "nextPageToken" : null
}

get - データベース詳細の取得

指定されたデータベースの詳細を取得します。

概要

./dlf-cli/bin/dlf database get \
--full_name <catalogName.databaseName>

パラメーター

例

./dlf-cli/bin/dlf database get \
--full_name test-cli.default

出力

2025-07-08 11:03:51 : {
  "id" : "db-9605ccda-cf07-4a74-a137-3c166590177e",
  "name" : "default",
  "location" : "oss://clg-paimon-b1af75fab07c4dfb9c0e2205a41740c6/db-9605ccda-cf07-4a74-a137-3c166590177e.db",
  "options" : { },
  "owner" : "acs:ram::1045689747920334:root",
  "createdAt" : 1751882013752,
  "createdBy" : "acs:ram::1045689747920334:root",
  "updatedAt" : 1751882013752,
  "updatedBy" : "acs:ram::1045689747920334:root"
}

create - データベースの作成

データベースを作成します。

概要

./dlf-cli/bin/dlf database create \
--full_name <catalogName.databaseName> \
--options <options>

パラメーター

例

./dlf-cli/bin/dlf database create \
--full_name test-cli.test_db \
--options '{"k1":"v1","k2":"v2"}'

出力

2025-07-08 11:07:34 : success

alter - データベースプロパティの更新

指定されたデータベースのプロパティを更新します。

概要

./dlf-cli/bin/dlf database alter \
--full_name <catalogName.databaseName> \
--removals <removals> \
--updates <updates>

パラメーター

例

./dlf-cli/bin/dlf database alter \
--full_name test-cli.test_db \
--removals '["k1"]' \
--updates '{"k2":"v3"}'

出力

2025-07-08 11:08:26 : success

drop - データベースの削除

指定されたデータベースを削除します。

概要

./dlf-cli/bin/dlf database drop \
--full_name <catalogName.databaseName> 

パラメーター

例

./dlf-cli/bin/dlf database drop \
--full_name test-cli.test_db

出力

2025-07-08 11:09:26 : success

help - table サブコマンドを一覧表示します

./dlf-cli/bin/dlf table help

list - テーブルの一覧表示

指定されたデータベース内のテーブル名を一覧表示します。この操作はページネーションをサポートします。

使用法

./dlf-cli/bin/dlf table list \
--catalog <catalogName> \
--database <databaseName> \
[--max_results <max_results>] \
[--page_token <page_token>]

パラメーター

例

./dlf-cli/bin/dlf table list \
--catalog test-cli \
--database test_db

出力

2025-07-08 11:27:39 : {
  "elements" : [ "test_table" ],
  "nextPageToken" : null
}

get - テーブルの取得

指定されたテーブルの詳細を取得します。

使用法

./dlf-cli/bin/dlf table get \
--full_name <catalogName.databaseName.tableName> 

パラメーター

例

./dlf-cli/bin/dlf table get \
--full_name test-cli.test_db.test_table

出力：

2025-07-08 11:29:13 : {
  "id" : "tbl-d2a8e203-xxxxxx",
  "name" : "test_table",
  "path" : "oss://clg-paimon-b1af75xxxxxx/db-2788b0b9-xxxxxx.db/tbl-d2a8e203-xxxxxx",
  "isExternal" : false,
  "schemaId" : 0,
  "schema" : {
    "fields" : [ {
      "id" : 0,
      "name" : "f0",
      "type" : "INT NOT NULL"
    }, {
      "id" : 1,
      "name" : "f1",
      "type" : "INT NOT NULL"
    } ],
    "partitionKeys" : [ "f0" ],
    "primaryKeys" : [ "f0", "f1" ],
    "options" : {
      "bucket" : "-2",
      "path" : "oss://clg-paimon-b1af75xxxxxx/db-2788b0b9-xxxxxx.db/tbl-d2a8e203-xxxxxx",
      "manifest.merge-min-count" : "10",
      "manifest.delete-file-drop-stats" : "true",
      "data-file.thin-mode" : "true",
      "partition.legacy-name" : "false",
      "write-only" : "true",
      "metastore.partitioned-table" : "true"
    },
    "comment" : "コメント"
  },
  "owner" : "acs:ram::104568******:root",
  "createdAt" : 1751944703679,
  "createdBy" : "acs:ram::104568******:root",
  "updatedAt" : 1751944703679,
  "updatedBy" : "acs:ram::104568******:root"
}

create - テーブルの作成

新しいテーブルを作成します。

概要

./dlf-cli/bin/dlf table create \
--full_name <catalogName.databaseName.tableName> \
--schema <schema>

パラメーター

例

./dlf-cli/bin/dlf table create \
--full_name test-cli.test_db.test_table \
--schema '{"fields" : [ {"id" : 0, "name" : "f0", "type" : "INT NOT NULL" }, {"id" : 1, "name" : "f1", "type" : "INT NOT NULL" } ], "partitionKeys" : [ "f0" ], "primaryKeys" : [ "f0", "f1" ], "options" : { }, "comment" : "comment" }'

出力

2025-07-08 11:18:23 : success

alter - テーブルプロパティの更新

指定されたテーブルのプロパティを更新します。

概要

./dlf-cli/bin/dlf table alter \
--full_name <catalogName.databaseName.tableName> \
--changes <changes>

パラメーター

例

./dlf-cli/bin/dlf table alter \
--full_name test-cli.test_db.test_table \
--changes '[{"action":"setOption", "key" : "snapshot.time-retained", "value" : "2h" }, {"action":"updateComment","comment" : "hahaha" }]'

出力

2025-07-08 11:35:18 : success

drop - テーブルの削除

指定されたテーブルを削除します。

概要

./dlf-cli/bin/dlf table drop \
--full_name <catalogName.databaseName.tableName>

パラメーター

例

./dlf-cli/bin/dlf table drop \
--full_name test-cli.test_db.test_table

出力

2025-07-08 11:35:18 : success

get_snapshot - テーブルスナップショットの取得

指定されたテーブルの最新のスナップショットを取得します。

使い方

./dlf-cli/bin/dlf table get_snapshot \
--full_name <catalogName.databaseName.tableName>

パラメーター

例

./dlf-cli/bin/dlf table get_snapshot --full_name test_paimon.default.test_yt

出力

2025-07-08 11:42:32 : {
  "snapshot" : {
    "version" : 3,
    "id" : 14,
    "schemaId" : 0,
    "baseManifestList" : "manifest-list-e97f6ae4-xxxxxx",
    "baseManifestListSize" : 1041,
    "deltaManifestList" : "manifest-list-e97f6ae4-xxxxxx",
    "deltaManifestListSize" : 989,
    "changelogManifestList" : null,
    "commitUser" : "morax_d51dfc0b-xxxxxx",
    "commitIdentifier" : 5,
    "commitKind" : "COMPACT",
    "timeMillis" : 1749807238526,
    "logOffsets" : { },
    "totalRecordCount" : 3,
    "deltaRecordCount" : -5,
    "changelogRecordCount" : 0,
    "watermark" : -9223372036854775808
  },
  "recordCount" : 3,
  "fileSizeInBytes" : 799,
  "fileCount" : 1,
  "lastFileCreationTime" : 1749807176914
}

ロールバック

指定されたテーブルを以前のスナップショットバージョンにロールバックします。

使用方法

./dlf-cli/bin/dlf table rollback \
--full_name <catalogName.databaseName.tableName> \
--instant <instant>

パラメーター

例

./dlf-cli/bin/dlf table rollback \
--full_name test_paimon.default.test_yt \
--instant '{"type":"snapshot", "snapshotId": 13}'

出力

2025-07-08 11:46:56 ： success

list_branches - ブランチ名の一覧表示

指定されたテーブルのブランチ名を一覧表示します。

概要

./dlf-cli/bin/dlf table list_branches \
--full_name <catalogName.databaseName.tableName> 

パラメーター

使用例

./dlf-cli/bin/dlf table list_branches \
--full_name test_paimon.default.test_yt

出力

2025-07-08 13:57:46 : [ "stream" ]

create_branch - ブランチの作成

指定されたテーブルの新しいブランチを作成します。

概要

./dlf-cli/bin/dlf table create_branch \
--full_name <catalogName.databaseName.tableName> \
--branch <branchName> \
[--from_tag <tagName>] 

パラメーター

例

./dlf-cli/bin/dlf table create_branch \
--full_name test_paimon.default.test_yt \
--branch stream

出力

2025-07-08 13:56:41 : success

forward_branch - ブランチのファストフォワード

指定されたテーブルのブランチを最新の状態にファストフォワードします。

使用方法

./dlf-cli/bin/dlf table forward_branch \
--full_name <catalogName.databaseName.tableName> \
--branch <branchName>

パラメーター

例

./dlf-cli/bin/dlf table forward_branch \
--full_name test_paimon.default.test_yt \
--branch stream

出力

2025-07-08 13:56:41 : success

drop_branch

テーブルから指定されたブランチを削除します。

概要

./dlf-cli/bin/dlf table drop_branch \
--full_name <catalogName.databaseName.tableName> \
--branch <branchName>

パラメーター

例

./dlf-cli/bin/dlf table drop_branch \
--full_name test_paimon.default.test_yt \
--branch stream

出力

2025-07-08 14:02:19 : success