Properties required to create and update Databricks connections
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.
PAT
U2M
M2M
OIDC
string
required
Authentication method for your Databricks connection. Must be pat for Personal Access Token authentication.
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};
string
required
Unity Catalog catalog name for the default write location.
string
required
Schema name within the catalog for the default write location.
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.
Show token properties
string
required
Secret kind. Must be prophecy.
string
required
Secret sub-type. Must be text for Personal Access Tokens.
Knowledge graph configuration settings for the connection. See the Knowledge graph
indexer properties for more information.
string
required
Authentication method for your Databricks connection. Must be oauth for OAuth authentication.
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};
string
required
Unity Catalog catalog name for the default write location.
string
required
Schema name within the catalog for the default write location.
string
required
Provider name. Must be databricks.
string
required
OAuth authentication type. Must be m2m for machine-to-machine authentication.
string
required
Your OAuth client ID.
object
required
Reference to a Prophecy secret containing the OAuth client secret.
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.
Knowledge graph configuration settings for the connection. See the Knowledge graph
indexer properties for more information.
string
required
Authentication method for your Databricks connection. Must be oidc for OIDC authentication.
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};
string
required
Unity Catalog catalog name for the default write location.
string
required
Schema name within the catalog for the default write location.
string
required
URL of the token issuer.
string
required
Resource that the token is requested for.
string
required
Client ID of the service principal.
object
Reference to a Prophecy secret containing the service principal client secret. Optional, because the certificate and private key authenticate the service principal.
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.
Reference to a Prophecy secret containing the service principal’s PEM certificate.
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.
Reference to a Prophecy secret containing the service principal’s PEM private key.
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.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Prophecy Documentation","colors":{"primary":"#4c4ddc","light":"#a7b5f6","dark":"#30317c"},"logo":{"light":"https://mintcdn.com/prophecy-62973bd0/lcN2OD-DxXqbYTCG/images/logo/logo-light.png?fit=max\u0026auto=format\u0026n=lcN2OD-DxXqbYTCG\u0026q=85\u0026s=562c39e11224578b41fff31c8ba18da4","dark":"https://mintcdn.com/prophecy-62973bd0/lcN2OD-DxXqbYTCG/images/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=lcN2OD-DxXqbYTCG\u0026q=85\u0026s=d061567d81de4dab338413e9a5a70291"},"favicon":"https://mintcdn.com/prophecy-62973bd0/5tvw_2e98LqB5rz7/favicon.png?fit=max\u0026auto=format\u0026n=5tvw_2e98LqB5rz7\u0026q=85\u0026s=c28005e2ace2bd1029bbff785a81784b","api":{"playground":{"display":"simple"},"mdx":{"server":"https://app.prophecy.io/"}},"navbar":{"links":[{"href":"mailto:docs@prophecy.io","label":"Feedback"}],"primary":{"type":"button","label":"Try Prophecy","href":"https://app.prophecy.ai/metadata/auth/signup"}},"footer":{},"integrations":{"clarity":{"projectId":"ybniugwxfu"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"prophecy-62973bd0","hasAudioNarration":false,"actualSubdomain":"prophecy-62973bd0","customDomains":["docs.prophecy.ai"],"gitSource":{"type":"github","owner":"prophecy-io","repo":"prophecy-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af209fe25a27df1d277e9c8","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Data Engineering","count":317},{"language":"default","tag":"Data Analysis","count":237},{"language":"default","tag":"Documentation","count":201},{"language":"default","tag":"Gem reference","count":181},{"language":"default","tag":"Sources and targets","count":75},{"language":"default","tag":"Import \u0026 Migrate","count":71},{"language":"default","tag":"Data processing","count":66},{"language":"default","tag":"API reference","count":57},{"language":"default","tag":"Endpoints","count":54},{"language":"default","tag":"Build and inspect pipelines","count":46}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".table-example{overflow:hidden;max-width:100%}.table-example [data-table-wrapper=\"true\"]{overflow:hidden!important;max-width:100%!important;width:100%!important;margin-top:0.5em!important;margin-bottom:0.5em!important;padding-top:0.5em!important;padding-bottom:0.5em!important;margin-left:0!important;margin-right:0!important}.table-example [data-table-wrapper=\"true\"]>div{max-width:100%!important;width:100%!important;padding-left:0!important;padding-right:0!important}.table-example table{width:100%!important;max-width:100%!important;min-width:0!important;table-layout:auto;border:1px solid #d1d5db;border-collapse:collapse;border-radius:6px;overflow:hidden;background-color:#ffffff;box-shadow:0 1px 3px rgba(0, 0, 0, 0.1)}.table-example table td,.table-example table th{min-width:0!important;word-wrap:break-word;overflow-wrap:break-word}.table-example thead{background-color:#f9fafb;border-bottom:2px solid #e5e7eb}.table-example thead th{padding:8px 12px;font-weight:600;text-align:left;border-bottom:2px solid #e5e7eb}.table-example tbody{font-family:monospace}.table-example tbody td{padding:8px 12px;border-bottom:1px solid #f3f4f6}.table-example tbody tr:nth-child(even){font-family:monospace;background-color:#f9fafb}.table-example tbody tr:last-child td{border-bottom:none}[data-component-part=\"callout-icon\"] img{height:auto!important}.nav-dropdown-item-icon{background-color:#e1e7fd}.dark .nav-dropdown-item-icon{background-color:#a7b5f6}#search-bar-entry,#search-bar-entry-mobile{border-radius:12px}#search-input{border-radius:12px}"}],"page":{"pagePath":"api-reference/connections/properties/databricks","slug":"/api-reference/connections/properties/databricks","pageMetadata":{"title":"Databricks","description":"Properties required to create and update Databricks connections","href":"/api-reference/connections/properties/databricks"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Properties required to create and update Databricks connections\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,ul:`ul`,..._provideComponents(),...props.components},{Expandable,Heading,ParamField,Tab,Tabs}=_components;if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Properties for Databricks connections are specified in the `,_jsx(_components.code,{children:`properties`}),` object when creating or updating a connection. All properties are nested within the connection request body.`]}),`\n`,_jsx(Heading,{level:`2`,id:`properties`,children:`Properties`}),`\n`,_jsx(_components.p,{children:`Review the required connection properties for the authentication method you are using.`}),`\n`,_jsxs(Tabs,{children:[_jsxs(Tab,{title:`PAT`,id:`pat`,children:[_jsx(ParamField,{body:`authType`,type:`string`,required:true,id:`param-auth-type`,children:_jsxs(_components.p,{children:[`Authentication method for your Databricks connection. Must be `,_jsx(_components.code,{children:`pat`}),` for Personal Access Token authentication.`]})}),_jsxs(ParamField,{body:`jdbcUrl`,type:`string`,required:true,id:`param-jdbc-url`,children:[_jsx(_components.p,{children:`JDBC connection URL for the Databricks SQL warehouse.`}),_jsxs(_components.p,{children:[`Format: `,_jsx(_components.code,{children:`jdbc:databricks://{workspace - url}:{port}/{database};transportMode=http;ssl=1;AuthMech=3;httpPath={http - path};`})]})]}),_jsx(ParamField,{body:`catalog`,type:`string`,required:true,id:`param-catalog`,children:_jsx(_components.p,{children:`Unity Catalog catalog name for the default write location.`})}),_jsx(ParamField,{body:`schema`,type:`string`,required:true,id:`param-schema`,children:_jsx(_components.p,{children:`Schema name within the catalog for the default write location.`})}),_jsxs(ParamField,{body:`token`,type:`object`,required:true,id:`param-token`,children:[_jsx(_components.p,{children:`Reference to a Prophecy secret containing your Databricks Personal Access Token.`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/connections/add-connection-to-fabric`,children:`create connection API`}),`, the secret must be stored in Prophecy before creating the connection.`]}),`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/fabrics/create-a-new-fabric`,children:`create fabric API`}),`, replace this whole object with the string `,_jsx(_components.code,{children:`{{SECRET}}`}),`, which references the secret being created in parallel to the connection.`]}),`\n`]}),_jsxs(Expandable,{title:`token properties`,children:[_jsx(ParamField,{body:`token.kind`,type:`string`,required:true,id:`param-token-kind`,children:_jsxs(_components.p,{children:[`Secret kind. Must be `,_jsx(_components.code,{children:`prophecy`}),`.`]})}),_jsx(ParamField,{body:`token.subKind`,type:`string`,required:true,id:`param-token-sub-kind`,children:_jsxs(_components.p,{children:[`Secret sub-type. Must be `,_jsx(_components.code,{children:`text`}),` for Personal Access Tokens.`]})}),_jsx(ParamField,{body:`token.type`,type:`string`,required:true,id:`param-token-type`,children:_jsxs(_components.p,{children:[`Type of reference. Must be `,_jsx(_components.code,{children:`secret`}),`.`]})}),_jsx(ParamField,{body:`token.properties`,type:`object`,required:true,id:`param-token-properties`,children:_jsx(_components.p,{children:`Properties identifying the secret by ID and name.`})}),_jsx(ParamField,{body:`token.properties.id`,type:`string`,required:true,id:`param-token-properties-id`,children:_jsxs(_components.p,{children:[`The ID of the secret stored in Prophecy. Find the ID using the `,_jsx(_components.a,{href:`/api-reference/secrets/list-secrets-per-fabric`,children:`List secrets per fabric\nAPI`}),`.`]})}),_jsx(ParamField,{body:`token.properties.name`,type:`string`,required:true,id:`param-token-properties-name`,children:_jsx(_components.p,{children:`The name of the secret stored in Prophecy.`})})]})]}),_jsx(ParamField,{body:`kgConfig`,type:`object`,id:`param-kg-config`,children:_jsxs(_components.p,{children:[`Knowledge graph configuration settings for the connection. See the `,_jsx(_components.a,{href:`/api-reference/connections/properties/kgconfig`,children:`Knowledge graph\nindexer`}),` properties for more information.`]})})]}),_jsxs(Tab,{title:`U2M`,id:`u2m`,children:[_jsx(ParamField,{body:`authType`,type:`string`,required:true,id:`param-auth-type-1`,children:_jsxs(_components.p,{children:[`Authentication method for your Databricks connection. Must be `,_jsx(_components.code,{children:`oauth`}),` for OAuth authentication.`]})}),_jsxs(ParamField,{body:`jdbcUrl`,type:`string`,required:true,id:`param-jdbc-url-1`,children:[_jsx(_components.p,{children:`JDBC connection URL for the Databricks SQL warehouse.`}),_jsxs(_components.p,{children:[`Format: `,_jsx(_components.code,{children:`jdbc:databricks://{workspace - url}:{port}/{database};transportMode=http;ssl=1;AuthMech=3;httpPath={http - path};`})]})]}),_jsx(ParamField,{body:`catalog`,type:`string`,required:true,id:`param-catalog-1`,children:_jsx(_components.p,{children:`Unity Catalog catalog name for the default write location.`})}),_jsx(ParamField,{body:`schema`,type:`string`,required:true,id:`param-schema-1`,children:_jsx(_components.p,{children:`Schema name within the catalog for the default write location.`})}),_jsx(ParamField,{body:`provider`,type:`string`,required:true,id:`param-provider`,children:_jsxs(_components.p,{children:[`Provider name. Must be `,_jsx(_components.code,{children:`databricks`}),`.`]})}),_jsx(ParamField,{body:`oAuthType`,type:`string`,required:true,id:`param-o-auth-type`,children:_jsxs(_components.p,{children:[`OAuth authentication type. Must be `,_jsx(_components.code,{children:`u2m`}),` for user-to-machine authentication.`]})}),_jsx(ParamField,{body:`oAuthAppRegistrationID`,type:`string`,required:true,id:`param-o-auth-app-registration-id`,children:_jsxs(_components.p,{children:[`OAuth app registration ID `,_jsx(_components.a,{href:`/data-analysis/administration/management/cluster-admin-settings/oauth-setup`,children:`configured in Prophecy`}),` for Databricks.`]})}),_jsx(ParamField,{body:`kgConfig`,type:`object`,id:`param-kg-config-1`,children:_jsxs(_components.p,{children:[`Knowledge graph configuration settings for the connection. See the `,_jsx(_components.a,{href:`/api-reference/connections/properties/kgconfig`,children:`Knowledge graph\nindexer`}),` properties for more information.`]})})]}),_jsxs(Tab,{title:`M2M`,id:`m2m`,children:[_jsx(ParamField,{body:`authType`,type:`string`,required:true,id:`param-auth-type-2`,children:_jsxs(_components.p,{children:[`Authentication method for your Databricks connection. Must be `,_jsx(_components.code,{children:`oauth`}),` for OAuth authentication.`]})}),_jsxs(ParamField,{body:`jdbcUrl`,type:`string`,required:true,id:`param-jdbc-url-2`,children:[_jsx(_components.p,{children:`JDBC connection URL for the Databricks SQL warehouse.`}),_jsxs(_components.p,{children:[`Format: `,_jsx(_components.code,{children:`jdbc:databricks://{workspace - url}:{port}/{database};transportMode=http;ssl=1;AuthMech=3;httpPath={http - path};`})]})]}),_jsx(ParamField,{body:`catalog`,type:`string`,required:true,id:`param-catalog-2`,children:_jsx(_components.p,{children:`Unity Catalog catalog name for the default write location.`})}),_jsx(ParamField,{body:`schema`,type:`string`,required:true,id:`param-schema-2`,children:_jsx(_components.p,{children:`Schema name within the catalog for the default write location.`})}),_jsx(ParamField,{body:`provider`,type:`string`,required:true,id:`param-provider-1`,children:_jsxs(_components.p,{children:[`Provider name. Must be `,_jsx(_components.code,{children:`databricks`}),`.`]})}),_jsx(ParamField,{body:`oAuthType`,type:`string`,required:true,id:`param-o-auth-type-1`,children:_jsxs(_components.p,{children:[`OAuth authentication type. Must be `,_jsx(_components.code,{children:`m2m`}),` for machine-to-machine authentication.`]})}),_jsx(ParamField,{body:`clientId`,type:`string`,required:true,id:`param-client-id`,children:_jsx(_components.p,{children:`Your OAuth client ID.`})}),_jsxs(ParamField,{body:`clientSecret`,type:`object`,required:true,id:`param-client-secret`,children:[_jsx(_components.p,{children:`Reference to a Prophecy secret containing the OAuth client secret.`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/connections/add-connection-to-fabric`,children:`create connection API`}),`, the secret must be stored in Prophecy before creating the connection.`]}),`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/fabrics/create-a-new-fabric`,children:`create fabric API`}),`, replace this whole object with the string `,_jsx(_components.code,{children:`{{SECRET}}`}),`, which references the secret being created in parallel to the connection.`]}),`\n`]}),_jsxs(Expandable,{title:`clientSecret properties`,children:[_jsx(ParamField,{body:`clientSecret.kind`,type:`string`,required:true,id:`param-client-secret-kind`,children:_jsxs(_components.p,{children:[`Secret kind. Must be `,_jsx(_components.code,{children:`prophecy`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.subKind`,type:`string`,required:true,id:`param-client-secret-sub-kind`,children:_jsxs(_components.p,{children:[`Secret sub-type. Must be `,_jsx(_components.code,{children:`text`}),` for client secrets.`]})}),_jsx(ParamField,{body:`clientSecret.type`,type:`string`,required:true,id:`param-client-secret-type`,children:_jsxs(_components.p,{children:[`Type of reference. Must be `,_jsx(_components.code,{children:`secret`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.properties`,type:`object`,required:true,id:`param-client-secret-properties`,children:_jsx(_components.p,{children:`Properties identifying the secret by ID and name.`})}),_jsx(ParamField,{body:`clientSecret.properties.id`,type:`string`,required:true,id:`param-client-secret-properties-id`,children:_jsxs(_components.p,{children:[`The ID of the secret stored in Prophecy. Find the ID using the `,_jsx(_components.a,{href:`/api-reference/secrets/list-secrets-per-fabric`,children:`List secrets per fabric\nAPI`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.properties.name`,type:`string`,required:true,id:`param-client-secret-properties-name`,children:_jsx(_components.p,{children:`The name of the secret stored in Prophecy.`})})]})]}),_jsx(ParamField,{body:`kgConfig`,type:`object`,id:`param-kg-config-2`,children:_jsxs(_components.p,{children:[`Knowledge graph configuration settings for the connection. See the `,_jsx(_components.a,{href:`/api-reference/connections/properties/kgconfig`,children:`Knowledge graph\nindexer`}),` properties for more information.`]})})]}),_jsxs(Tab,{title:`OIDC`,id:`oidc`,children:[_jsx(ParamField,{body:`authType`,type:`string`,required:true,id:`param-auth-type-3`,children:_jsxs(_components.p,{children:[`Authentication method for your Databricks connection. Must be `,_jsx(_components.code,{children:`oidc`}),` for OIDC authentication.`]})}),_jsxs(ParamField,{body:`jdbcUrl`,type:`string`,required:true,id:`param-jdbc-url-3`,children:[_jsx(_components.p,{children:`JDBC connection URL for the Databricks SQL warehouse.`}),_jsxs(_components.p,{children:[`Format: `,_jsx(_components.code,{children:`jdbc:databricks://{workspace - url}:{port}/{database};transportMode=http;ssl=1;AuthMech=3;httpPath={http - path};`})]})]}),_jsx(ParamField,{body:`catalog`,type:`string`,required:true,id:`param-catalog-3`,children:_jsx(_components.p,{children:`Unity Catalog catalog name for the default write location.`})}),_jsx(ParamField,{body:`schema`,type:`string`,required:true,id:`param-schema-3`,children:_jsx(_components.p,{children:`Schema name within the catalog for the default write location.`})}),_jsx(ParamField,{body:`authServerUrl`,type:`string`,required:true,id:`param-auth-server-url`,children:_jsx(_components.p,{children:`URL of the token issuer.`})}),_jsx(ParamField,{body:`resource`,type:`string`,required:true,id:`param-resource`,children:_jsx(_components.p,{children:`Resource that the token is requested for.`})}),_jsx(ParamField,{body:`clientId`,type:`string`,required:true,id:`param-client-id-1`,children:_jsx(_components.p,{children:`Client ID of the service principal.`})}),_jsxs(ParamField,{body:`clientSecret`,type:`object`,id:`param-client-secret-1`,children:[_jsx(_components.p,{children:`Reference to a Prophecy secret containing the service principal client secret. Optional, because the certificate and private key authenticate the service principal.`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/connections/add-connection-to-fabric`,children:`create connection API`}),`, the secret must be stored in Prophecy before creating the connection.`]}),`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/fabrics/create-a-new-fabric`,children:`create fabric API`}),`, replace this whole object with the string `,_jsx(_components.code,{children:`{{SECRET}}`}),`, which references the secret being created in parallel to the connection.`]}),`\n`]}),_jsxs(Expandable,{title:`clientSecret properties`,children:[_jsx(ParamField,{body:`clientSecret.kind`,type:`string`,required:true,id:`param-client-secret-kind-1`,children:_jsxs(_components.p,{children:[`Secret kind. Must be `,_jsx(_components.code,{children:`prophecy`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.subKind`,type:`string`,required:true,id:`param-client-secret-sub-kind-1`,children:_jsxs(_components.p,{children:[`Secret sub-type, such as `,_jsx(_components.code,{children:`text`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.type`,type:`string`,required:true,id:`param-client-secret-type-1`,children:_jsxs(_components.p,{children:[`Type of reference. Must be `,_jsx(_components.code,{children:`secret`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.properties`,type:`object`,required:true,id:`param-client-secret-properties-1`,children:_jsx(_components.p,{children:`Properties identifying the secret by ID and name.`})}),_jsx(ParamField,{body:`clientSecret.properties.id`,type:`string`,required:true,id:`param-client-secret-properties-id-1`,children:_jsxs(_components.p,{children:[`The ID of the secret stored in Prophecy. Find the ID using the `,_jsx(_components.a,{href:`/api-reference/secrets/list-secrets-per-fabric`,children:`List secrets per fabric\nAPI`}),`.`]})}),_jsx(ParamField,{body:`clientSecret.properties.name`,type:`string`,required:true,id:`param-client-secret-properties-name-1`,children:_jsx(_components.p,{children:`The name of the secret stored in Prophecy.`})})]})]}),_jsxs(ParamField,{body:`certificate`,type:`object`,required:true,id:`param-certificate`,children:[_jsx(_components.p,{children:`Reference to a Prophecy secret containing the service principal’s PEM certificate.`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/connections/add-connection-to-fabric`,children:`create connection API`}),`, the secret must be stored in Prophecy before creating the connection.`]}),`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/fabrics/create-a-new-fabric`,children:`create fabric API`}),`, replace this whole object with the string `,_jsx(_components.code,{children:`{{SECRET}}`}),`, which references the secret being created in parallel to the connection.`]}),`\n`]}),_jsxs(Expandable,{title:`certificate properties`,children:[_jsx(ParamField,{body:`certificate.kind`,type:`string`,required:true,id:`param-certificate-kind`,children:_jsxs(_components.p,{children:[`Secret kind. Must be `,_jsx(_components.code,{children:`prophecy`}),`.`]})}),_jsx(ParamField,{body:`certificate.subKind`,type:`string`,required:true,id:`param-certificate-sub-kind`,children:_jsxs(_components.p,{children:[`Secret sub-type, such as `,_jsx(_components.code,{children:`text`}),`.`]})}),_jsx(ParamField,{body:`certificate.type`,type:`string`,required:true,id:`param-certificate-type`,children:_jsxs(_components.p,{children:[`Type of reference. Must be `,_jsx(_components.code,{children:`secret`}),`.`]})}),_jsx(ParamField,{body:`certificate.properties`,type:`object`,required:true,id:`param-certificate-properties`,children:_jsx(_components.p,{children:`Properties identifying the secret by ID and name.`})}),_jsx(ParamField,{body:`certificate.properties.id`,type:`string`,required:true,id:`param-certificate-properties-id`,children:_jsxs(_components.p,{children:[`The ID of the secret stored in Prophecy. Find the ID using the `,_jsx(_components.a,{href:`/api-reference/secrets/list-secrets-per-fabric`,children:`List secrets per fabric\nAPI`}),`.`]})}),_jsx(ParamField,{body:`certificate.properties.name`,type:`string`,required:true,id:`param-certificate-properties-name`,children:_jsx(_components.p,{children:`The name of the secret stored in Prophecy.`})})]})]}),_jsxs(ParamField,{body:`privateKey`,type:`object`,required:true,id:`param-private-key`,children:[_jsx(_components.p,{children:`Reference to a Prophecy secret containing the service principal’s PEM private key.`}),_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/connections/add-connection-to-fabric`,children:`create connection API`}),`, the secret must be stored in Prophecy before creating the connection.`]}),`\n`,_jsxs(_components.li,{children:[`When using the `,_jsx(_components.a,{href:`/api-reference/fabrics/create-a-new-fabric`,children:`create fabric API`}),`, replace this whole object with the string `,_jsx(_components.code,{children:`{{SECRET}}`}),`, which references the secret being created in parallel to the connection.`]}),`\n`]}),_jsxs(Expandable,{title:`privateKey properties`,children:[_jsx(ParamField,{body:`privateKey.kind`,type:`string`,required:true,id:`param-private-key-kind`,children:_jsxs(_components.p,{children:[`Secret kind. Must be `,_jsx(_components.code,{children:`prophecy`}),`.`]})}),_jsx(ParamField,{body:`privateKey.subKind`,type:`string`,required:true,id:`param-private-key-sub-kind`,children:_jsxs(_components.p,{children:[`Secret sub-type, such as `,_jsx(_components.code,{children:`text`}),`.`]})}),_jsx(ParamField,{body:`privateKey.type`,type:`string`,required:true,id:`param-private-key-type`,children:_jsxs(_components.p,{children:[`Type of reference. Must be `,_jsx(_components.code,{children:`secret`}),`.`]})}),_jsx(ParamField,{body:`privateKey.properties`,type:`object`,required:true,id:`param-private-key-properties`,children:_jsx(_components.p,{children:`Properties identifying the secret by ID and name.`})}),_jsx(ParamField,{body:`privateKey.properties.id`,type:`string`,required:true,id:`param-private-key-properties-id`,children:_jsxs(_components.p,{children:[`The ID of the secret stored in Prophecy. Find the ID using the `,_jsx(_components.a,{href:`/api-reference/secrets/list-secrets-per-fabric`,children:`List secrets per fabric\nAPI`}),`.`]})}),_jsx(ParamField,{body:`privateKey.properties.name`,type:`string`,required:true,id:`param-private-key-properties-name`,children:_jsx(_components.p,{children:`The name of the secret stored in Prophecy.`})})]})]}),_jsx(ParamField,{body:`kgConfig`,type:`object`,id:`param-kg-config-3`,children:_jsxs(_components.p,{children:[`Knowledge graph configuration settings for the connection. See the `,_jsx(_components.a,{href:`/api-reference/connections/properties/kgconfig`,children:`Knowledge graph\nindexer`}),` properties for more information.`]})})]})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Databricks","description":"Properties required to create and update Databricks connections","href":"/api-reference/connections/properties/databricks"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Properties","slug":"properties","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/prophecy-62973bd0/3ea86f2109c2be36/inkeep.js","/_mintlify/custom/prophecy-62973bd0/8701664ef6557ce5/fullstory.js"],"subdomain":"prophecy-62973bd0","siteName":"Prophecy Documentation","title":"Databricks - Prophecy Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T13:37:30.011Z","originalFileLocation":"api-reference/connections/properties/databricks.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Properties required to create and update Databricks connections\">\u003cmeta data-mint-head name=\"application-name\" content=\"Prophecy Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Databricks - Prophecy Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Properties required to create and update Databricks connections\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Prophecy Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.prophecy.ai/api-reference/connections/properties/databricks\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://prophecy-62973bd0.mintlify.site/_mintlify/api/og/v2?division=Properties\u0026amp;title=Databricks\u0026amp;description=Properties+required+to+create+and+update+Databricks+connections\u0026amp;theme=cd5554f49f0aca103ab5fb5f\u0026amp;signature=367481afc4e204874889a1bd5f8f86441c636dff8620725b9fed25d0047ae5e7\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Databricks - Prophecy Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Properties required to create and update Databricks connections\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://prophecy-62973bd0.mintlify.site/_mintlify/api/og/v2?division=Properties\u0026amp;title=Databricks\u0026amp;description=Properties+required+to+create+and+update+Databricks+connections\u0026amp;theme=cd5554f49f0aca103ab5fb5f\u0026amp;signature=367481afc4e204874889a1bd5f8f86441c636dff8620725b9fed25d0047ae5e7\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/prophecy-62973bd0/e3HT_1xvO76PQAUr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Prophecy Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4c4ddc\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.prophecy.ai/api-reference/connections/properties/databricks\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/connections/properties/databricks.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.prophecy.ai/#organization\",\"name\":\"Prophecy Documentation\",\"url\":\"https://docs.prophecy.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/prophecy-62973bd0/lcN2OD-DxXqbYTCG/images/logo/logo-light.png?fit=max\u0026auto=format\u0026n=lcN2OD-DxXqbYTCG\u0026q=85\u0026s=562c39e11224578b41fff31c8ba18da4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.prophecy.ai#website\",\"name\":\"Prophecy Documentation\",\"url\":\"https://docs.prophecy.ai\",\"publisher\":{\"@id\":\"https://docs.prophecy.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks#webpage\",\"url\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks\",\"name\":\"Databricks\",\"description\":\"Properties required to create and update Databricks connections\",\"dateModified\":\"2026-10-30T13:37:30.011Z\",\"isPartOf\":{\"@id\":\"https://docs.prophecy.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.prophecy.ai/api-reference/users/get-current-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connections\",\"item\":\"https://docs.prophecy.ai/api-reference/connections/properties/redshift\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Properties\",\"item\":\"https://docs.prophecy.ai/api-reference/connections/properties/redshift\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Databricks\",\"item\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks#article\",\"headline\":\"Databricks\",\"name\":\"Databricks\",\"description\":\"Properties required to create and update Databricks connections\",\"url\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks\",\"mainEntityOfPage\":{\"@id\":\"https://docs.prophecy.ai/api-reference/connections/properties/databricks#webpage\"},\"dateModified\":\"2026-10-30T13:37:30.011Z\",\"publisher\":{\"@id\":\"https://docs.prophecy.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.prophecy.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Prophecy Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Prophecy Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/connections/properties/databricks.md","siteName":"Prophecy Documentation","nav":{"global":null,"dropdowns":[{"dropdown":"Data Analysis","icon":"https://mintlify.s3.us-west-1.amazonaws.com/prophecy-62973bd0/images/bar-chart-j.svg","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"Gem reference","pages":[{"title":"Gem reference","href":"/data-analysis/gems/gems"}]},{"tab":"Import \u0026 Migrate","pages":[{"title":"Import \u0026 Migrate","href":"/import-tool"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Prophecy API","href":"/api-reference/introduction"},{"title":"End-to-end API workflow","href":"/api-reference/end-to-end-workflow"},{"title":"GraphQL API","href":"/api-reference/graphql"}]},{"group":"Endpoints","pages":[{"group":"Users and teams","pages":[{"openapi":"get /api/get-user","title":"Get current user","href":"/api-reference/users/get-current-user"},{"openapi":"post /api/auth/inviteUsers","title":"Add users to teams","href":"/api-reference/users/invite-users"},{"title":"Create team","href":"/api-reference/teams/create-team"},{"title":"Get team members","href":"/api-reference/teams/get-team-members"}]},{"group":"Fabrics","pages":[{"openapi":"post /api/orchestration/fabric","title":"Create a new fabric","href":"/api-reference/fabrics/create-a-new-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}","title":"Get fabric details","href":"/api-reference/fabrics/get-fabric-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}","title":"Update an existing fabric","href":"/api-reference/fabrics/update-an-existing-fabric"},{"openapi":"delete /api/orchestration/fabric/{fabricId}","title":"Delete a fabric","href":"/api-reference/fabrics/delete-a-fabric"}]},{"group":"Connections","pages":[{"group":"Properties","pages":[{"title":"Amazon Redshift connection properties API","href":"/api-reference/connections/properties/redshift"},{"title":"Amazon S3 connection properties API","href":"/api-reference/connections/properties/s3"},{"title":"Azure Data Lake Storage connection properties API","href":"/api-reference/connections/properties/adls"},{"title":"Azure Synapse connection properties API","href":"/api-reference/connections/properties/synapse"},{"title":"Google BigQuery","href":"/api-reference/connections/properties/bigquery"},{"title":"Google Cloud Storage connection properties API","description":"Properties required to create and update GCS connections","href":"/api-reference/connections/properties/gcs"},{"title":"Databricks","href":"/api-reference/connections/properties/databricks"},{"title":"Microsoft SQL Server","description":"Properties required to create and update MSSQL connections","href":"/api-reference/connections/properties/mssql"},{"title":"Microsoft OneDrive connection properties API","href":"/api-reference/connections/properties/onedrive"},{"title":"Microsoft Power BI connection properties API","href":"/api-reference/connections/properties/power-bi"},{"title":"Microsoft SharePoint connection properties API","href":"/api-reference/connections/properties/sharepoint"},{"title":"MongoDB connection properties API","href":"/api-reference/connections/properties/mongodb"},{"title":"Oracle connection properties API","href":"/api-reference/connections/properties/oracle"},{"title":"Postgres","href":"/api-reference/connections/properties/postgres"},{"title":"Salesforce connection properties API","href":"/api-reference/connections/properties/salesforce"},{"title":"SAP HANA","href":"/api-reference/connections/properties/hana"},{"title":"SFTP connection properties API","href":"/api-reference/connections/properties/sftp"},{"title":"Smartsheet connection properties API","href":"/api-reference/connections/properties/smartsheet"},{"title":"SMTP connection properties API","href":"/api-reference/connections/properties/smpt"},{"title":"Snowflake connection properties API","href":"/api-reference/connections/properties/snowflake"},{"title":"Tableau connection properties API","href":"/api-reference/connections/properties/tableau"}]},{"title":"Knowledge graph indexer connection properties API","href":"/api-reference/connections/properties/kgconfig"},{"openapi":"post /api/orchestration/fabric/{fabricId}/connection","title":"Add connection to fabric","href":"/api-reference/connections/add-connection-to-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/connection","title":"List connections per fabric","href":"/api-reference/connections/list-connections-per-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Retrieve connection details","href":"/api-reference/connections/retrieve-connection-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Update connection","href":"/api-reference/connections/update-connection"},{"openapi":"delete /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Delete connection","href":"/api-reference/connections/delete-connection"}]},{"group":"Secrets","pages":[{"group":"Properties","pages":[{"title":"Text","href":"/api-reference/secrets/properties/text"},{"title":"Binary","href":"/api-reference/secrets/properties/binary"},{"title":"Username Password","href":"/api-reference/secrets/properties/username-password"},{"title":"M2M OAuth","href":"/api-reference/secrets/properties/oauth"}]},{"openapi":"post /api/orchestration/fabric/{fabricId}/secret","title":"Add secret to fabric","href":"/api-reference/secrets/add-secret-to-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/secret","title":"List secrets per fabric","href":"/api-reference/secrets/list-secrets-per-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Retrieve secret details","href":"/api-reference/secrets/retrieve-secret-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Update secret","href":"/api-reference/secrets/update-secret"},{"openapi":"delete /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Delete secret","href":"/api-reference/secrets/delete-secret"}]},{"group":"Projects","pages":[{"title":"Create project","href":"/api-reference/projects/create-project"},{"title":"Commit changes","href":"/api-reference/projects/commit-changes"},{"title":"Publish release","href":"/api-reference/projects/publish-release"},{"title":"List releases","href":"/api-reference/projects/list-releases"},{"openapi":"post /api/deploy/project","title":"Deploy project","href":"/api-reference/projects/deploy-project"}]},{"group":"Pipelines","pages":[{"openapi":"post /api/editor/sqlEditor/pipeline/create","title":"Create pipeline","href":"/api-reference/pipelines/create-pipeline"},{"openapi":"post /api/trigger/pipeline","title":"Trigger pipeline run","href":"/api-reference/pipelines/trigger-pipeline-run"},{"openapi":"get /api/trigger/pipeline/{runId}","title":"Get pipeline run status","href":"/api-reference/pipelines/get-pipeline-run-status"},{"openapi":"post /api/trigger/pipeline/{runId}/cancel","title":"Cancel pipeline run","href":"/api-reference/pipelines/cancel-pipeline-run"},{"openapi":"post /api/orchestration/tests/run","title":"Run data tests","href":"/api-reference/pipelines/run-data-tests"}]}]}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/administration/platform/editions"}]},{"tab":"Releases","pages":[{"title":"Releases","href":"/releases/2026"}]}]},{"dropdown":"Data Engineering","icon":"https://mintlify.s3.us-west-1.amazonaws.com/prophecy-62973bd0/images/code-square-a.svg","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/data-engineering/getting-started/quick-start"}]},{"tab":"Gem reference","pages":[{"title":"Gem reference","href":"/data-engineering/gems/gems"}]},{"tab":"Import \u0026 Migrate","pages":[{"title":"Import \u0026 Migrate","href":"/import-tool"}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"Prophecy API","href":"/api-reference/introduction"},{"title":"End-to-end API workflow","href":"/api-reference/end-to-end-workflow"},{"title":"GraphQL API","href":"/api-reference/graphql"}]},{"group":"Endpoints","pages":[{"group":"Users and teams","pages":[{"openapi":"get /api/get-user","title":"Get current user","href":"/api-reference/users/get-current-user"},{"openapi":"post /api/auth/inviteUsers","title":"Add users to teams","href":"/api-reference/users/invite-users"},{"title":"Create team","href":"/api-reference/teams/create-team"},{"title":"Get team members","href":"/api-reference/teams/get-team-members"}]},{"group":"Fabrics","pages":[{"openapi":"post /api/orchestration/fabric","title":"Create a new fabric","href":"/api-reference/fabrics/create-a-new-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}","title":"Get fabric details","href":"/api-reference/fabrics/get-fabric-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}","title":"Update an existing fabric","href":"/api-reference/fabrics/update-an-existing-fabric"},{"openapi":"delete /api/orchestration/fabric/{fabricId}","title":"Delete a fabric","href":"/api-reference/fabrics/delete-a-fabric"}]},{"group":"Connections","pages":[{"group":"Properties","pages":[{"title":"Amazon Redshift connection properties API","href":"/api-reference/connections/properties/redshift"},{"title":"Amazon S3 connection properties API","href":"/api-reference/connections/properties/s3"},{"title":"Azure Data Lake Storage connection properties API","href":"/api-reference/connections/properties/adls"},{"title":"Azure Synapse connection properties API","href":"/api-reference/connections/properties/synapse"},{"title":"Google BigQuery","href":"/api-reference/connections/properties/bigquery"},{"title":"Google Cloud Storage connection properties API","description":"Properties required to create and update GCS connections","href":"/api-reference/connections/properties/gcs"},{"title":"Databricks","href":"/api-reference/connections/properties/databricks"},{"title":"Microsoft SQL Server","description":"Properties required to create and update MSSQL connections","href":"/api-reference/connections/properties/mssql"},{"title":"Microsoft OneDrive connection properties API","href":"/api-reference/connections/properties/onedrive"},{"title":"Microsoft Power BI connection properties API","href":"/api-reference/connections/properties/power-bi"},{"title":"Microsoft SharePoint connection properties API","href":"/api-reference/connections/properties/sharepoint"},{"title":"MongoDB connection properties API","href":"/api-reference/connections/properties/mongodb"},{"title":"Oracle connection properties API","href":"/api-reference/connections/properties/oracle"},{"title":"Postgres","href":"/api-reference/connections/properties/postgres"},{"title":"Salesforce connection properties API","href":"/api-reference/connections/properties/salesforce"},{"title":"SAP HANA","href":"/api-reference/connections/properties/hana"},{"title":"SFTP connection properties API","href":"/api-reference/connections/properties/sftp"},{"title":"Smartsheet connection properties API","href":"/api-reference/connections/properties/smartsheet"},{"title":"SMTP connection properties API","href":"/api-reference/connections/properties/smpt"},{"title":"Snowflake connection properties API","href":"/api-reference/connections/properties/snowflake"},{"title":"Tableau connection properties API","href":"/api-reference/connections/properties/tableau"}]},{"title":"Knowledge graph indexer connection properties API","href":"/api-reference/connections/properties/kgconfig"},{"openapi":"post /api/orchestration/fabric/{fabricId}/connection","title":"Add connection to fabric","href":"/api-reference/connections/add-connection-to-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/connection","title":"List connections per fabric","href":"/api-reference/connections/list-connections-per-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Retrieve connection details","href":"/api-reference/connections/retrieve-connection-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Update connection","href":"/api-reference/connections/update-connection"},{"openapi":"delete /api/orchestration/fabric/{fabricId}/connection/name/{connectionName}","title":"Delete connection","href":"/api-reference/connections/delete-connection"}]},{"group":"Secrets","pages":[{"group":"Properties","pages":[{"title":"Text","href":"/api-reference/secrets/properties/text"},{"title":"Binary","href":"/api-reference/secrets/properties/binary"},{"title":"Username Password","href":"/api-reference/secrets/properties/username-password"},{"title":"M2M OAuth","href":"/api-reference/secrets/properties/oauth"}]},{"openapi":"post /api/orchestration/fabric/{fabricId}/secret","title":"Add secret to fabric","href":"/api-reference/secrets/add-secret-to-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/secret","title":"List secrets per fabric","href":"/api-reference/secrets/list-secrets-per-fabric"},{"openapi":"get /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Retrieve secret details","href":"/api-reference/secrets/retrieve-secret-details"},{"openapi":"put /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Update secret","href":"/api-reference/secrets/update-secret"},{"openapi":"delete /api/orchestration/fabric/{fabricId}/secret/id/{secretId}","title":"Delete secret","href":"/api-reference/secrets/delete-secret"}]},{"group":"Projects","pages":[{"title":"Create project","href":"/api-reference/projects/create-project"},{"title":"Commit changes","href":"/api-reference/projects/commit-changes"},{"title":"Publish release","href":"/api-reference/projects/publish-release"},{"title":"List releases","href":"/api-reference/projects/list-releases"},{"openapi":"post /api/deploy/project","title":"Deploy project","href":"/api-reference/projects/deploy-project"}]},{"group":"Pipelines","pages":[{"openapi":"post /api/editor/sqlEditor/pipeline/create","title":"Create pipeline","href":"/api-reference/pipelines/create-pipeline"},{"openapi":"post /api/trigger/pipeline","title":"Trigger pipeline run","href":"/api-reference/pipelines/trigger-pipeline-run"},{"openapi":"get /api/trigger/pipeline/{runId}","title":"Get pipeline run status","href":"/api-reference/pipelines/get-pipeline-run-status"},{"openapi":"post /api/trigger/pipeline/{runId}/cancel","title":"Cancel pipeline run","href":"/api-reference/pipelines/cancel-pipeline-run"},{"openapi":"post /api/orchestration/tests/run","title":"Run data tests","href":"/api-reference/pipelines/run-data-tests"}]}]}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/administration/platform/editions"}]},{"tab":"Releases","pages":[{"title":"Releases","href":"/releases/2026"}]}]}]},"basePath":"","title":"Databricks - Prophecy Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":[],"chunks":[]}