From d5e48f112f54fc221a816047d9942d891e234dc5 Mon Sep 17 00:00:00 2001
From: Ben Cassell <98852248+benc-db@users.noreply.github.com>
Date: Wed, 30 Oct 2024 19:27:36 -0700
Subject: [PATCH] Patch 10 (#6368)
## What are you changing in this pull request and why?
Adding documentation for Databricks Behavior Flags
## Checklist
- [x] I have reviewed the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] The topic I'm writing about is for specific dbt version(s) and I
have versioned it according to the [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and/or [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content)
guidelines.
- [x] I have added checklist item(s) to this list for anything anything
that needs to happen before this PR is merged, such as "needs technical
review" or "change base branch."
- [x] The content in this PR requires a dbt release note, so I added one
to the [release notes
page](https://docs.getdbt.com/docs/dbt-versions/dbt-cloud-release-notes).
ADDING OR REMOVING PAGES (if so, uncomment):
- [x] Add/remove page in `website/sidebars.js`
- [x] Provide a unique filename for new pages
---------
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Amy Chen <46451573+amychen1776@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
---
.../adapter-behavior-changes.md | 9 ++++++-
.../global-configs/databricks-changes.md | 26 +++++++++++++++++++
website/sidebars.js | 1 +
3 files changed, 35 insertions(+), 1 deletion(-)
create mode 100644 website/docs/reference/global-configs/databricks-changes.md
diff --git a/website/docs/reference/global-configs/adapter-behavior-changes.md b/website/docs/reference/global-configs/adapter-behavior-changes.md
index bd0ba9f7404..a755f8cfe50 100644
--- a/website/docs/reference/global-configs/adapter-behavior-changes.md
+++ b/website/docs/reference/global-configs/adapter-behavior-changes.md
@@ -14,10 +14,17 @@ Some adapters can display behavior changes when certain flags are enabled. The f
+
+
+
-
\ No newline at end of file
+
diff --git a/website/docs/reference/global-configs/databricks-changes.md b/website/docs/reference/global-configs/databricks-changes.md
new file mode 100644
index 00000000000..ca24b822ae5
--- /dev/null
+++ b/website/docs/reference/global-configs/databricks-changes.md
@@ -0,0 +1,26 @@
+---
+title: "Databricks adapter behavior changes"
+id: "databricks-changes"
+sidebar: "Databricks"
+---
+
+The following are the current [behavior change flags](/docs/reference/global-configs/behavior-changes.md#behavior-change-flags) that are specific to `dbt-databricks`:
+
+| Flag | `dbt-databricks`: Intro | `dbt-databricks`: Maturity |
+| ----------------------------- | ----------------------- | -------------------------- |
+| `use_info_schema_for_columns` | 1.9.0 | TBD |
+| `use_user_folder_for_python` | 1.9.0 | TBD |
+
+### Use information schema for columns
+
+The `use_info_schema_for_columns` flag is `False` by default.
+
+Setting this flag to `True` will use `information_schema` rather than `describe extended` to get column metadata for Unity Catalog tables. This setting helps you avoid issues where `describe extended` truncates information when the type is a complex struct. However, this setting is not yet the default behavior, as there are performance impacts due to a Databricks metadata limitation because of the need to run `REPAIR TABLE {{relation}} SYNC METADATA` before querying to ensure the `information_schema` is complete.
+
+This flag will become the default behavior when this additional query is no longer needed.
+
+### Use user's folder for Python model notebooks
+
+The `use_user_folder_for_python` flag is `False` by default and results in writing uploaded python model notebooks to `/Shared/dbt_python_models/{{schema}}/`. Setting this flag to `True` will write notebooks to `/Users/{{current user}}/{{catalog}}/{{schema}}/` Writing to the `Shared` folder is deprecated by Databricks as it does not align with governance best practices.
+
+We plan to promote this flag to maturity in v1.10.0.
diff --git a/website/sidebars.js b/website/sidebars.js
index c8a711815a8..114c40cb09f 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -1104,6 +1104,7 @@ const sidebarSettings = {
link: { type: "doc", id: "reference/global-configs/adapter-behavior-changes" },
items: [
"reference/global-configs/adapter-behavior-changes",
+ "reference/global-configs/databricks-changes",
"reference/global-configs/redshift-changes",
],
},