Skip to main content
Properties for Databricks connections are specified in the properties object when creating or updating a connection. All properties are nested within the connection request body.

​
Properties

Review the required connection properties for the authentication method you are using.
​
authType
string
required
Authentication method for your Databricks connection. Must be pat for Personal Access Token authentication.
​
jdbcUrl
string
required
JDBC connection URL for the Databricks SQL warehouse.Format: jdbc:databricks://{workspace - url}:{port}/{database};transportMode=http;ssl=1;AuthMech=3;httpPath={http - path};
​
catalog
string
required
Unity Catalog catalog name for the default write location.
​
schema
string
required
Schema name within the catalog for the default write location.
​
token
object
required
Reference to a Prophecy secret containing your Databricks Personal Access Token.
  • When using the create connection API, the secret must be stored in Prophecy before creating the connection.
  • When using the create fabric API, replace this whole object with the string {{SECRET}}, which references the secret being created in parallel to the connection.
​
kgConfig
object
Knowledge graph configuration settings for the connection. See the Knowledge graph indexer properties for more information.