Skip to main content

CLI: Catalogs and Databases

List databases and tables, inspect database properties, and create or change databases. These commands use the catalog configuration described in CLI basic usage.

Catalog Commands​

Catalog List DBs​

List all databases in the catalog.

paimon catalog list-dbs

Output:

default
mydb
analytics

Database Commands​

DB Get​

Get and display database information in JSON format.

paimon db get mydb

Output:

{
  "name": "mydb",
  "options": {}
}

DB Create​

Create a new database.

# Create a simple database
paimon db create mydb

# Create with properties
paimon db create mydb -p '{"key1": "value1", "key2": "value2"}'

# Create and ignore if already exists
paimon db create mydb -i

DB Drop​

Drop an existing database.

# Drop a database
paimon db drop mydb

# Drop and ignore if not exists
paimon db drop mydb -i

# Drop with all tables (cascade)
paimon db drop mydb --cascade

DB Alter​

Alter database properties by setting or removing properties.

# Set properties
paimon db alter mydb --set '{"key1": "value1", "key2": "value2"}'

# Remove properties
paimon db alter mydb --remove key1 key2

# Set and remove properties in one command
paimon db alter mydb --set '{"key1": "new_value"}' --remove key2

DB List Tables​

List all tables in a database.

paimon db list-tables mydb

Output:

orders
products
users