Skip to content

UnityCatalogCli

UnityCatalogCli can be launched on command line using ./bin/uc command-line utility.

Options

auth_token

Personal access token (PAT) to authorize requests

When specified, UnityCatalogCli creates an ApiClient (and a ControlClient) that adds the bearer token in the HTTP Authorization header to every request.

Authorization: Bearer [auth_token]

server

Default: http://localhost:8080

Launching Standalone Application

main creates an ApiClient and handles the command (specified as the first argument on command line).

Command Handler
auth AuthCli
catalog CatalogCli
function FunctionCli
metastore MetastoreCli
model_version ModelVersionCli
permission PermissionCli
registered_model ModelCli
schema SchemaCli
table TableCli
user UserCli
volume VolumeCli

Creating ApiClient

ApiClient getApiClient(
  CommandLine cmd)

getApiClient creates an ApiClient with the following:

Attribute Value
The host name of the UC service server option
The port number of the UC service The port from the server option, if specified, or one of the following:
  • 443 for https scheme
  • 8080 for http scheme

Logging

UnityCatalogCli uses etc/conf/cli.log4j2.properties as the logging configuration file (via log4j.configurationFile configuration property).