Unity Catalog CLI

The CLI tool allows users to interact with a Unity Catalog server to create and manage catalogs, schemas, tables across different formats (DELTA, UNIFORM, PARQUET, JSON, and CSV), volumes with unstructured data, and functions.

!!! note "Specify token for authenticated access"

For all the following commands, you will need to provide an authentication token when executng these commands.
For example, in the following section, to run the catalog list command, you would specify:

```bash
bin/uc --auth_token $token catalog list
```

where $token is the authentication token provided by an identity provider. For more information on how to support
both authentication and authorization, please refer to the [auth](../server/auth.md).

1. Catalog Management CLI Usage

This section outlines the usage of the bin/uc script for managing catalogs within your system. The script supports various operations such as creating, retrieving, listing and updating catalogs.

1.1 List Catalogs

Here's how to list catalogs contained in a Unity Catalog instance.

bin/uc catalog list [--max_results <max_results>]

max_results: [Optional] The maximum number of results to return.

1.2 Get details of a Catalog

bin/uc catalog get --name <name>

name: The name of the catalog.

1.3 Create a Catalog

bin/uc catalog create --name <name> [--comment <comment>] [--properties <properties>]

name: The name of the catalog.
comment: [Optional] The description of the catalog.
properties: [Optional] The properties of the catalog in JSON format (e.g., '{"key1": "value1", "key2": "value2"}'). Make sure to either escape the double quotes(\") inside the properties string or just use single quotes('') around the same.

Example:

bin/uc catalog create --name my_catalog --comment "My First Catalog" --properties '{"key1": "value1", "key2": "value2"}'

1.4 Update a Catalog

bin/uc catalog update --name <name> [--new_name <new_name>] [--comment <comment>] [--properties <properties>]

name: The name of the existing catalog.
new_name: [Optional] The new name of the catalog.
comment: [Optional] The new description of the catalog.
properties: [Optional] The new properties of the catalog in JSON format (e.g., '{"key1": "value1", "key2": "value2"}'). Make sure to either escape the double quotes(\") inside the properties string or just use single quotes('') around the same.

Note: At least one of the optional parameters must be specified.

Example:

bin/uc catalog update --name my_catalog --new_name my_updated_catalog --comment "Updated Catalog" --properties '{"updated_key": "updated_value"}'

1.5 Delete a Catalog

bin/uc catalog delete --name <name>

name: The name of the catalog.

2. Schema Management CLI Usage

This section outlines the usage of the bin/uc script for managing schemas within your system. The script supports various operations such as creating, retrieving, listing, updating and deleting schemas.

2.1 List Schemas

bin/uc schema list --catalog <catalog> [--max_results <max_results>]

catalog: The name of the catalog.
max_results: [Optional] The maximum number of results to return.

2.2 Get a Schema

Retrieve the details of a schema using the full name of the schema.

bin/uc schema get --full_name <catalog>.<schema>

catalog: The name of the catalog.
schema: The name of the schema.

2.3 Create a Schema

bin/uc schema create --catalog <catalog> --name <name> [--comment <comment>] [--properties <properties>]

catalog: The name of the catalog.
name: The name of the schema.
comment: [Optional] The description of the schema.
properties: [Optional] The properties of the schema in JSON format (e.g., '{"key1": "value1", "key2": "value2"}'). Make sure to either escape the double quotes(\") inside the properties string or just use single quotes('') around the same.

Example:

bin/uc schema create --catalog my_catalog --name my_schema --comment "My Schema" --properties '{"key1": "value1", "key2": "value2"}'

2.4 Update a Schema

bin/uc schema update --full_name <full_name> [--new_name <new_name>] [--comment <comment>] [--properties <properties>]

full_name: The full name of the existing schema. The full name is the concatenation of the catalog name and schema name separated by a dot (e.g., catalog_name.schema_name).
new_name: [Optional] The new name of the schema.
comment: [Optional] The new description of the schema.
properties: [Optional] The new properties of the schema in JSON format (e.g., '{"key1": "value1", "key2": "value2"}'). Make sure to either escape the double quotes(\") inside the properties string or just use single quotes('') around the same.

Note: At least one of the optional parameters must be specified.

Example:

bin/uc schema update --full_name my_catalog.my_schema --new_name my_updated_schema --comment "Updated Schema" --properties '{"updated_key": "updated_value"}'

2.5 Delete a Schema

bin/uc schema delete --full_name <catalog>.<schema>

catalog: The name of the catalog.
schema: The name of the schema.

3. Table Management CLI Usage

This section outlines the usage of the bin/uc script for managing tables within your system. The script supports various operations such as creating, retrieving, listing and deleting tables. There's additional functionality to write sample data to a DELTA table and read data from a DELTA table.

3.1 List Tables

bin/uc table list --catalog <catalog> --schema <schema> [--max_results <max_results>]

catalog: The name of the catalog.
schema: The name of the schema.
max_results: [Optional] The maximum number of results to return.

3.2 Retrieve Table Information

bin/uc table get --full_name <catalog>.<schema>.<table>

catalog: The name of the catalog.
schema: The name of the schema.
table: The name of the table.

3.3 Create a Table

bin/uc table create --full_name <full_name> --columns <columns> --storage_location <storage_location> [--format <format>] [--properties <properties>]

full_name: The full name of the table, which is a concatenation of the catalog name, schema name, and table name separated by dots (e.g., catalog_name.schema_name.table_name).
columns: The columns of the table in SQL-like format "column_name column_data_type". Supported data types include BOOLEAN, BYTE, SHORT, INT, LONG, FLOAT, DOUBLE, DATE, TIMESTAMP, TIMESTAMP_NTZ, STRING, BINARY, DECIMAL. Separate multiple columns with a comma (e.g., "id INT, name STRING").
format: [Optional] The format of the data source. Supported values are DELTA, PARQUET, ORC, JSON, CSV, AVRO, and TEXT. If not specified the default format is DELTA.
storage_location: The storage location associated with the table. It is a mandatory field for EXTERNAL tables.
properties: [Optional] The properties of the table in JSON format (e.g., '{"key1": "value1", "key2": "value2"}'). Make sure to either escape the double quotes(\") inside the properties string or just use single quotes('') around the same.

Example:

Create an external DELTA table with columns id and name in the schema my_schema of catalog my_catalog with storage location /path/to/storage:

bin/uc table create --full_name my_catalog.my_schema.my_table --columns "id INT, name STRING" --storage_location "/path/to/storage"

When running against UC server, the storage location can be a local path(absolute path) or an S3 path. When S3 path is provided, the server configuration will vend temporary credentials to access the S3 bucket and server properties must be set up accordingly.

3.4 Read a DELTA Table

bin/uc table read --full_name <catalog>.<schema>.<table> [--max_results <max_results>]

catalog: The name of the catalog.
schema: The name of the schema.
table: The name of the table.
max_results: [Optional] The maximum number of rows to return.

3.5 Write Sample Data to a DELTA Table

bin/uc table write --full_name <catalog>.<schema>.<table>

catalog: The name of the catalog.
schema: The name of the schema.
table: The name of the table.

This is an experimental feature and only some primitive types are supported for writing sample data.

3.6 Delete a Table

bin/uc table delete --full_name <catalog>.<schema>.<table>

catalog: The name of the catalog.
schema: The name of the schema.
table: The name of the table.

4. Volume Management CLI Usage

This section outlines the usage of the bin/uc script for managing volumes within your system. The script supports various operations such as creating, retrieving, listing and deleting volumes.

4.1 List Volumes

bin/uc volume list --catalog <catalog> --schema <schema> [--max_results <max_results>]

catalog: The name of the catalog.
schema: The name of the schema.
max_results: [Optional] The maximum number of results to return.

4.2 Retrieve Volume Information

bin/uc volume get --full_name <catalog>.<schema>.<volume>

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.

4.3 Create a Volume

bin/uc volume create --full_name <catalog>.<schema>.<volume> --storage_location <storage_location> [--comment <comment>]

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.
storage_location: The storage location associated with the volume. When running against UC OSS server, the storage location can be a local path(absolute path) or an S3 path. When S3 path is provided, the server configuration will vend temporary credentials to access the S3 bucket and server properties must be set up accordingly. When running against Databricks Unity Catalog, the storage location for EXTERNAL volume can only be an S3 location which has been configured as an external location in your Databricks workspace.
comment: [Optional] The description of the volume.

Example:

Create an external volume with full name my_catalog.my_schema.my_volume with storage location /path/to/storage:

bin/uc volume create --full_name my_catalog.my_schema.my_volume --storage_location "/path/to/storage"

4.4 Update a Volume

bin/uc volume update --full_name <catalog>.<schema>.<volume> --new_name <new_name> [--comment <comment>]

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.
new_name: [Optional] The new name of the volume.
comment: [Optional] The new description of the volume.

Note: at least one of the optional parameters must be specified.

Example:

bin/uc volume update --full_name my_catalog.my_schema.my_volume --new_name my_updated_volume --comment "Updated Volume"

4.5 Read a Volume's content

bin/uc volume read --full_name <catalog>.<schema>.<volume> [--path <path>]

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.
path: [Optional] The path relative to the volume root. If no path is provided, the volume root is read. If the final path is a directory, the contents of the directory are listed(ls). If the final path is a file, the contents of the file are displayed(cat).

4.6 Write Sample Data to a Volume

bin/uc volume write --full_name <catalog>.<schema>.<volume>

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.

Writes sample text data to a randomly generated file name(UUID) in the volume. This is an experimental feature.

4.7 Delete a Volume

bin/uc volume delete --full_name <catalog>.<schema>.<volume>

catalog: The name of the catalog.
schema: The name of the schema.
volume: The name of the volume.

5. Function Management CLI Usage

This section outlines the usage of the bin/uc script for managing functions within your catalog. The script supports various operations such as creating, retrieving, listing and deleting functions.

5.1 List Functions

bin/uc function list --catalog <catalog> --schema <schema> [--max_results <max_results>]

catalog: The name of the catalog.
schema: The name of the schema.
max_results: [Optional] The maximum number of results to return.

5.2 Retrieve Function Information

bin/uc function get --full_name <catalog>.<schema>.<function_name>

catalog: The name of the catalog.
schema: The name of the schema.
function_name: The name of the function.

5.3 Create a Function

bin/uc function create --full_name <catalog>.<schema>.<function_name> --input_params <input_params> --data_type <data_type> --def <definition> [--comment <comment>] [--language <language>]

full_name: The full name of the function, which is a concatenation of the catalog name, schema name, and function name separated by dots (e.g., catalog_name.schema_name.function_name).
input_params: The input parameters to the function in SQL-like format "param_name param_data_type". Multiple input parameters should be separated by a comma (e.g., "param1 INT, param2 STRING").
data_type: The data type of the function. Either a type_name (for e.g. INT,DOUBLE, BOOLEAN, DATE), or TABLE_TYPE if this is a table valued function.
def: The definition of the function. The definition should be a valid SQL statement or a python routine with the function logic and return statement.
comment: [Optional] The description of the function.
language: [Optional] The language of the function. If not specified, the default value is PYTHON.

Example:

Create a python function that takes two integer inputs and returns the sum of the inputs:

bin/uc function create --full_name my_catalog.my_schema.my_function --input_params "param1 INT, param2 INT" --data_type INT --def "return param1 + param2" --comment "Sum Function"

5.4 Invoke a Function

bin/uc function call --full_name <catalog>.<schema>.<function_name> --input_params <input_params>

full_name: The full name of the function, which is a concatenation of the catalog name, schema name, and function name separated by dots (e.g., catalog_name.schema_name.function_name).
input_params : The value of input parameters to the function separated by a comma (e.g., "param1,param2").

This is an experimental feature and only supported for python functions that take in primitive types as input parameters. It runs the functions using the python engine script at etc/data/function/python_engine.py.

Example:

Invoke a python sum function that takes two integer inputs:

bin/uc function call --full_name my_catalog.my_schema.my_function --input_params "1,2"

5.5 Delete a Function

bin/uc function delete --full_name <catalog>.<schema>.<function_name>

catalog : The name of the catalog.
schema : The name of the schema.
function_name : The name of the function.

6. Registered model and model version management

Please refer to MLflow documentation to learn how to use MLflow to create, register, update, use, and delete registered models and model versions.

7. CLI Server Configuration

By default, the CLI tool is configured to interact with a local reference server running at http://localhost:8080. The CLI can be configured to talk to Databricks Unity Catalog by one of the following methods:

Include the following params in CLI commands:
- --server <server_url>: The URL of the Unity Catalog server.
- --auth_token <auth_token>: The PAT(Personal Authorization Token) token obtained from Databricks' Workspace.
Set the following properties in the CLI configuration file located at examples/cli/src/main/resources/application.properties:
- server: The URL of the Unity Catalog server.
- auth_token: The PAT(Personal Authorization Token) token obtained from Databricks' Workspace.

Each parameter can be configured either from the CLI or the configuration file, independently of each other. The CLI will prioritize the values provided from the CLI over the configuration file.

!!! feedback "Different look for users CLI commands"

We're trying out a different look for the CLI commands - which do you prefer - the format above this or the format
below? Chime in UC GitHub discussion [529](https://github.com/unitycatalog/unitycatalog/discussions/529) and let
us know!

8. Manage Users

This section outlines the usage of the bin/uc script for managing users within UC. The script supports various operations such as creating, getting, updating, listing, and deleting users.

8.1 Create User

bin/uc user create [options]

Required Params:

-- name: The name of the entity.
-- email : The email address for the user

Optional Params:

-- server: UC Server to connect to. Default is reference server.
-- auth_token: PAT token to authorize uc requests.
-- external_id: The identity provider's id for the user
-- output: To indicate CLI output format preference. Supported values are json and jsonPretty.

8.2 Delete User

bin/uc user delete [options]

Required Params:

--id The unique id of the user

Optional Params:

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.

8.3 Get User

bin/uc user get [options]

Required Params:

--id The unique id of the user

Optional Params:

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.

8.4 List Users

bin/uc user list [options]

Required Params:

None

Optional Params:

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.
--filter Query by which the results have to be filtered
--start_index Specifies the index (starting at 1) of the first result.
--count Desired number of results per page

8.5 Update User

bin/uc user update [options]

Required Params:

--id The unique id of the user

Optional Params:

--server UC Server to connect to. Default is reference server.
--auth_token PAT token to authorize uc requests.
--output To indicate CLI output format preference. Supported values are json and jsonPretty.
--name The name of the entity.
--external_id The identity provider's id for the user
--email The email address for the user

9. Metastore Management CLI Usage

This section outlines the usage of the bin/uc script to handle operations related to the metastore of the UC OSS server.

9.1 Get Metastore Information

Gets information about the metastore hosted by this Unity Catalog service (currently the service hosts only one metastore)

bin/uc metastore get

Files

cli.md

Latest commit

History

cli.md

File metadata and controls

Unity Catalog CLI

1. Catalog Management CLI Usage

1.1 List Catalogs

1.2 Get details of a Catalog

1.3 Create a Catalog

1.4 Update a Catalog

1.5 Delete a Catalog

2. Schema Management CLI Usage

2.1 List Schemas

2.2 Get a Schema

2.3 Create a Schema

2.4 Update a Schema

2.5 Delete a Schema

3. Table Management CLI Usage

3.1 List Tables

3.2 Retrieve Table Information

3.3 Create a Table

3.4 Read a DELTA Table

3.5 Write Sample Data to a DELTA Table

3.6 Delete a Table

4. Volume Management CLI Usage

4.1 List Volumes

4.2 Retrieve Volume Information

4.3 Create a Volume

4.4 Update a Volume

4.5 Read a Volume's content

4.6 Write Sample Data to a Volume

4.7 Delete a Volume

5. Function Management CLI Usage

5.1 List Functions

5.2 Retrieve Function Information

5.3 Create a Function

5.4 Invoke a Function

5.5 Delete a Function

6. Registered model and model version management

7. CLI Server Configuration

8. Manage Users

8.1 Create User

8.2 Delete User

8.3 Get User

8.4 List Users

8.5 Update User

9. Metastore Management CLI Usage

9.1 Get Metastore Information