From e68dafa9cf383f405b694dd2cb639058878c5003 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:38:42 -0500 Subject: [PATCH 01/28] Updating deps command page --- website/docs/reference/commands/deps.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 60ccd091ad7..1a9314987d9 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -62,7 +62,9 @@ Update your versions in packages.yml, then run dbt deps dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `dependencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`. -When you update the package spec and run `dbt deps` again, the package-lock and package files update accordingly. You can run `dbt deps --lock` to update the `package-lock.yml` with the most recent dependencies from `packages`. +When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags for the `package-lock.yml`: +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. +- `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist. From 3c3d28c543b1dc91d5f0e874471927c27724472b Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:43:27 -0500 Subject: [PATCH 02/28] updating spacing --- website/docs/reference/commands/deps.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 1a9314987d9..ddd3e4acb8e 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -62,7 +62,9 @@ Update your versions in packages.yml, then run dbt deps dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `dependencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`. -When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags for the `package-lock.yml`: +When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. + +There are two flags related to `package-lock.yml`: - `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. - `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. From cfd3f8492606ac25cbaa5cf55287092f651886f0 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:44:20 -0500 Subject: [PATCH 03/28] Apply suggestions from code review --- website/docs/reference/commands/deps.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index ddd3e4acb8e..40d9ee1cabd 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -65,8 +65,8 @@ dbt generates the `package-lock.yml` file in the _project_root_ where `packages. When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags related to `package-lock.yml`: -- `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. -- `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml` and installs them. +- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist. From 3ef39fbf6234a2de2c1d043db55611bea0352004 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Mon, 11 Dec 2023 16:12:43 -0500 Subject: [PATCH 04/28] Update website/docs/reference/commands/deps.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/reference/commands/deps.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 40d9ee1cabd..1a3562e3172 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -65,8 +65,8 @@ dbt generates the `package-lock.yml` file in the _project_root_ where `packages. When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags related to `package-lock.yml`: -- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml` and installs them. -- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. +- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml`. Also install the packages unless the `--lock` flag is also passed. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist. From d9d5ecef8f5f10a867deea88e8f9eae3144c862b Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 12 Dec 2023 10:16:20 -0500 Subject: [PATCH 05/28] new file --- .../dbt-cloud-tips.md => build/dbt-tips.md} | 30 +++---------- .../docs/cloud/about-cloud/about-cloud-ide.md | 2 +- .../dbt-cloud-ide/develop-in-the-cloud.md | 6 +-- .../cloud/dbt-cloud-ide/ide-user-interface.md | 2 +- .../cloud/dbt-cloud-ide/keyboard-shortcuts.md | 43 +++++++++++++++++++ .../docs/cloud/dbt-cloud-ide/lint-format.md | 2 +- website/sidebars.js | 3 +- website/vercel.json | 5 +++ 8 files changed, 61 insertions(+), 32 deletions(-) rename website/docs/docs/{cloud/dbt-cloud-ide/dbt-cloud-tips.md => build/dbt-tips.md} (71%) create mode 100644 website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md diff --git a/website/docs/docs/cloud/dbt-cloud-ide/dbt-cloud-tips.md b/website/docs/docs/build/dbt-tips.md similarity index 71% rename from website/docs/docs/cloud/dbt-cloud-ide/dbt-cloud-tips.md rename to website/docs/docs/build/dbt-tips.md index 0ceb4929530..50a31c127e6 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/dbt-cloud-tips.md +++ b/website/docs/docs/build/dbt-tips.md @@ -1,31 +1,11 @@ --- -title: "Tips and tricks" -id: dbt-cloud-tips -description: "Check out any dbt Cloud and IDE-related tips." -sidebar_label: "Tips and tricks" +title: "dbt tips and tricks" +description: "Check out any dbt-related tips and tricks to help you work faster and be more productive." +sidebar_label: "dbt tips and tricks" pagination_next: null --- -# dbt Cloud tips - -The Cloud IDE provides keyboard shortcuts, features, and development tips to help you work faster and be more productive. Use this Cloud IDE cheat sheet to help you quickly reference some common operations. - -## Cloud IDE Keyboard shortcuts - -There are default keyboard shortcuts that can help make development more productive and easier for everyone. - -- Press Fn-F1 to view a full list of the editor shortcuts -- Command-O on macOS or Control-O on Windows to select a file to open -- Command-P/Command-Shift-P on macOS or Control-P/Control-Shift-P on Windows to see the command palette -- Hold Option-click-on-area or press Shift-Option-Command on macOS or Hold-Alt-click-on-area on Windows to select multiple lines and perform a multi-edit. You can also press Command-E to perform this operation on the command line. -- Command-Enter on macOS or Control-Enter on Windows to Preview your code -- Command-Shift-Enter on macOS or Control-Shift-Enter on Windows to Compile -- Highlight a portion of code and use the above shortcuts to Preview or Compile code -- Enter two underscores (__) in the IDE to reveal a list of dbt functions -- Press Control-backtick (or Ctrl + `) to toggle the Invocation history -- Press Command-Option-forward slash on macOS or Control-Alt-forward slash on Windows on the selected code to add a block comment. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` -- Option-W on macOS or Alt-W on Windows will close the currently active editor tab - +Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. You can also learn about the default dbt Cloud IDE keyboard shortcuts to help make development more productive and easier for everyone. ## Package tips @@ -61,4 +41,4 @@ There are default keyboard shortcuts that can help make development more product - [Quickstart guide](/guides) - [About dbt Cloud](/docs/cloud/about-cloud/dbt-cloud-features) -- [Develop in the Cloud](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) +- [Develop in the Cloud](/docs/cloud/about-develop-dbt) diff --git a/website/docs/docs/cloud/about-cloud/about-cloud-ide.md b/website/docs/docs/cloud/about-cloud/about-cloud-ide.md index 7643928feec..df5575ecb8f 100644 --- a/website/docs/docs/cloud/about-cloud/about-cloud-ide.md +++ b/website/docs/docs/cloud/about-cloud/about-cloud-ide.md @@ -28,4 +28,4 @@ For more information, read the complete [Cloud IDE guide](/docs/cloud/dbt-cloud- ## Related docs - [IDE user interface](/docs/cloud/dbt-cloud-ide/ide-user-interface) -- [Tips and tricks](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips) +- [Keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md index 9fc382f0217..30f5e1463a1 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md @@ -10,7 +10,7 @@ pagination_prev: null The dbt Cloud integrated development environment (IDE) is a single web-based interface for building, testing, running, and version-controlling dbt projects. It compiles dbt code into SQL and executes it directly on your database. -The dbt Cloud IDE offers several [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) for faster and more efficient data platform development and governance: +The dbt Cloud IDE offers several [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) and [editing features](/docs/cloud/dbt-cloud-ide/ide-user-interface#editing-features) for faster and more efficient data platform development and governance: - Syntax highlighting for SQL: Makes it easy to distinguish different parts of your code, reducing syntax errors and enhancing readability. - Auto-completion: Suggests table names, arguments, and column names as you type, saving time and reducing typos. @@ -44,7 +44,7 @@ To improve your experience using dbt Cloud, we suggest that you turn off ad bloc ## dbt Cloud IDE features -The dbt Cloud IDE comes with [tips](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models. +The dbt Cloud IDE comes with [tips](/docs/build/dbt-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models. :::tip Stay informed @@ -54,7 +54,7 @@ To stay informed on IDE updates, read [dbt Cloud IDE release notes](/tags/ide), | Feature | Info | |---|---| -| **Keyboard shortcuts** | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips#cloud-ide-keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | +| **Keyboard shortcuts** | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | | **File state indicators** | Ability to see when changes or actions have been made to the file. The indicators **M, D, A,** and **•** appear to the right of your file or folder name and indicate the actions performed:

- Unsaved **(•)** — The IDE detects unsaved changes to your file/folder
- Modification **(M)** — The IDE detects a modification of existing files/folders
- Added **(A)** — The IDE detects added files
- Deleted **(D)** — The IDE detects deleted files. | **IDE version control** | The IDE version control section and git button allow you to apply the concept of [version control](/docs/collaborate/git/version-control-basics) to your project directly into the IDE.

- Create or change branches
- Commit or revert individual files by right-clicking the edited file
- [Resolve merge conflicts](/docs/collaborate/git/merge-conflicts)
- Execute git commands using the git button
- Link to the repo directly by clicking the branch name | | **Project documentation** | Generate and view your [project documentation](/docs/collaborate/build-and-view-your-docs) for your dbt project in real-time. You can inspect and verify what your project's documentation will look like before you deploy your changes to production. | diff --git a/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md b/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md index 05910b23e7f..3c8cd641716 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md @@ -53,7 +53,7 @@ The IDE features some delightful tools and layouts to make it easier for you to 1. **File Editor —** The File Editor is where users edit code. Tabs break out the region for each opened file, and unsaved files are marked with a blue dot icon in the tab view. - * Use intuitive [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips#cloud-ide-keyboard-shortcuts) to help develop easier for you and your team. + * Use intuitive [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/-keyboard-shortcuts) to help develop easier for you and your team. 2. **Save button —** The editor has a **Save** button that saves editable files. Pressing the button or using the Command-S or Control-S shortcut saves the file contents. You don't need to save to preview code results in the Console section, but it's necessary before changes appear in a dbt invocation. The File Editor tab shows a blue icon for unsaved changes. diff --git a/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md new file mode 100644 index 00000000000..a50ba5ccdb9 --- /dev/null +++ b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md @@ -0,0 +1,43 @@ +--- +title: "dbt Cloud IDE keyboard shortcuts" +description: "Learn about the keyboard shortcuts available in the Cloud IDE." +sidebar_label: "Keyboard shortcuts" +--- + + +The Cloud IDE provides keyboard shortcuts, features, and development tips to help you work faster and be more productive. + +Use this dbt Cloud IDE page to help you quickly reference some common operations. + +| Shortcut description | macOS | Windows | +|--------|----------------|------------------| +| View a full list of editor shortcuts | Fn-F1 | Fn-F1 | +| Select a file to open | Command-O | Control-O | +| Open the command palette | Command-P or Command-Shift-P | Control-P or Control-Shift-P | +| Multi-edit by selecting multiple lines | Option-click or Shift-Option-Command | Hold Alt and click | +| Preview code | Command-Enter | Control-Enter | +| Compile code | Command-Shift-Enter | Control-Shift-Enter | +| Preview or Compile selected code | (Use the above shortcuts) | (Use the above shortcuts) | +| Reveal a list of dbt functions | Enter two underscores `__` | Enter two underscores `__` | +| Toggle the Invocation history | Control-backtick (`) | Control-backtick (`) | +| Add a block comment to selected code. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` | Command-Option-/ | Control-Alt-/ | +| Close the currently active editor tab | Option-W | Alt-W | + + +- Press Fn-F1 to view a full list of the editor shortcuts +- Command-O on macOS or Control-O on Windows to select a file to open +- Command-P/Command-Shift-P on macOS or Control-P/Control-Shift-P on Windows to see the command palette +- Hold Option-click-on-area or press Shift-Option-Command on macOS or Hold-Alt-click-on-area on Windows to select multiple lines and perform a multi-edit. You can also press Command-E to perform this operation on the command line. +- Command-Enter on macOS or Control-Enter on Windows to Preview your code +- Command-Shift-Enter on macOS or Control-Shift-Enter on Windows to Compile +- Highlight a portion of code and use the above shortcuts to Preview or Compile code +- Enter two underscores (__) in the IDE to reveal a list of dbt functions +- Press Control-backtick (or Ctrl + `) to toggle the Invocation history +- Press Command-Option-forward slash on macOS or Control-Alt-forward slash on Windows on the selected code to add a block comment. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` +- Option-W on macOS or Alt-W on Windows will close the currently active editor tab + +## Related docs + +- [Quickstart guide](/guides) +- [About dbt Cloud](/docs/cloud/about-cloud/dbt-cloud-features) +- [Develop in the Cloud](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md index f145e76df11..733ec9dbcfe 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/lint-format.md @@ -236,4 +236,4 @@ Make sure you're on a development branch. Formatting or Linting isn't available ## Related docs - [User interface](/docs/cloud/dbt-cloud-ide/ide-user-interface) -- [Tips and tricks](/docs/cloud/dbt-cloud-ide/dbt-cloud-tips) +- [Keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) diff --git a/website/sidebars.js b/website/sidebars.js index 598fffc7f0d..1401211639b 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -245,9 +245,9 @@ const sidebarSettings = { link: { type: "doc", id: "docs/cloud/dbt-cloud-ide/develop-in-the-cloud" }, items: [ "docs/cloud/dbt-cloud-ide/develop-in-the-cloud", + "docs/cloud/dbt-cloud-ide/keyboard-shortcuts", "docs/cloud/dbt-cloud-ide/ide-user-interface", "docs/cloud/dbt-cloud-ide/lint-format", - "docs/cloud/dbt-cloud-ide/dbt-cloud-tips", ], }, ], @@ -259,6 +259,7 @@ const sidebarSettings = { link: { type: "doc", id: "docs/build/projects" }, items: [ "docs/build/projects", + "docs/build/dbt-tips", { type: "category", label: "Build your DAG", diff --git a/website/vercel.json b/website/vercel.json index 3377b49278d..c2ca6f52d6c 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -2,6 +2,11 @@ "cleanUrls": true, "trailingSlash": false, "redirects": [ + { + "source": "/docs/cloud/dbt-cloud-ide/dbt-cloud-tips", + "destination": "/docs/build/dbt-tips", + "permanent": true + }, { "source": "/docs/cloud/dbt-cloud-ide", "destination": "/docs/cloud/dbt-cloud-ide/develop-in-the-cloud", From 3c97f4523f0a1aaa8733df37e136b604c331643c Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Tue, 12 Dec 2023 13:17:23 -0500 Subject: [PATCH 06/28] fi link --- website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md b/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md index 3c8cd641716..2038d4ad64c 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/ide-user-interface.md @@ -53,7 +53,7 @@ The IDE features some delightful tools and layouts to make it easier for you to 1. **File Editor —** The File Editor is where users edit code. Tabs break out the region for each opened file, and unsaved files are marked with a blue dot icon in the tab view. - * Use intuitive [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/-keyboard-shortcuts) to help develop easier for you and your team. + * Use intuitive [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help develop easier for you and your team. 2. **Save button —** The editor has a **Save** button that saves editable files. Pressing the button or using the Command-S or Control-S shortcut saves the file contents. You don't need to save to preview code results in the Console section, but it's necessary before changes appear in a dbt invocation. The File Editor tab shows a blue icon for unsaved changes. From 292a2fa06f6c571519d83b7f9ff3c4ba1d91f0b0 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 15 Dec 2023 09:58:05 -0500 Subject: [PATCH 07/28] updates --- website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md index a50ba5ccdb9..56ba020b8d7 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md @@ -13,13 +13,12 @@ Use this dbt Cloud IDE page to help you quickly reference some common operation |--------|----------------|------------------| | View a full list of editor shortcuts | Fn-F1 | Fn-F1 | | Select a file to open | Command-O | Control-O | -| Open the command palette | Command-P or Command-Shift-P | Control-P or Control-Shift-P | +| Open the command palette to invoke dbt commands and actions | Command-P or Command-Shift-P | Control-P or Control-Shift-P | | Multi-edit by selecting multiple lines | Option-click or Shift-Option-Command | Hold Alt and click | | Preview code | Command-Enter | Control-Enter | | Compile code | Command-Shift-Enter | Control-Shift-Enter | -| Preview or Compile selected code | (Use the above shortcuts) | (Use the above shortcuts) | | Reveal a list of dbt functions | Enter two underscores `__` | Enter two underscores `__` | -| Toggle the Invocation history | Control-backtick (`) | Control-backtick (`) | +| Toggle open the [Invocation history drawer](/docs/cloud/dbt-cloud-ide/ide-user-interface#invocation-history) located on the bottom of the IDE. | Control-backtick (`) | Control-backtick (`) | | Add a block comment to selected code. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` | Command-Option-/ | Control-Alt-/ | | Close the currently active editor tab | Option-W | Alt-W | From cdc4ea268d720773b2e34a597ffedf3b4f329368 Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Fri, 15 Dec 2023 15:43:03 -0700 Subject: [PATCH 08/28] Remove period from blog post title --- website/blog/2023-12-11-semantic-layer-on-semantic-layer.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-11-semantic-layer-on-semantic-layer.md b/website/blog/2023-12-11-semantic-layer-on-semantic-layer.md index ea77072a6dd..44499c51ec5 100644 --- a/website/blog/2023-12-11-semantic-layer-on-semantic-layer.md +++ b/website/blog/2023-12-11-semantic-layer-on-semantic-layer.md @@ -1,5 +1,5 @@ --- -title: "How we built consistent product launch metrics with the dbt Semantic Layer." +title: "How we built consistent product launch metrics with the dbt Semantic Layer" description: "We built an end-to-end data pipeline for measuring the launch of the dbt Semantic Layer using the dbt Semantic Layer." slug: product-analytics-pipeline-with-dbt-semantic-layer From 06eab8869538e82d4fce29585b6f77ed3beb6b62 Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Fri, 15 Dec 2023 16:38:12 -0700 Subject: [PATCH 09/28] Fix spelling --- website/docs/best-practices/clone-incremental-models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/best-practices/clone-incremental-models.md b/website/docs/best-practices/clone-incremental-models.md index 4096af489ab..c2dc217231c 100644 --- a/website/docs/best-practices/clone-incremental-models.md +++ b/website/docs/best-practices/clone-incremental-models.md @@ -35,7 +35,7 @@ This can be suboptimal because: - Typically incremental models are your largest datasets, so they take a long time to build in their entirety which can slow down development time and incur high warehouse costs. - There are situations where a `full-refresh` of the incremental model passes successfully in your CI job but an _incremental_ build of that same table in prod would fail when the PR is merged into main (think schema drift where [on_schema_change](/docs/build/incremental-models#what-if-the-columns-of-my-incremental-model-change) config is set to `fail`) -You can alleviate these problems by zero copy cloning the relevant, pre-exisitng incremental models into your PR-specific schema as the first step of the CI job using the `dbt clone` command. This way, the incremental models already exist in the PR-specific schema when you first execute the command `dbt build --select state:modified+` so the `is_incremental` flag will be `true`. +You can alleviate these problems by zero copy cloning the relevant, pre-existing incremental models into your PR-specific schema as the first step of the CI job using the `dbt clone` command. This way, the incremental models already exist in the PR-specific schema when you first execute the command `dbt build --select state:modified+` so the `is_incremental` flag will be `true`. You'll have two commands for your dbt Cloud CI check to execute: 1. Clone all of the pre-existing incremental models that have been modified or are downstream of another model that has been modified: `dbt clone --select state:modified+,config.materialized:incremental,state:old` From 9bc167c00af8c22f716fa9951018ec4062253d23 Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Fri, 15 Dec 2023 16:42:04 -0700 Subject: [PATCH 10/28] Copy-pasteable commands --- .../docs/best-practices/clone-incremental-models.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/website/docs/best-practices/clone-incremental-models.md b/website/docs/best-practices/clone-incremental-models.md index c2dc217231c..bb55ecd88f8 100644 --- a/website/docs/best-practices/clone-incremental-models.md +++ b/website/docs/best-practices/clone-incremental-models.md @@ -38,8 +38,14 @@ This can be suboptimal because: You can alleviate these problems by zero copy cloning the relevant, pre-existing incremental models into your PR-specific schema as the first step of the CI job using the `dbt clone` command. This way, the incremental models already exist in the PR-specific schema when you first execute the command `dbt build --select state:modified+` so the `is_incremental` flag will be `true`. You'll have two commands for your dbt Cloud CI check to execute: -1. Clone all of the pre-existing incremental models that have been modified or are downstream of another model that has been modified: `dbt clone --select state:modified+,config.materialized:incremental,state:old` -2. Build all of the models that have been modified and their downstream dependencies: `dbt build --select state:modified+` +1. Clone all of the pre-existing incremental models that have been modified or are downstream of another model that has been modified: + ```shell + dbt clone --select state:modified+,config.materialized:incremental,state:old + ``` +2. Build all of the models that have been modified and their downstream dependencies: + ```shell + dbt build --select state:modified+` + ``` Because of your first clone step, the incremental models selected in your `dbt build` on the second step will run in incremental mode. From 8d04adeca7f33d02d8b2144c114136cf4d64c46e Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Fri, 15 Dec 2023 17:02:38 -0700 Subject: [PATCH 11/28] Remove rogue backtick --- website/docs/best-practices/clone-incremental-models.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/best-practices/clone-incremental-models.md b/website/docs/best-practices/clone-incremental-models.md index bb55ecd88f8..11075b92161 100644 --- a/website/docs/best-practices/clone-incremental-models.md +++ b/website/docs/best-practices/clone-incremental-models.md @@ -44,7 +44,7 @@ You'll have two commands for your dbt Cloud CI check to execute: ``` 2. Build all of the models that have been modified and their downstream dependencies: ```shell - dbt build --select state:modified+` + dbt build --select state:modified+ ``` Because of your first clone step, the incremental models selected in your `dbt build` on the second step will run in incremental mode. From eca769c4c039407207a33bf9f554e438489fbe4f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:01:18 -0500 Subject: [PATCH 12/28] link to clone in ci job best practices this pr adds a link to the clone in a ci job best practices guide as a callout per slack request https://dbt-labs.slack.com/archives/C02NCQ9483C/p1702655617781059 --- website/blog/2023-10-31-to-defer-or-to-clone.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/blog/2023-10-31-to-defer-or-to-clone.md b/website/blog/2023-10-31-to-defer-or-to-clone.md index a39fc3ac0b7..2d72eee3297 100755 --- a/website/blog/2023-10-31-to-defer-or-to-clone.md +++ b/website/blog/2023-10-31-to-defer-or-to-clone.md @@ -91,6 +91,10 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore 2. **[Slim CI](https://discourse.getdbt.com/t/how-we-sped-up-our-ci-runs-by-10x-using-slim-ci/2603)** + :::tip Use `dbt clone` in CI jobs + Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. + ::: + In this scenario, we want to: 1. Refer to production models wherever possible to speed up continuous integration (CI) runs 2. Only run and test models in the CI staging environment that have changed from the production environment @@ -98,7 +102,7 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore Therefore, we should use **defer** in this scenario -3. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** +4. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** In this scenario, we want to: 1. Ensure that all tests are always passing on the production dataset, even if that dataset is slightly stale From c1a6d9c9e3e5e50595deb09e8060044e290a1b1d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:02:12 -0500 Subject: [PATCH 13/28] Update website/blog/2023-10-31-to-defer-or-to-clone.md --- website/blog/2023-10-31-to-defer-or-to-clone.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-10-31-to-defer-or-to-clone.md b/website/blog/2023-10-31-to-defer-or-to-clone.md index 2d72eee3297..4777022e5cd 100755 --- a/website/blog/2023-10-31-to-defer-or-to-clone.md +++ b/website/blog/2023-10-31-to-defer-or-to-clone.md @@ -102,7 +102,7 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore Therefore, we should use **defer** in this scenario -4. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** +3. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** In this scenario, we want to: 1. Ensure that all tests are always passing on the production dataset, even if that dataset is slightly stale From 301c8a9e04d559bacf80e0e7591d6e094064267f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:03:30 -0500 Subject: [PATCH 14/28] Update website/blog/2023-10-31-to-defer-or-to-clone.md --- website/blog/2023-10-31-to-defer-or-to-clone.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-10-31-to-defer-or-to-clone.md b/website/blog/2023-10-31-to-defer-or-to-clone.md index 4777022e5cd..53b40f244dd 100755 --- a/website/blog/2023-10-31-to-defer-or-to-clone.md +++ b/website/blog/2023-10-31-to-defer-or-to-clone.md @@ -91,7 +91,7 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore 2. **[Slim CI](https://discourse.getdbt.com/t/how-we-sped-up-our-ci-runs-by-10x-using-slim-ci/2603)** - :::tip Use `dbt clone` in CI jobs + :::tip Use `dbt clone` in CI jobs to test incremental models Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. ::: From 7d81a535342e01891f2d5837ded9975ef338e639 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:13:53 -0500 Subject: [PATCH 15/28] Update 2023-10-31-to-defer-or-to-clone.md --- website/blog/2023-10-31-to-defer-or-to-clone.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/website/blog/2023-10-31-to-defer-or-to-clone.md b/website/blog/2023-10-31-to-defer-or-to-clone.md index 53b40f244dd..9454ad11281 100755 --- a/website/blog/2023-10-31-to-defer-or-to-clone.md +++ b/website/blog/2023-10-31-to-defer-or-to-clone.md @@ -91,18 +91,18 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore 2. **[Slim CI](https://discourse.getdbt.com/t/how-we-sped-up-our-ci-runs-by-10x-using-slim-ci/2603)** - :::tip Use `dbt clone` in CI jobs to test incremental models - Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. - ::: - In this scenario, we want to: 1. Refer to production models wherever possible to speed up continuous integration (CI) runs 2. Only run and test models in the CI staging environment that have changed from the production environment 3. Reference models from different environments – prod for unchanged models, and staging for modified models Therefore, we should use **defer** in this scenario + + :::tip Use `dbt clone` in CI jobs to test incremental models + Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. + ::: -3. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** +4. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** In this scenario, we want to: 1. Ensure that all tests are always passing on the production dataset, even if that dataset is slightly stale From 25c2af99bde23bfe607004b9eb29188d67015b8b Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 06:48:37 -0500 Subject: [PATCH 16/28] Update 2023-10-31-to-defer-or-to-clone.md --- website/blog/2023-10-31-to-defer-or-to-clone.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/blog/2023-10-31-to-defer-or-to-clone.md b/website/blog/2023-10-31-to-defer-or-to-clone.md index 9454ad11281..00aa8c7f7e5 100755 --- a/website/blog/2023-10-31-to-defer-or-to-clone.md +++ b/website/blog/2023-10-31-to-defer-or-to-clone.md @@ -87,7 +87,7 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore 1. Make a copy of our production dataset available in our downstream BI tool 2. To safely iterate on this copy without breaking production datasets - Therefore, we should use **clone** in this scenario + Therefore, we should use **clone** in this scenario. 2. **[Slim CI](https://discourse.getdbt.com/t/how-we-sped-up-our-ci-runs-by-10x-using-slim-ci/2603)** @@ -96,13 +96,13 @@ Using the cheat sheet above, let’s explore a few common scenarios and explore 2. Only run and test models in the CI staging environment that have changed from the production environment 3. Reference models from different environments – prod for unchanged models, and staging for modified models - Therefore, we should use **defer** in this scenario + Therefore, we should use **defer** in this scenario. - :::tip Use `dbt clone` in CI jobs to test incremental models - Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. - ::: +:::tip Use `dbt clone` in CI jobs to test incremental models +Learn how to [use `dbt clone` in CI jobs](/best-practices/clone-incremental-models) to efficiently test modified incremental models, simulating post-merge behavior while avoiding full-refresh costs. +::: -4. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** +3. **[Blue/Green Deployments](https://discourse.getdbt.com/t/performing-a-blue-green-deploy-of-your-dbt-project-on-snowflake/1349)** In this scenario, we want to: 1. Ensure that all tests are always passing on the production dataset, even if that dataset is slightly stale From c0792b83028e99dc130b0b3a2d25f18333cafd4c Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 07:00:33 -0500 Subject: [PATCH 17/28] final tweaks --- .../cloud/dbt-cloud-ide/keyboard-shortcuts.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md index 56ba020b8d7..121cab68ce7 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/keyboard-shortcuts.md @@ -18,23 +18,10 @@ Use this dbt Cloud IDE page to help you quickly reference some common operation | Preview code | Command-Enter | Control-Enter | | Compile code | Command-Shift-Enter | Control-Shift-Enter | | Reveal a list of dbt functions | Enter two underscores `__` | Enter two underscores `__` | -| Toggle open the [Invocation history drawer](/docs/cloud/dbt-cloud-ide/ide-user-interface#invocation-history) located on the bottom of the IDE. | Control-backtick (`) | Control-backtick (`) | -| Add a block comment to selected code. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` | Command-Option-/ | Control-Alt-/ | +| Toggle open the [Invocation history drawer](/docs/cloud/dbt-cloud-ide/ide-user-interface#invocation-history) located on the bottom of the IDE. | Control-backtick (or Control + `) | Control-backtick (or Ctrl + `) | +| Add a block comment to selected code. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`.

Markdown files will use the Markdown syntax `()` | Command-Option-/ | Control-Alt-/ | | Close the currently active editor tab | Option-W | Alt-W | - -- Press Fn-F1 to view a full list of the editor shortcuts -- Command-O on macOS or Control-O on Windows to select a file to open -- Command-P/Command-Shift-P on macOS or Control-P/Control-Shift-P on Windows to see the command palette -- Hold Option-click-on-area or press Shift-Option-Command on macOS or Hold-Alt-click-on-area on Windows to select multiple lines and perform a multi-edit. You can also press Command-E to perform this operation on the command line. -- Command-Enter on macOS or Control-Enter on Windows to Preview your code -- Command-Shift-Enter on macOS or Control-Shift-Enter on Windows to Compile -- Highlight a portion of code and use the above shortcuts to Preview or Compile code -- Enter two underscores (__) in the IDE to reveal a list of dbt functions -- Press Control-backtick (or Ctrl + `) to toggle the Invocation history -- Press Command-Option-forward slash on macOS or Control-Alt-forward slash on Windows on the selected code to add a block comment. SQL files will use the Jinja syntax `({# #})` rather than the SQL one `(/* */)`. Markdown files will use the Markdown syntax `()` -- Option-W on macOS or Alt-W on Windows will close the currently active editor tab - ## Related docs - [Quickstart guide](/guides) From 4fe7eeb7510a689e15ce1c6f02fe7c4d0d0837cf Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 07:06:51 -0500 Subject: [PATCH 18/28] turn to table --- website/docs/docs/build/dbt-tips.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/website/docs/docs/build/dbt-tips.md b/website/docs/docs/build/dbt-tips.md index 50a31c127e6..005c97e41a1 100644 --- a/website/docs/docs/build/dbt-tips.md +++ b/website/docs/docs/build/dbt-tips.md @@ -5,17 +5,19 @@ sidebar_label: "dbt tips and tricks" pagination_next: null --- -Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. You can also learn about the default dbt Cloud IDE keyboard shortcuts to help make development more productive and easier for everyone. +Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help make development more productive and easier for everyone. ## Package tips -- Use the [dbt_codegen](https://hub.getdbt.com/dbt-labs/codegen/latest/) package to help you generate YML files for your models and sources and SQL files for your staging models. -- The [dbt_utils](https://hub.getdbt.com/dbt-labs/dbt_utils/latest/) package contains macros useful for daily development. For example, `date_spine` generates a table with all dates between the ones provided as parameters. -- The [dbt_project_evaluator](https://hub.getdbt.com/dbt-labs/dbt_project_evaluator/latest) package compares your dbt project against a list of our best practices and provides suggestions and guidelines on how to update your models. -- The [dbt_expectations](https://hub.getdbt.com/calogica/dbt_expectations/latest) package contains many tests beyond those built into dbt Core. -- The [dbt_audit_helper](https://hub.getdbt.com/#:~:text=adwords-,audit_helper,-codegen) package lets you compare the output of 2 queries. Use it when refactoring existing logic to ensure that the new results are identical. -- The [dbt_artifacts](https://hub.getdbt.com/brooklyn-data/dbt_artifacts/latest) package saves information about your dbt runs directly to your data platform so that you can track the performance of models over time. -- The [dbt_meta_testing](https://hub.getdbt.com/tnightengale/dbt_meta_testing/latest) package checks that your dbt project is sufficiently tested and documented. +| Package | Description | +|---------|-------------| +| [`dbt_codegen`](https://hub.getdbt.com/dbt-labs/codegen/latest/) |Use the package to help you generate YML files for your models and sources and SQL files for your staging models. | +| [`dbt_utils`](https://hub.getdbt.com/dbt-labs/dbt_utils/latest/) | The package contains macros useful for daily development. For example, `date_spine` generates a table with all dates between the ones provided as parameters. | +| [`dbt_project_evaluator`](https://hub.getdbt.com/dbt-labs/dbt_project_evaluator/latest) | The package compares your dbt project against a list of our best practices and provides suggestions and guidelines on how to update your models. | +| [`dbt_expectations`](https://hub.getdbt.com/calogica/dbt_expectations/latest) | The package contains many tests beyond those built into dbt. | +| [`dbt_audit_helper`](https://hub.getdbt.com/#:~:text=adwords-,audit_helper,-codegen) | The package lets you compare the output of 2 queries. Use it when refactoring existing logic to ensure that the new results are identical. | +| [`dbt_artifacts`](https://hub.getdbt.com/brooklyn-data/dbt_artifacts/latest) | The package saves information about your dbt runs directly to your data platform so that you can track the performance of models over time. | +| [`dbt_meta_testing`](https://hub.getdbt.com/tnightengale/dbt_meta_testing/latest) | This package checks that your dbt project is sufficiently tested and documented. | ## Advanced tips From 5f242859847ef64f69b73a8f0a898f38ce25b3d3 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 07:07:28 -0500 Subject: [PATCH 19/28] add line --- website/docs/docs/build/dbt-tips.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/build/dbt-tips.md b/website/docs/docs/build/dbt-tips.md index 005c97e41a1..b91e5eb91fe 100644 --- a/website/docs/docs/build/dbt-tips.md +++ b/website/docs/docs/build/dbt-tips.md @@ -5,7 +5,9 @@ sidebar_label: "dbt tips and tricks" pagination_next: null --- -Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help make development more productive and easier for everyone. +Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. + +You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help make development more productive and easier for everyone. ## Package tips From bd8fa097b11e238f92e50ec1b626d9291a742490 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 07:16:34 -0500 Subject: [PATCH 20/28] Update vercel.json fix failure --- website/vercel.json | 1 + 1 file changed, 1 insertion(+) diff --git a/website/vercel.json b/website/vercel.json index 7bf4bf533d7..35799e24061 100644 --- a/website/vercel.json +++ b/website/vercel.json @@ -7,6 +7,7 @@ "destination": "/docs/build/dbt-tips", "permanent": true }, + { "source": "/docs/dbt-cloud-apis/discovery-schema-job-metric", "destination": "/docs/dbt-cloud-apis/discovery-schema-environment", "permanent": true From 574988e1792952fe06b0dada19f1322281806ab7 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 11:58:45 -0500 Subject: [PATCH 21/28] fold feedback --- website/docs/docs/build/dbt-tips.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/build/dbt-tips.md b/website/docs/docs/build/dbt-tips.md index b91e5eb91fe..e49dd2bd242 100644 --- a/website/docs/docs/build/dbt-tips.md +++ b/website/docs/docs/build/dbt-tips.md @@ -5,12 +5,19 @@ sidebar_label: "dbt tips and tricks" pagination_next: null --- -Use this page to learn about any dbt-related tips and tricks to help you work faster and be more productive. +Use this page for valuable insights and practical advice to enhance your dbt experience. Whether you're new to dbt or an experienced user, these tips are designed to help you work more efficiently and effectively. -You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) to help make development more productive and easier for everyone. +The following tips are organized into the following categories: +- [Package tips](#package-tips) +- [Advanced tips adn techniques](#advanced-tips-adn-techniques) +- [Related docs](#related-docs) + +If you're developing with the dbt Cloud IDE, you can refer to the [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) page to help make development more productive and easier for everyone. ## Package tips +Leverage these dbt packages to streamline your workflow: + | Package | Description | |---------|-------------| | [`dbt_codegen`](https://hub.getdbt.com/dbt-labs/codegen/latest/) |Use the package to help you generate YML files for your models and sources and SQL files for your staging models. | @@ -21,7 +28,7 @@ You can also learn about the default dbt Cloud IDE [keyboard shortcuts](/docs/cl | [`dbt_artifacts`](https://hub.getdbt.com/brooklyn-data/dbt_artifacts/latest) | The package saves information about your dbt runs directly to your data platform so that you can track the performance of models over time. | | [`dbt_meta_testing`](https://hub.getdbt.com/tnightengale/dbt_meta_testing/latest) | This package checks that your dbt project is sufficiently tested and documented. | -## Advanced tips +## Advanced tips adn techniques - Use your folder structure as your primary selector method. `dbt build --select marts.marketing` is simpler and more resilient than relying on tagging every model. - Think about jobs in terms of build cadences and SLAs. Run models that have hourly, daily, or weekly build cadences together. From ff0b5e9de9e879402cfe45181a8d999d81cf91ab Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 12:05:09 -0500 Subject: [PATCH 22/28] fold feedback --- website/docs/docs/build/dbt-tips.md | 9 +++++---- .../docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md | 9 +++------ 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/website/docs/docs/build/dbt-tips.md b/website/docs/docs/build/dbt-tips.md index e49dd2bd242..681e6b93dfe 100644 --- a/website/docs/docs/build/dbt-tips.md +++ b/website/docs/docs/build/dbt-tips.md @@ -8,9 +8,10 @@ pagination_next: null Use this page for valuable insights and practical advice to enhance your dbt experience. Whether you're new to dbt or an experienced user, these tips are designed to help you work more efficiently and effectively. The following tips are organized into the following categories: -- [Package tips](#package-tips) -- [Advanced tips adn techniques](#advanced-tips-adn-techniques) -- [Related docs](#related-docs) + +- [Package tips](#package-tips) to help you streamline your workflow. +- [Advanced tips and techniques](#advanced-tips-adn-techniques) to help you get the most out of dbt. + If you're developing with the dbt Cloud IDE, you can refer to the [keyboard shortcuts](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) page to help make development more productive and easier for everyone. @@ -28,7 +29,7 @@ Leverage these dbt packages to streamline your workflow: | [`dbt_artifacts`](https://hub.getdbt.com/brooklyn-data/dbt_artifacts/latest) | The package saves information about your dbt runs directly to your data platform so that you can track the performance of models over time. | | [`dbt_meta_testing`](https://hub.getdbt.com/tnightengale/dbt_meta_testing/latest) | This package checks that your dbt project is sufficiently tested and documented. | -## Advanced tips adn techniques +## Advanced tips and techniques - Use your folder structure as your primary selector method. `dbt build --select marts.marketing` is simpler and more resilient than relying on tagging every model. - Think about jobs in terms of build cadences and SLAs. Run models that have hourly, daily, or weekly build cadences together. diff --git a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md index 30f5e1463a1..def74ee53ee 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md @@ -44,17 +44,14 @@ To improve your experience using dbt Cloud, we suggest that you turn off ad bloc ## dbt Cloud IDE features -The dbt Cloud IDE comes with [tips](/docs/build/dbt-tips) and [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models. +The dbt Cloud IDE comes with [features](/docs/cloud/dbt-cloud-ide/ide-user-interface) that make it easier for you to develop, build, compile, run, and test data models. -:::tip Stay informed +To understand how to navigate the IDE and its user interface elements, refer to the [IDE user interface](/docs/cloud/dbt-cloud-ide/ide-user-interface) page. -To stay informed on IDE updates, read [dbt Cloud IDE release notes](/tags/ide), or refer to the [IDE user interface](/docs/cloud/dbt-cloud-ide/ide-user-interface) for comprehensive definitions and terminology of user interface elements. - -::: | Feature | Info | |---|---| -| **Keyboard shortcuts** | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | +| [**Keyboard shortcuts**](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | | **File state indicators** | Ability to see when changes or actions have been made to the file. The indicators **M, D, A,** and **•** appear to the right of your file or folder name and indicate the actions performed:

- Unsaved **(•)** — The IDE detects unsaved changes to your file/folder
- Modification **(M)** — The IDE detects a modification of existing files/folders
- Added **(A)** — The IDE detects added files
- Deleted **(D)** — The IDE detects deleted files. | **IDE version control** | The IDE version control section and git button allow you to apply the concept of [version control](/docs/collaborate/git/version-control-basics) to your project directly into the IDE.

- Create or change branches
- Commit or revert individual files by right-clicking the edited file
- [Resolve merge conflicts](/docs/collaborate/git/merge-conflicts)
- Execute git commands using the git button
- Link to the repo directly by clicking the branch name | | **Project documentation** | Generate and view your [project documentation](/docs/collaborate/build-and-view-your-docs) for your dbt project in real-time. You can inspect and verify what your project's documentation will look like before you deploy your changes to production. | From 3bcf8f0d1deeb08dae0d7b74a6d70edc47abe023 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 12:08:33 -0500 Subject: [PATCH 23/28] fold feedback --- website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md index def74ee53ee..e88fce916ef 100644 --- a/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md +++ b/website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md @@ -51,7 +51,7 @@ To understand how to navigate the IDE and its user interface elements, refer to | Feature | Info | |---|---| -| [**Keyboard shortcuts**](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. This includes the command palette (Command-P or Control-P), which has common shortcuts and build commands to optimize your developer workflow. For example, you can build modified models or continue the build from the last failure point. | +| [**Keyboard shortcuts**](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) | You can access a variety of [commands and actions](/docs/cloud/dbt-cloud-ide/keyboard-shortcuts) in the IDE by choosing the appropriate keyboard shortcut. Use the shortcuts for common tasks like building modified models or resuming builds from the last failure. | | **File state indicators** | Ability to see when changes or actions have been made to the file. The indicators **M, D, A,** and **•** appear to the right of your file or folder name and indicate the actions performed:

- Unsaved **(•)** — The IDE detects unsaved changes to your file/folder
- Modification **(M)** — The IDE detects a modification of existing files/folders
- Added **(A)** — The IDE detects added files
- Deleted **(D)** — The IDE detects deleted files. | **IDE version control** | The IDE version control section and git button allow you to apply the concept of [version control](/docs/collaborate/git/version-control-basics) to your project directly into the IDE.

- Create or change branches
- Commit or revert individual files by right-clicking the edited file
- [Resolve merge conflicts](/docs/collaborate/git/merge-conflicts)
- Execute git commands using the git button
- Link to the repo directly by clicking the branch name | | **Project documentation** | Generate and view your [project documentation](/docs/collaborate/build-and-view-your-docs) for your dbt project in real-time. You can inspect and verify what your project's documentation will look like before you deploy your changes to production. | From 2c384e2bebba1f24f1a29a68e969cb4d4a5c6e01 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 18 Dec 2023 12:14:06 -0500 Subject: [PATCH 24/28] update rn versions updating rn versions as the legacy sl was supported in dbt v1.5 and lower. --- .../docs/dbt-versions/release-notes/74-Dec-2023/legacy-sl.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legacy-sl.md b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legacy-sl.md index 0eecfea623e..f6c18b2a053 100644 --- a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legacy-sl.md +++ b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/legacy-sl.md @@ -23,11 +23,11 @@ The [re-released dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl), power ### Breaking changes and recommendations -- For users on dbt version 1.6 and lower with dbt Metrics and Snowflake proxy: +- For users on dbt version 1.5 and lower with dbt Metrics and Snowflake proxy: - **Impact**: Post-deprecation, queries using the proxy _will not_ run. - **Action required:** _Immediate_ migration is necessary. Refer to the [dbt Semantic Layer migration guide](/guides/sl-migration?step=1) -- For users on dbt version 1.6 and lower using dbt Metrics without Snowflake proxy: +- For users on dbt version 1.5 and lower using dbt Metrics without Snowflake proxy: - **Impact**: No immediate disruption, but the package will not receive updates or support after deprecation - **Recommendation**: Plan migration to the re-released Semantic Layer for compatibility with dbt version 1.6 and higher. From 48d2bf70eef224c25a2bb1ad86b243273d0aae2a Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 13:49:24 -0500 Subject: [PATCH 25/28] add rn content --- .../74-Dec-2023/dec-sl-releases.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md diff --git a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md new file mode 100644 index 00000000000..568d9fb3752 --- /dev/null +++ b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md @@ -0,0 +1,22 @@ +--- +title: "Updates and fixes: dbt Semantic Layer and MetricFlow updates for the month of December 2023." +description: "December 2023: Enhanced Tableau integration, BIGINT support, LookML to MetricFlow conversion, and deprecation of legacy features." +sidebar_label: "Update ad fixes: dbt Semantic Layer and MetricFlow." +sidebar_position: 08 +date: 2023-12-22 +--- + +The dbt Labs team continues to work on adding new features, fixing bugs, and increasing reliability for the dbt Semantic Layer and MetricFlow. Here are the updates and fixes for the month of December 2023. + +## Bug fixes + +- The dbt Semantic Layer integration with Tableau now supports using exclude in its user interface. Previously it wasn't supported. +- The dbt Semantic Layer can support `BIGINT` with over 18 digits. Previously it would return an error. +- The [dbt converter tool](https://github.com/dbt-labs/dbt-converter) can now convert data definitions from LookML to MetricFlow and help users upgrade. Previously this wasn't available. (converts from lookml to metricflow specs). ROXI TO CLARIFY WITH NICK TO DETERMINE IF WE WANT TO TALK ABOUT THIS NOW OR LATER ON WHEN IT HAS MORE FEATURES. + +## Improvements + +- dbt Labs deprecated [dbt Metrics and the legacy dbt Semantic Layer](/docs/dbt-versions/release-notes/Dec-2023/legacy-sl), both supported on dbt version 1.5 or lower. This change came into effect on December 15th, 2023. + +## New features +- Test From bc11f6c4a451d1d8784f882ce0e7d0d46ea3419e Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 13:51:46 -0500 Subject: [PATCH 26/28] remove --- .../74-Dec-2023/dec-sl-releases.md | 22 ------------------- 1 file changed, 22 deletions(-) delete mode 100644 website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md diff --git a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md deleted file mode 100644 index 568d9fb3752..00000000000 --- a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Updates and fixes: dbt Semantic Layer and MetricFlow updates for the month of December 2023." -description: "December 2023: Enhanced Tableau integration, BIGINT support, LookML to MetricFlow conversion, and deprecation of legacy features." -sidebar_label: "Update ad fixes: dbt Semantic Layer and MetricFlow." -sidebar_position: 08 -date: 2023-12-22 ---- - -The dbt Labs team continues to work on adding new features, fixing bugs, and increasing reliability for the dbt Semantic Layer and MetricFlow. Here are the updates and fixes for the month of December 2023. - -## Bug fixes - -- The dbt Semantic Layer integration with Tableau now supports using exclude in its user interface. Previously it wasn't supported. -- The dbt Semantic Layer can support `BIGINT` with over 18 digits. Previously it would return an error. -- The [dbt converter tool](https://github.com/dbt-labs/dbt-converter) can now convert data definitions from LookML to MetricFlow and help users upgrade. Previously this wasn't available. (converts from lookml to metricflow specs). ROXI TO CLARIFY WITH NICK TO DETERMINE IF WE WANT TO TALK ABOUT THIS NOW OR LATER ON WHEN IT HAS MORE FEATURES. - -## Improvements - -- dbt Labs deprecated [dbt Metrics and the legacy dbt Semantic Layer](/docs/dbt-versions/release-notes/Dec-2023/legacy-sl), both supported on dbt version 1.5 or lower. This change came into effect on December 15th, 2023. - -## New features -- Test From 519a25ff340732f9c49bfaf70a3d9f27e95efd4d Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 13:52:38 -0500 Subject: [PATCH 27/28] Revert "remove" This reverts commit bc11f6c4a451d1d8784f882ce0e7d0d46ea3419e. --- .../74-Dec-2023/dec-sl-releases.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md diff --git a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md new file mode 100644 index 00000000000..568d9fb3752 --- /dev/null +++ b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md @@ -0,0 +1,22 @@ +--- +title: "Updates and fixes: dbt Semantic Layer and MetricFlow updates for the month of December 2023." +description: "December 2023: Enhanced Tableau integration, BIGINT support, LookML to MetricFlow conversion, and deprecation of legacy features." +sidebar_label: "Update ad fixes: dbt Semantic Layer and MetricFlow." +sidebar_position: 08 +date: 2023-12-22 +--- + +The dbt Labs team continues to work on adding new features, fixing bugs, and increasing reliability for the dbt Semantic Layer and MetricFlow. Here are the updates and fixes for the month of December 2023. + +## Bug fixes + +- The dbt Semantic Layer integration with Tableau now supports using exclude in its user interface. Previously it wasn't supported. +- The dbt Semantic Layer can support `BIGINT` with over 18 digits. Previously it would return an error. +- The [dbt converter tool](https://github.com/dbt-labs/dbt-converter) can now convert data definitions from LookML to MetricFlow and help users upgrade. Previously this wasn't available. (converts from lookml to metricflow specs). ROXI TO CLARIFY WITH NICK TO DETERMINE IF WE WANT TO TALK ABOUT THIS NOW OR LATER ON WHEN IT HAS MORE FEATURES. + +## Improvements + +- dbt Labs deprecated [dbt Metrics and the legacy dbt Semantic Layer](/docs/dbt-versions/release-notes/Dec-2023/legacy-sl), both supported on dbt version 1.5 or lower. This change came into effect on December 15th, 2023. + +## New features +- Test From a823147a03f262597b6c7429bad4a2def64e0ea0 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 18 Dec 2023 13:54:13 -0500 Subject: [PATCH 28/28] remove --- .../74-Dec-2023/dec-sl-releases.md | 22 ------------------- 1 file changed, 22 deletions(-) delete mode 100644 website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md diff --git a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md b/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md deleted file mode 100644 index 568d9fb3752..00000000000 --- a/website/docs/docs/dbt-versions/release-notes/74-Dec-2023/dec-sl-releases.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Updates and fixes: dbt Semantic Layer and MetricFlow updates for the month of December 2023." -description: "December 2023: Enhanced Tableau integration, BIGINT support, LookML to MetricFlow conversion, and deprecation of legacy features." -sidebar_label: "Update ad fixes: dbt Semantic Layer and MetricFlow." -sidebar_position: 08 -date: 2023-12-22 ---- - -The dbt Labs team continues to work on adding new features, fixing bugs, and increasing reliability for the dbt Semantic Layer and MetricFlow. Here are the updates and fixes for the month of December 2023. - -## Bug fixes - -- The dbt Semantic Layer integration with Tableau now supports using exclude in its user interface. Previously it wasn't supported. -- The dbt Semantic Layer can support `BIGINT` with over 18 digits. Previously it would return an error. -- The [dbt converter tool](https://github.com/dbt-labs/dbt-converter) can now convert data definitions from LookML to MetricFlow and help users upgrade. Previously this wasn't available. (converts from lookml to metricflow specs). ROXI TO CLARIFY WITH NICK TO DETERMINE IF WE WANT TO TALK ABOUT THIS NOW OR LATER ON WHEN IT HAS MORE FEATURES. - -## Improvements - -- dbt Labs deprecated [dbt Metrics and the legacy dbt Semantic Layer](/docs/dbt-versions/release-notes/Dec-2023/legacy-sl), both supported on dbt version 1.5 or lower. This change came into effect on December 15th, 2023. - -## New features -- Test