Liquibase Parameters for Databricks

You can control the way Liquibase behaves when running commands on your Databricks database by setting Liquibase parameters. For example, you can use them to configure OAuth authentication.

For a list of general Liquibase parameters, see Liquibase Parameters.

For more information about Databricks, see Using Liquibase with Databricks Platforms. For a getting started tutorial, see Using Liquibase with Databricks SQL.

List of parameters

Note: Syntax for each parameter is specified in kebab-case (CLI and flow file), camelCase (properties file and JAVA_OPTS), and MACRO_CASE (environment variable).

Tip: For best results, specify all commands and parameters in the --kebab-case format in the CLI. If your preference is camelCase, it also works in the CLI.

Name (--cli, {flow-file}, propertiesFile, ENV_VAR) Type Description 
--databricks-auth-mechanism
globalArgs: {databricks-auth-mechanism: "val"}
liquibase.databricks.authMechanism
LIQUIBASE_DATABRICKS_AUTH_MECHANISM

Read more: --databricks-auth-mechanism

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the authentication mechanism for Liquibase to use with Databricks. Valid values are: OAUTH. If no value is specified, Liquibase tries to connect using a username and password.

 
--databricks-catalog
globalArgs: {databricks-catalog: "val"}
liquibase.databricks.catalog
LIQUIBASE_DATABRICKS_CATALOG

Read more: --databricks-catalog

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the catalog for Liquibase to use with Databricks.

 
--databricks-http-path
globalArgs: {databricks-http-path: "val"}
liquibase.databricks.httpPath
LIQUIBASE_DATABRICKS_HTTP_PATH

Read more: --databricks-http-path

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the HTTP path of the compute resource (a Databricks cluster or a Databricks SQL warehouse) for Liquibase to use.

 
--databricks-oauth-auth-flow
globalArgs: {databricks-oauth-auth-flow: "val"}
liquibase.databricks.oauth.authFlow
LIQUIBASE_DATABRICKS_OAUTH_AUTH_FLOW

Read more: --databricks-oauth-auth-flow

 Integer

Liquibase Pro Databricks extension 1.0.0+. Specifies the OAuth2 authentication flow for the Databricks driver connection. Valid values are: 1. Default: 1.

 
--databricks-oauth-client-id
globalArgs: {databricks-oauth-client-id: "val"}
liquibase.databricks.oauth.clientId
LIQUIBASE_DATABRICKS_OAUTH_CLIENT_ID

Read more: --databricks-oauth-client-id

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the Client ID for OAuth authentication on Databricks. The Client ID is the service principal's UUID or Application ID value.

 
--databricks-oauth-client-secret
globalArgs: {databricks-oauth-client-secret: "val"}
liquibase.databricks.oauth.clientSecret
LIQUIBASE_DATABRICKS_OAUTH_CLIENT_SECRET

Read more: --databricks-oauth-client-secret

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the Client Secret for OAuth authentication on Databricks. The Client Secret is the service principal's OAuth Secret value.

 
--databricks-schema
globalArgs: {databricks-schema: "val"}
liquibase.databricks.schema
LIQUIBASE_DATABRICKS_SCHEMA

Read more: --databricks-schema

 String

Liquibase Pro Databricks extension 1.0.0+. Specifies the schema for Liquibase to use with Databricks.