databricks-oauth-client-id

--databricks-oauth-client-id is a global parameter for the Liquibase Pro Databricks extension. It specifies the Client ID for OAuth authentication on Databricks. The Client ID is the service principal's UUID or Application ID value.

This parameter is hidden in Liquibase logs, even if --log-level is FINE. It is not exposed in the database connection URL. Instead, Liquibase uses it as a driver parameter.

Specifying this parameter is required for OAuth authentication. It is available in the Liquibase Pro Databricks extension 1.0.0 and later.

Uses

You can connect Liquibase to your Databricks database using OAuth (Open Authorization). This parameter lets you specify some of your OAuth authentication details. For more guidance on authentication on Databricks, see Using Liquibase with Databricks SQL.

Syntax

You can set this parameter in the following ways:

Option Syntax
Liquibase properties file (defaults file)
liquibase.databricks.oauth.clientId: <string>
Global flow file argument (example)
stages:
  Default:
    actions:
      - type: liquibase
        command: update
        globalArgs: { databricks-oauth-client-id: "<string>" }
Global CLI parameter
liquibase
 --databricks-oauth-client-id=<string> update
 --changelog-file=example-changelog.xml

JVM system property (JAVA_OPTS Environment Variable)

Unix:

JAVA_OPTS=-Dliquibase.databricks.oauth.clientId=<string>

Windows:

JAVA_OPTS=-D"liquibase.databricks.oauth.clientId"=<string>
Liquibase Environment Variables
LIQUIBASE_DATABRICKS_OAUTH_CLIENT_ID=<string>

For more information, see Working with Command Parameters.

Related links