Referensi CLI - Data Lake Formation - Alibaba Cloud Documentation Center

Dokumen ini menjelaskan cara menginstal, mengonfigurasi, dan menggunakan DLF CLI untuk mengelola data di DLF secara efisien.

Prasyarat

Instans ECS Anda harus memenuhi persyaratan berikut:

Instans ECS dan DLF harus berada di wilayah yang sama. Untuk daftar wilayah yang didukung, lihat Endpoints.
Instans ECS harus berada di VPC yang telah diotorisasi untuk DLF. Jika otorisasi belum dikonfigurasi, lihat Konfigurasi daftar putih VPC.
Instans ECS harus memiliki JDK 11 atau versi yang lebih baru terinstal.

Instalasi

Unduh dlf-cli-20250818163820.tar.gz.
Gunakan perintah scp untuk mengunggah paket tar ke direktori tujuan pada instans ECS Anda.
```
scp dlf-cli-20250818163820.tar.gz username@ecs-ip:/path/to/destination
```
Login ke instans ECS Anda, navigasi ke direktori tujuan, lalu jalankan perintah berikut untuk mengekstrak paket tersebut.
```
tar -xzvf dlf-cli-20250818163820.tar.gz
```

Gunakan perintah vim untuk mengedit file konfigurasi dlf-cli/conf/dlf-cli.properties, lalu konfigurasikan parameter berikut.

vim dlf-cli/conf/dlf-cli.properties

Parameter	Deskripsi	Contoh
`uri`	URI dari DLF REST Catalog Server. Formatnya adalah `http://[region-id]-vpc.dlf.aliyuncs.com`. Untuk informasi lebih lanjut tentang ID wilayah, lihat Endpoints.	http://cn-hangzhou-vpc.dlf.aliyuncs.com
`dlf.region`	ID wilayah. Untuk informasi selengkapnya, lihat Endpoints.	cn-hangzhou
`dlf.access-key-id`	ID AccessKey Akun Alibaba Cloud atau Pengguna RAM Anda. Catatan Pengguna RAM atau Peran RAM harus memiliki izin API yang diperlukan. Untuk informasi selengkapnya, lihat Referensi aksi otorisasi RAM.	-
`dlf.access-key-secret`	Rahasia AccessKey Akun Alibaba Cloud atau Pengguna RAM Anda.	-
`dlf.open-api-endpoint`	Titik akhir OpenAPI DLF. Untuk informasi selengkapnya, lihat Endpoints. Jika Anda tidak mengisi parameter ini, nilainya akan diturunkan dari parameter uri.	dlfnext.cn-hangzhou.aliyuncs.com

(Opsional) Jalankan perintah echo $JAVA_HOME untuk memverifikasi variabel lingkungan JAVA_HOME. Jika output kosong atau variabel tidak diatur ke path instalasi JDK 11 Anda, Anda harus mengonfigurasi ulang variabel JAVA_HOME.
```
export JAVA_HOME=<JDK_11_PATH>
```
Contoh:
```
[root@iZxxxZ lib]# export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-11.0.25.0.9-2.0.1.1.al8.x86_64
[root@iZxxxZ lib]# echo $JAVA_HOME
/usr/lib/jvm/java-11-openjdk-11.0.25.0.9-2.0.1.1.al8.x86_64
```

Informasi otorisasi

Kontrol akses RAM

Tabel berikut menjelaskan informasi otorisasi untuk setiap API. Gunakan informasi ini dalam elemen Action pernyataan kebijakan Resource Access Management (RAM) untuk memberikan izin kepada Pengguna RAM atau Peran RAM agar dapat memanggil API-API tersebut.

Kolom	Deskripsi
Operasi	Izin spesifik.
Tingkat akses	Tingkat akses: Write, Read, atau List.
Jenis resource	Jenis resource yang mendukung otorisasi. Tanda bintang (\*) menunjukkan jenis resource yang wajib. Untuk operasi yang tidak mendukung otorisasi tingkat resource, nilainya adalah `All resources`.
Kunci kondisi	Kunci kondisi yang didefinisikan oleh produk cloud.
Operasi terkait	Izin lain yang diperlukan agar operasi berhasil dipanggil.

Operasi	Tingkat akses	Jenis resource	Kunci kondisi	Operasi terkait
dlf:See the specific API	See the specific API	\*All resources	None	None

Pembaruan kontrol akses RAM biasanya membutuhkan waktu sekitar satu menit untuk berlaku.

Pengelolaan izin ACL

Untuk informasi selengkapnya, lihat Pengelolaan otorisasi.

Perintah Peran

list - Daftar role

Mengambil daftar semua nama role dan mendukung pagination serta penyaringan.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListRoles

get

All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--max_results`	integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika Anda mengabaikan parameter ini, nilai default sistem akan digunakan.
`--page_token`	string	Tidak	Token pagination yang digunakan untuk mengambil halaman hasil berikutnya. Abaikan parameter ini untuk permintaan pertama. Untuk permintaan berikutnya, gunakan token dari respons sebelumnya.
`--role_name`	string	Tidak	Menyaring hasil berdasarkan nama role. Mendukung pencocokan kabur.

Contoh

./dlf-cli/bin/dlf role list

Hasil

2025-07-07 17:12:02 : {
  "nextPageToken" : null,
  "roles" : [{
    "createdAt" : 1744428101414,
    "createdBy" : "xxxx",
    "description" : "super_administrator(system role)",
    "displayName" : "super_administrator",
    "isPredefined" : "true",
    "roleName" : "super_administrator",
    "rolePrincipal" : "xxxx",
    "updatedAt" : 1744428101414,
    "updatedBy" : "xxxx",
    "users" : [{
      "createdAt" : 1747744999611,
      "createdBy" : "xxx",
      "displayName" : "xxx",
      "type" : "RAM_USER",
      "updatedAt" : 1747744999611,
      "updatedBy" : "xxxx",
      "userId" : "207384147744632137",
      "userName" : "xxxx",
      "userPrincipal" : "xxxx"
    }]
  }]
}

get - Mendapatkan peran

Mengambil detail role tertentu berdasarkan principal role-nya.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetRole

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--role_principal`	String	Ya	Principal role, yang secara unik mengidentifikasi role tersebut.

Contoh

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

Respons:

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"
  }]
}

Buat role

Membuat role baru. Anda dapat menentukan nama role, nama tampilan, dan deskripsi.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:CreateRole

create

all resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--role_name`	string	Ya	Pengidentifikasi unik role tersebut.
`--display_name`	string	Ya	Nama tampilan role, yang ditampilkan di antarmuka pengguna.
`--description`	string	Tidak	Deskripsi mengenai tujuan atau cakupan izin role tersebut.

Contoh

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

Output

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

alter - Memperbarui peran

Memperbarui nama tampilan atau deskripsi untuk role tertentu.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:UpdateRole

update

All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--role_principal`	string	Ya	Pengidentifikasi principal dari role yang akan diperbarui.
`--display_name`	string	Ya	Nama tampilan baru untuk role tersebut.
`--description`	string	Tidak	Deskripsi baru untuk role tersebut, yang menguraikan tujuan atau cakupan izinnya.

Contoh

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

Output

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

drop: Hapus peran

Menghapus role yang ditentukan.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Aksi terkait

dlf:DeleteRole

delete

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--role_principal`	String	Ya	Principal yang secara unik mengidentifikasi role tersebut.

Contoh

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

Output

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

list_users - Daftar pengguna yang terkait dengan role

Mengambil daftar pengguna yang terkait dengan role tertentu, disertai pagination.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListRoleUsers

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--role_principal`	String	Ya	Principal role yang secara unik mengidentifikasi role target.
`--max_results`	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika Anda mengabaikan parameter ini, sistem akan menggunakan nilai default.
`--page_token`	String	Tidak	Token yang menentukan halaman hasil berikutnya yang akan dikembalikan. Abaikan parameter ini untuk mengambil halaman pertama. Untuk halaman berikutnya, gunakan nilai `nextPageToken` dari respons sebelumnya.

Contoh

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

Output

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"
  } ]
}

Berikan role kepada pengguna

Memberikan role kepada satu atau beberapa pengguna.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GrantRoleToUsers

create

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--role_principal`	string	Ya	Principal unik dari role target.
`--user_principals`	string	Ya	String yang berisi array JSON dari principal pengguna. Contohnya, `'["user1","user2","user3"]'`.

Contoh

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

Output

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

Mencabut pengguna dari peran

Memutuskan asosiasi pengguna tertentu dari sebuah role.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:RevokeRoleFromUsers

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--role_principal`	string	Ya	Principal yang secara unik mengidentifikasi role target.
`--user_principals`	string	Ya	String yang berisi array JSON dari principal pengguna. Contohnya: `'["user1","user2","user3"]'`.

Contoh

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

Output

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

Perintah pengguna

list

Menampilkan daftar pengguna. Anda dapat menyaring daftar berdasarkan kriteria seperti username dan tipe pengguna. Perintah ini mendukung pagination.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListUsers

get

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--user_name`	String	Tidak	Menyaring hasil berdasarkan username. Mendukung pencocokan kabur.
`--user_type`	String	Tidak	Menyaring hasil berdasarkan tipe pengguna, seperti `RAM_USER` atau `RAM_ROLE`.
`--max_results`	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika diabaikan, sistem akan menggunakan nilai default.
`--page_token`	String	Tidak	Token pagination dari respons sebelumnya untuk mengambil halaman hasil berikutnya. Abaikan parameter ini untuk permintaan pertama.

Contoh

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

Output

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

Menampilkan daftar role yang terkait dengan pengguna tertentu.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListUserRoles

get

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--user_principal`	String	Ya	Principal pengguna dari pengguna target.
`--max_results`	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika diabaikan, sistem akan menggunakan nilai default.
`--page_token`	String	Tidak	Token pagination dari respons sebelumnya untuk mengambil halaman hasil berikutnya. Abaikan parameter ini untuk permintaan pertama.

Contoh

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

Output

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
  }]
}

Perintah izin

list - Daftar izin

Menampilkan daftar izin untuk jenis resource tertentu. Anda dapat menyaring hasil berdasarkan kriteria seperti jenis resource (misalnya, catalog, database, atau table) dan kondisi lainnya. Perintah ini juga mendukung pagination.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListPermissions

get

*All resources

*

None

Sinopsis

./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>]

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang berisi izin tersebut.
`--resource_type`	String	Ya	Jenis resource untuk penyaringan. Nilai yang valid adalah `catalog`, `database`, `table`, `function`, dan `view`.
`--database`	String	Tidak	Nama database. Parameter ini hanya diperlukan jika `resource_type` adalah `database` atau salah satu sub-resource-nya.
`--table`	String	Tidak	Nama tabel. Parameter ini hanya diperlukan jika `resource_type` adalah `table` atau salah satu sub-resource-nya.
`--principal`	String	Tidak	Principal (pengguna atau role) untuk menyaring izin.
`--max_results`	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Default mengikuti nilai sistem.
`--page_token`	String	Tidak	Token pagination untuk mengambil halaman hasil berikutnya. Abaikan parameter ini untuk pemanggilan pertama. Untuk pemanggilan berikutnya, gunakan token dari respons sebelumnya.

Contoh

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

Output

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 - Berikan izin

Memberikan izin kepada principal tertentu (pengguna atau role).

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:BatchGrantPermissions

create

*All resources

*

None

Sinopsis

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

Parameter

Parameter

Tipe

Wajib

Deskripsi

--catalog

String

Nama catalog yang berisi izin tersebut.

--permissions

String JSON

Array JSON dari objek izin. Setiap objek menentukan izin yang akan diberikan dan mencakup tipe akses (access), nama database (database), principal (principal), dan jenis resource (resourceType). Untuk informasi selengkapnya, lihat Izin.

{"access" : "SELECT", "database" : "default", "principal" : "acs:ram::104568******:user/starrocks_test", "resourceType" : "DATABASE"}

Contoh

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

Output

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

revoke - Cabut izin

Mencabut izin resource dari principal tertentu (pengguna atau role).

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:BatchRevokePermissions

delete

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang berisi izin tersebut.
`--permissions`	String JSON	Ya	Array JSON dari objek izin. Setiap objek menentukan izin yang akan dicabut dan mencakup detail seperti principal, jenis resource, nama resource, dan tipe akses.

Contoh

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

Output

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

Perintah Katalog

help - Daftar perintah catalog yang didukung

./dlf-cli/bin/dlf catalog help

list - Daftar catalog

Menampilkan semua catalog. Pagination didukung.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListCatalogs

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--max_results`	Integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika diabaikan, nilai default akan digunakan.
`--page_token`	String	Tidak	Token untuk mengambil halaman hasil berikutnya. Untuk mengambil halaman pertama, jangan tentukan parameter ini. Untuk permintaan berikutnya, gunakan nilai nextPageToken dari respons sebelumnya.

Contoh

./dlf-cli/bin/dlf catalog list

Respons

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 - Ambil detail catalog

Mengambil detail untuk catalog yang ditentukan.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetCatalog

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang akan diambil.

Contoh

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

Respons

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 - Membuat katalog

Membuat catalog baru dengan nama dan opsi yang ditentukan.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:CreateCatalog

create

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang akan dibuat.
`--options`	String JSON	Ya	Opsi konfigurasi untuk catalog, disediakan sebagai string JSON. Opsi ini dapat mencakup properti seperti komentar.

Contoh

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

Respons

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

alter - Perbarui catalog

Memperbarui properti catalog tertentu.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:AlterCatalog

update

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang akan diperbarui.
`--removals`	String JSON	Tidak	Daftar nama properti yang akan dihapus, disediakan sebagai array JSON (misalnya, `'["key1", "key2"]'`).
`--updates`	String JSON	Tidak	Properti dan nilai barunya yang akan ditambahkan atau diperbarui, disediakan sebagai objek JSON (misalnya, `'{"key1": "value1"}'`).

Contoh

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

Respons

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

drop - Hapus catalog

Kondisi berikut harus dipenuhi. Jika tidak, operasi drop akan gagal:

Semua tabel dan database yang dibuat pengguna dalam catalog telah dihapus.
Setidaknya 24 jam telah berlalu sejak tabel dan database tersebut dihapus.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:DropCatalog

delete

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog yang akan dihapus.

Contoh

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

Respons

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

get_token - Dapatkan kredensial akses sementara

Mengambil kredensial akses sementara untuk catalog yang ditentukan.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetCatalogToken

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	String	Ya	Nama catalog untuk mengambil token.

Contoh

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

Respons

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"
  }
}

Perintah database

help - Daftar perintah database

./dlf-cli/bin/dlf database help

list - Daftar database

Menampilkan nama database dalam catalog tertentu. Perintah ini mendukung pagination.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListDatabases

List

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	string	Ya	Nama catalog.
`--max_results`	integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika tidak ditentukan, sistem akan menggunakan nilai default.
`--page_token`	string	Tidak	Token pagination. Abaikan parameter ini untuk permintaan pertama. Untuk permintaan berikutnya, gunakan nilai `nextPageToken` dari respons sebelumnya untuk mengambil halaman hasil berikutnya.

Contoh

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

Output

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

get - Dapatkan detail database

Mendapatkan detail database tertentu.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetDatabase

Read

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama database lengkap, dalam format `<catalogName>.<databaseName>`.

Contoh

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

Output

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 - Buat database

Membuat database.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:CreateDatabase

Write

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama database lengkap untuk database baru, dalam format `<catalogName>.<databaseName>`.
`--options`	String JSON	Ya	Properti konfigurasi database, ditentukan sebagai string JSON. Properti ini dapat mencakup lokasi penyimpanan dan deskripsi.

Contoh

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

Output

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

alter - Perbarui properti database

Memperbarui properti database tertentu.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:AlterDatabase

Write

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama database lengkap, dalam format `<catalogName>.<databaseName>`.
`--removals`	String JSON	Tidak	Array JSON dari kunci properti yang akan dihapus. Contohnya: `'["key1", "key2"]'`.
`--updates`	String JSON	Tidak	Objek JSON dari pasangan kunci-nilai yang akan ditambahkan atau diperbarui. Contohnya: `'{"key1": "value1"}'`.

Contoh

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

Output

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

drop - Hapus database

Menghapus database tertentu.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:DropDatabase

Write

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama lengkap database yang akan dihapus, dalam format `<catalogName>.<databaseName>`.

Contoh

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

Output

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

Perintah tabel

help - Daftar subperintah tabel

./dlf-cli/bin/dlf table help

list - Daftar tabel

Menampilkan nama tabel dalam database tertentu. Operasi ini mendukung pagination.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ListTables

list

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	string	Ya	Nama catalog.
`--database`	string	Ya	Nama database.
`--max_results`	integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika parameter ini tidak ditentukan, nilai default akan digunakan.
`--page_token`	string	Tidak	Token yang digunakan untuk mengambil halaman hasil berikutnya. Kosongkan parameter ini untuk panggilan pertama. Untuk panggilan berikutnya, gunakan token dari respons sebelumnya.

Contoh

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

Output

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

get - Dapatkan tabel

Mendapatkan detail tabel tertentu.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetTable

get

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	String	Ya	Nama tabel lengkap dalam format `<catalogName>.<databaseName>.<tableName>`.

Contoh

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

Output:

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" : "comment"
  },
  "owner" : "acs:ram::104568******:root",
  "createdAt" : 1751944703679,
  "createdBy" : "acs:ram::104568******:root",
  "updatedAt" : 1751944703679,
  "updatedBy" : "acs:ram::104568******:root"
}

create - Buat tabel

Membuat tabel baru.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:CreateTable

create

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Type	Wajib	Deskripsi
`--full_name`	string	Ya	Nama tabel lengkap dalam format `<catalogName>.<databaseName>.<tableName>`.
`--schema`	String JSON	Ya	Skema tabel, ditentukan sebagai string JSON. Ini mencakup properti seperti fields, types, partition keys, dan primary keys.

Contoh

./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" }'

Output

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

alter - Perbarui properti tabel

Memperbarui properti tabel tertentu.

Kontrol akses RAM

Tindakan

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:AlterTable

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama tabel lengkap dalam format `<catalogName>.<databaseName>.<tableName>`.
`--changes`	String JSON	Ya	Array JSON dari operasi perubahan. Setiap operasi menentukan `action` (seperti `setOption` atau `updateComment`) dan parameter yang sesuai.

Contoh

./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" }]'

Output

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

drop - Hapus tabel

Menghapus tabel yang ditentukan.

Kontrol akses RAM

Tindakan

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:DropTable

delete

All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama lengkap tabel yang akan dihapus, dalam format `<catalogName>.<databaseName>.<tableName>`.

Contoh

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

Output

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

get_snapshot - Dapatkan snapshot tabel

Mengambil snapshot terbaru untuk tabel tertentu.

Kontrol akses RAM

Tindakan

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:GetTableSnapshot

get

All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	String	Ya	Nama lengkap tabel dalam format `<catalogName>.<databaseName>.<tableName>`.

Contoh

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

Output

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
}

Rollback

Mengembalikan tabel tertentu ke versi snapshot sebelumnya.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:RollbackTable

*All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama lengkap tabel dalam format `<catalogName>.<databaseName>.<tableName>`.
`--instant`	string	Ya	Target snapshot untuk rollback, ditentukan sebagai string JSON. Untuk detail objek JSON, lihat Instant.

Contoh

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

Output

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

list_branches - Daftar nama branch

Menampilkan daftar nama branch untuk tabel tertentu.

Kontrol akses RAM

Tindakan

Tingkat akses

Jenis resource

Kunci kondisi

Aksi terkait

dlf:ListBranches

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	String	Ya	Nama tabel lengkap dalam format `<catalogName>.<databaseName>.<tableName>`.

Contoh

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

Output

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

create_branch - Buat branch

Membuat branch baru untuk tabel tertentu.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:CreateBranch

create

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	String	Ya	Nama lengkap tabel dalam format `<catalogName>.<databaseName>.<tableName>`.
`--branch`	String	Ya	Nama branch baru.
`--from_tag`	String	Tidak	Menentukan tag sumber untuk branch baru. Jika parameter ini diabaikan, branch akan dibuat dari branch utama saat ini.

Contoh

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

Output

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

forward_branch - Fast-forward branch

Fast-forward branch untuk tabel tertentu ke status terbarunya.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:ForwardBranch

create

All resources

*

None

Penggunaan

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama lengkap tabel target dalam format `<catalogName>.<databaseName>.<tableName>`.
`--branch`	string	Ya	Nama branch target yang akan di-fast-forward.

Contoh

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

Output

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

drop_branch

Menghapus branch tertentu dari tabel.

Kontrol akses RAM

Operasi

Tingkat akses

Jenis resource

Kunci kondisi

Operasi terkait

dlf:DropBranch

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--full_name`	string	Ya	Nama lengkap tabel, dalam format `<catalogName>.<databaseName>.<tableName>`.
`--branch`	string	Ya	Branch yang akan dihapus.

Contoh

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

Output

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

Perintah partisi

Daftar partisi

Menampilkan daftar partisi.

Kontrol akses RAM

Aksi

Tingkat akses

Jenis resource

Kunci kondisi

Aksi terkait

dlf:ListPartitions

list

*All resources

*

None

Sinopsis

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

Parameter

Parameter	Tipe	Wajib	Deskripsi
`--catalog`	string	Ya	Nama catalog target.
`--identifier`	string	Ya	Pengidentifikasi unik untuk tabel target, diformat sebagai `<databaseName>.<tableName>`.
`--max_results`	integer	Tidak	Jumlah maksimum hasil yang dikembalikan per halaman. Jika diabaikan, sistem akan menggunakan nilai default.
`--page_token`	string	Tidak	Token untuk mengambil halaman hasil berikutnya. Abaikan parameter ini untuk permintaan pertama. Untuk permintaan berikutnya, gunakan nilai nextPageToken dari respons sebelumnya.

Contoh

./dlf-cli/bin/dlf partition list \
--catalog 'baoma_poc' \
--identifier 'default.pk_ctas_tbl'

Hasil

2025-07-08 14:08:09 : {
  "elements" : [ {
    "spec" : {
      "p" : "1"
    },
    "recordCount" : 1,
    "fileSizeInBytes" : 684,
    "fileCount" : 1,
    "lastFileCreationTime" : 1748345335406,
    "done" : false
  } ],
  "nextPageToken" : null
}