From 790b77eb3af9da8ee7d118788f3a3a8517bb5ce6 Mon Sep 17 00:00:00 2001 From: john-rock Date: Tue, 18 Jul 2023 15:18:48 -0400 Subject: [PATCH 001/104] add workflow file --- .github/workflows/repo-sync.yml | 95 +++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 .github/workflows/repo-sync.yml diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml new file mode 100644 index 00000000000..ce12e6eda02 --- /dev/null +++ b/.github/workflows/repo-sync.yml @@ -0,0 +1,95 @@ +name: Repo Sync + +# **What it does**: Syncs docs.getdbt.com public repo into the docs private repo +# This GitHub Actions workflow keeps the `current` branch of those two repos in sync. +# **Why we have it**: To keep the open-source repository up-to-date +# while still having an internal repository for sensitive work. +# For more details, see https://github.com/repo-sync/repo-sync#how-it-works + +on: + schedule: + - cron: '*/15 * * * *' # Run every 15 minutes + +jobs: + repo-sync: + permissions: + contents: write + pull-requests: write + name: Repo Sync + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + # Use the INTERMEDIATE_BRANCH as the checkout reference + ref: ${{ secrets.INTERMEDIATE_BRANCH }} + token: ${{ secrets.GITHUB_TOKEN }} + # Fetch all history for all branches and tags + fetch-depth: 0 + + # Sync the source repo to the destination branch using repo-sync/github-sync + - uses: repo-sync/github-sync@v2 + name: Sync repo to branch + with: + # Source repository to sync from + source_repo: ${{ secrets.SOURCE_REPO }} + # Source branch to sync from + source_branch: current + # Destination branch to sync to + destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }} + github_token: ${{ secrets.WORKFLOW_TOKEN }} + + - name: Ship pull request + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.WORKFLOW_TOKEN }} + result-encoding: string + script: | + const {owner, repo} = context.repo; + const head = '${{ secrets.INTERMEDIATE_BRANCH }}'; + const base = 'current' + + async function closePullRequest(prNumber) { + console.log('closing PR', prNumber) + await github.rest.pulls.update({ + owner, + repo, + pull_number: prNumber, + state: 'closed' + }); + console.log('closed PR', prNumber) + } + + console.log('Closing any existing PRs') + const { data: existingPRs } = await github.rest.pulls.list({ + owner, + repo, + head, + base, + }); + + for (const pr of existingPRs) { + if (pr.head.ref === head) { + await closePullRequest(pr.number); + } + } + + try { + console.log('Creating new PR') + const { data: newPR } = await github.rest.pulls.create({ + owner, + repo, + head, + base, + title: 'REPO SYNC - Public to Private', + body: 'This is an automated pull request to sync changes between the public and private repos.', + }); + + console.log('Created new PR', newPR) + } catch (err) { + // Don't error/alert if there's no commits to sync + if (err.message?.includes('No commits')) { + console.log(err.message) + return + } + throw err + } From f4f1f1f4ee6929e18901e8529d374044f8ea083d Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 13:30:18 -0400 Subject: [PATCH 002/104] merge pr automatically --- .github/workflows/repo-sync.yml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index ce12e6eda02..2dd7aafece4 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -93,3 +93,31 @@ jobs: } throw err } + + const { data: prFiles } = await github.rest.pulls.listFiles({ owner, repo, pull_number }) + if (prFiles.length) { + console.log(prFiles.length, 'files have changed') + } else { + console.log('No files changed, closing') + await closePullRequest(pull_number) + return + } + + console.log('Checking for merge conflicts') + if (pull.mergeable_state === 'dirty') { + console.log('Pull request has a conflict', pull.html_url) + await closePullRequest(pull_number) + throw new Error('Pull request has a conflict, please resolve manually') + } + console.log('No detected merge conflicts') + + console.log('Merging the pull request') + // Admin merge pull request to avoid squash + await github.rest.pulls.merge({ + owner, + repo, + pull_number, + merge_method: 'merge', + }) + // Error loud here, so no try/catch + console.log('Merged the pull request successfully') From f5106cceb1babdb3792c8218fbf29ba669b74e87 Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 14:08:37 -0400 Subject: [PATCH 003/104] add pr var --- .github/workflows/repo-sync.yml | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index ce12e6eda02..a4ddb3d0f40 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -83,6 +83,9 @@ jobs: title: 'REPO SYNC - Public to Private', body: 'This is an automated pull request to sync changes between the public and private repos.', }); + pull = response.data + pull_number = pull.number + console.log('Created pull request successfully', pull.html_url) console.log('Created new PR', newPR) } catch (err) { @@ -93,3 +96,31 @@ jobs: } throw err } + + const { data: prFiles } = await github.rest.pulls.listFiles({ owner, repo, pull_number }) + if (prFiles.length) { + console.log(prFiles.length, 'files have changed') + } else { + console.log('No files changed, closing') + await closePullRequest(pull_number) + return + } + + console.log('Checking for merge conflicts') + if (pull.mergeable_state === 'dirty') { + console.log('Pull request has a conflict', pull.html_url) + await closePullRequest(pull_number) + throw new Error('Pull request has a conflict, please resolve manually') + } + console.log('No detected merge conflicts') + + console.log('Merging the pull request') + // Admin merge pull request to avoid squash + await github.rest.pulls.merge({ + owner, + repo, + pull_number, + merge_method: 'merge', + }) + // Error loud here, so no try/catch + console.log('Merged the pull request successfully') From db5325a3ea996707a845b1b15d98bd9cce3d3ed9 Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 14:24:38 -0400 Subject: [PATCH 004/104] adjust call --- .github/workflows/repo-sync.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index a4ddb3d0f40..7728b1099e8 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -67,15 +67,19 @@ jobs: base, }); - for (const pr of existingPRs) { - if (pr.head.ref === head) { - await closePullRequest(pr.number); + console.log('Closing any existing pull requests') + const { data: existingPulls } = await github.rest.pulls.list({ owner, repo, head, base }) + if (existingPulls.length) { + console.log('Found existing pull requests', existingPulls.map(pull => pull.number)) + for (const pull of existingPulls) { + await closePullRequest(pull.number) } + console.log('Closed existing pull requests') } try { console.log('Creating new PR') - const { data: newPR } = await github.rest.pulls.create({ + const response = await github.rest.pulls.create({ owner, repo, head, @@ -87,7 +91,6 @@ jobs: pull_number = pull.number console.log('Created pull request successfully', pull.html_url) - console.log('Created new PR', newPR) } catch (err) { // Don't error/alert if there's no commits to sync if (err.message?.includes('No commits')) { From 54ad4667971f7d8e78551f283ecba6d99ea92577 Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 14:28:11 -0400 Subject: [PATCH 005/104] refactor --- .github/workflows/repo-sync.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 7728b1099e8..abda465c5a4 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -59,14 +59,6 @@ jobs: console.log('closed PR', prNumber) } - console.log('Closing any existing PRs') - const { data: existingPRs } = await github.rest.pulls.list({ - owner, - repo, - head, - base, - }); - console.log('Closing any existing pull requests') const { data: existingPulls } = await github.rest.pulls.list({ owner, repo, head, base }) if (existingPulls.length) { From d3e86724f37922389d45eb4b416f2f09a463a5ea Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 14:29:26 -0400 Subject: [PATCH 006/104] more refactoring --- .github/workflows/repo-sync.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index abda465c5a4..59e2b0be7ac 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -69,8 +69,9 @@ jobs: console.log('Closed existing pull requests') } + console.log('Creating new PR') + let pull, pull_number try { - console.log('Creating new PR') const response = await github.rest.pulls.create({ owner, repo, From a7b9d3f1c5ad36b02ccc8dfebf25b5a11b3c4994 Mon Sep 17 00:00:00 2001 From: john-rock Date: Fri, 21 Jul 2023 14:51:50 -0400 Subject: [PATCH 007/104] prevent open prs from being closed --- .github/workflows/repo-sync.yml | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 59e2b0be7ac..c87de9fbb2c 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -59,16 +59,6 @@ jobs: console.log('closed PR', prNumber) } - console.log('Closing any existing pull requests') - const { data: existingPulls } = await github.rest.pulls.list({ owner, repo, head, base }) - if (existingPulls.length) { - console.log('Found existing pull requests', existingPulls.map(pull => pull.number)) - for (const pull of existingPulls) { - await closePullRequest(pull.number) - } - console.log('Closed existing pull requests') - } - console.log('Creating new PR') let pull, pull_number try { @@ -110,8 +100,8 @@ jobs: } console.log('No detected merge conflicts') + console.log('Merging the pull request') - // Admin merge pull request to avoid squash await github.rest.pulls.merge({ owner, repo, From 8fba60e54053f65733c3de48eb5665147e164528 Mon Sep 17 00:00:00 2001 From: Ly Nguyen Date: Mon, 31 Jul 2023 09:04:01 -0700 Subject: [PATCH 008/104] Test commit --- website/docs/docs/about-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/about-setup.md b/website/docs/docs/about-setup.md index 3fb868b8448..db3cd749190 100644 --- a/website/docs/docs/about-setup.md +++ b/website/docs/docs/about-setup.md @@ -5,7 +5,7 @@ description: "About setup of dbt Core and Cloud" sidebar_label: "About dbt setup" --- -dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for deploying dbt: +dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for using dbt: **dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated developer environment (IDE). From 67755e6f7ac238edf3ca85ee12d5dee00226ade5 Mon Sep 17 00:00:00 2001 From: Ly Nguyen Date: Mon, 31 Jul 2023 09:11:27 -0700 Subject: [PATCH 009/104] Undo test commit --- website/docs/docs/about-setup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/about-setup.md b/website/docs/docs/about-setup.md index db3cd749190..3fb868b8448 100644 --- a/website/docs/docs/about-setup.md +++ b/website/docs/docs/about-setup.md @@ -5,7 +5,7 @@ description: "About setup of dbt Core and Cloud" sidebar_label: "About dbt setup" --- -dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for using dbt: +dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for deploying dbt: **dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated developer environment (IDE). From 449acb9f3a0c34400ac36b1b360814bf8886b3dd Mon Sep 17 00:00:00 2001 From: john-rock Date: Tue, 1 Aug 2023 11:08:18 -0400 Subject: [PATCH 010/104] adjust to run 3 times per day --- .github/workflows/repo-sync.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index c87de9fbb2c..981f322c83f 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -8,7 +8,7 @@ name: Repo Sync on: schedule: - - cron: '*/15 * * * *' # Run every 15 minutes + - cron: '0 6,12,18 * * *' # Run at 6:00 AM, 12:00 PM, and 6:00 PM jobs: repo-sync: From 507fa1e7e4e1e1cfacf86fed72ba1dce9918a95d Mon Sep 17 00:00:00 2001 From: john-rock Date: Tue, 1 Aug 2023 11:15:00 -0400 Subject: [PATCH 011/104] small adjustments --- .github/workflows/repo-sync.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 981f322c83f..8f2320217b2 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -96,17 +96,16 @@ jobs: if (pull.mergeable_state === 'dirty') { console.log('Pull request has a conflict', pull.html_url) await closePullRequest(pull_number) - throw new Error('Pull request has a conflict, please resolve manually') + throw new Error('PR has a conflict, please resolve manually') } console.log('No detected merge conflicts') - console.log('Merging the pull request') + console.log('Merging the PR') await github.rest.pulls.merge({ owner, repo, pull_number, merge_method: 'merge', }) - // Error loud here, so no try/catch - console.log('Merged the pull request successfully') + console.log('Merged the PR successfully') From 51a85a6e73d246f96ade9e4d11d4a68401dea8c2 Mon Sep 17 00:00:00 2001 From: Anders Swanson Date: Mon, 2 Oct 2023 11:19:55 -0400 Subject: [PATCH 012/104] more trusted adapters --- website/snippets/_adapters-trusted.md | 10 ++ website/static/img/icons/materialize.svg | 20 +++ website/static/img/icons/oracle.svg | 155 ++++++++++++++++++ .../static/img/icons/white/materialize.svg | 20 +++ website/static/img/icons/white/oracle.svg | 155 ++++++++++++++++++ 5 files changed, 360 insertions(+) create mode 100644 website/static/img/icons/materialize.svg create mode 100644 website/static/img/icons/oracle.svg create mode 100644 website/static/img/icons/white/materialize.svg create mode 100644 website/static/img/icons/white/oracle.svg diff --git a/website/snippets/_adapters-trusted.md b/website/snippets/_adapters-trusted.md index 10af0218e22..d94a87dd153 100644 --- a/website/snippets/_adapters-trusted.md +++ b/website/snippets/_adapters-trusted.md @@ -5,4 +5,14 @@ body="Install using the CLI

" icon="athena"/> + + + + diff --git a/website/static/img/icons/materialize.svg b/website/static/img/icons/materialize.svg new file mode 100644 index 00000000000..92f693cd94f --- /dev/null +++ b/website/static/img/icons/materialize.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + diff --git a/website/static/img/icons/oracle.svg b/website/static/img/icons/oracle.svg new file mode 100644 index 00000000000..59aa1f16c8e --- /dev/null +++ b/website/static/img/icons/oracle.svg @@ -0,0 +1,155 @@ + + + + + + + + 2022-03-04T16:18:02-06:00 + xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 + xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a + xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a + + + + + saved + xmp.iid:2d9bf348-863c-4d93-ac30-a8107201442a + 2021-04-27T13:41:28-05:00 + Adobe Bridge 2021 (Macintosh) + /metadata + + + + + saved + xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 + 2022-03-04T16:18:02-06:00 + Adobe Bridge 2021 (Macintosh) + /metadata + + + + + True + + + icon + Data + aggregation + management + system + business + intelligence + analytics + store + analysis + icon + Business + Data + machine learning + artificial intelligence + automate + automatization + security + backup + update + task + ADCS + autonomous + service + + + + + Oracle All Rights Reserved + + + + + Data Management + Service + Autonomous + Database + Cloud + icon + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/website/static/img/icons/white/materialize.svg b/website/static/img/icons/white/materialize.svg new file mode 100644 index 00000000000..92f693cd94f --- /dev/null +++ b/website/static/img/icons/white/materialize.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + diff --git a/website/static/img/icons/white/oracle.svg b/website/static/img/icons/white/oracle.svg new file mode 100644 index 00000000000..59aa1f16c8e --- /dev/null +++ b/website/static/img/icons/white/oracle.svg @@ -0,0 +1,155 @@ + + + + + + + + 2022-03-04T16:18:02-06:00 + xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 + xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a + xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a + + + + + saved + xmp.iid:2d9bf348-863c-4d93-ac30-a8107201442a + 2021-04-27T13:41:28-05:00 + Adobe Bridge 2021 (Macintosh) + /metadata + + + + + saved + xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 + 2022-03-04T16:18:02-06:00 + Adobe Bridge 2021 (Macintosh) + /metadata + + + + + True + + + icon + Data + aggregation + management + system + business + intelligence + analytics + store + analysis + icon + Business + Data + machine learning + artificial intelligence + automate + automatization + security + backup + update + task + ADCS + autonomous + service + + + + + Oracle All Rights Reserved + + + + + Data Management + Service + Autonomous + Database + Cloud + icon + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 1be458c80991b49fdd62b6f67222b0f9228d7d62 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 3 Oct 2023 09:28:51 +0100 Subject: [PATCH 013/104] Update _adapters-trusted.md --- website/snippets/_adapters-trusted.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/website/snippets/_adapters-trusted.md b/website/snippets/_adapters-trusted.md index d94a87dd153..003c12cc370 100644 --- a/website/snippets/_adapters-trusted.md +++ b/website/snippets/_adapters-trusted.md @@ -2,17 +2,20 @@ From f67d8f25cb95c8f920f1a8f7848e8e23ead91ef6 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Oct 2023 11:22:28 +0100 Subject: [PATCH 014/104] add card --- website/docs/docs/cloud/about-cloud/dbt-cloud-features.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md b/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md index f1d8b32cdb1..a900651cec0 100644 --- a/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md +++ b/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md @@ -15,9 +15,15 @@ dbt Cloud's [flexible plans](https://www.getdbt.com/pricing/) and features make + + Date: Wed, 4 Oct 2023 13:51:54 +0100 Subject: [PATCH 015/104] add cloud cli to relevant pages --- website/docs/docs/about-setup.md | 4 +- .../cloud/about-cloud/dbt-cloud-features.md | 53 ++++++++++--------- .../manage-access/cloud-seats-and-users.md | 1 + .../manage-access/self-service-permissions.md | 3 +- website/docs/docs/connect-adapters.md | 4 +- website/docs/docs/dbt-cloud-environments.md | 4 +- website/docs/docs/environments-in-dbt.md | 2 +- website/docs/docs/introduction.md | 5 +- website/docs/docs/supported-data-platforms.md | 4 +- website/docs/docs/trusted-adapters.md | 2 +- website/snippets/_adapters-trusted.md | 2 +- website/snippets/_adapters-verified.md | 25 +++++---- website/snippets/_cloud-environments-info.md | 10 ++-- 13 files changed, 62 insertions(+), 57 deletions(-) diff --git a/website/docs/docs/about-setup.md b/website/docs/docs/about-setup.md index 3fb868b8448..91c4ff05be8 100644 --- a/website/docs/docs/about-setup.md +++ b/website/docs/docs/about-setup.md @@ -7,7 +7,7 @@ sidebar_label: "About dbt setup" dbt compiles and runs your analytics code against your data platform, enabling you and your team to collaborate on a single source of truth for metrics, insights, and business definitions. There are two options for deploying dbt: -**dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated developer environment (IDE). +**dbt Cloud** runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based interface. The intuitive UI will aid you in setting up the various components. dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring and alerting, an integrated development environment (IDE), and allows you to develop and run dbt commands from your local command line (CLI) or code editor. **dbt Core** is an open-source command line tool that can be installed locally in your environment, and communication with databases is facilitated through adapters. @@ -19,7 +19,7 @@ To begin configuring dbt now, select the option that is right for you. diff --git a/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md b/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md index a900651cec0..c66f3322f3f 100644 --- a/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md +++ b/website/docs/docs/cloud/about-cloud/dbt-cloud-features.md @@ -6,90 +6,91 @@ description: "Explore dbt Cloud's features and learn why dbt Cloud is the fastes hide_table_of_contents: true --- -dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, document, and investigate data models all in one browser-based UI. In addition to providing a hosted architecture for running dbt across your organization, dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring & alerting, and an integrated development environment (IDE). +dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, document, and investigate data models all in one browser-based UI. + +In addition to providing a hosted architecture for running dbt across your organization, dbt Cloud comes equipped with turnkey support for scheduling jobs, CI/CD, hosting documentation, monitoring and alerting, an integrated development environment (IDE), and allows you to develop and run dbt commands from your local command line (CLI) or code editor. dbt Cloud's [flexible plans](https://www.getdbt.com/pricing/) and features make it well-suited for data teams of any size — sign up for your [free 14-day trial](https://www.getdbt.com/signup/)!
+ title="dbt Cloud CLI" + body="Use the dbt Cloud CLI to develop, test, run, and version control dbt projects and commands in your dbt Cloud development environment. Collaborate with team members, directly from the command line." + link="/docs/cloud/cloud-cli-installation" + icon="dbt-bit"/> + link="/docs/cloud/cloud-cli-installation" + icon="dbt-bit"/> + icon="dbt-bit"/> + icon="dbt-bit"/> + icon="dbt-bit"/> + + + icon="dbt-bit"/> + icon="dbt-bit"/> + icon="dbt-bit"/> + icon="dbt-bit"/> + icon="dbt-bit"/> - + icon="dbt-bit"/> - - - + icon="dbt-bit"/>

*These features are available on [selected plans](https://www.getdbt.com/pricing/). diff --git a/website/docs/docs/cloud/manage-access/cloud-seats-and-users.md b/website/docs/docs/cloud/manage-access/cloud-seats-and-users.md index 04dfbe093c3..c8532c3d7d3 100644 --- a/website/docs/docs/cloud/manage-access/cloud-seats-and-users.md +++ b/website/docs/docs/cloud/manage-access/cloud-seats-and-users.md @@ -16,6 +16,7 @@ The user's assigned license determines the specific capabilities they can access | Functionality | Developer User | Read-Only Users | IT Users* | | ------------- | -------------- | --------------- | -------- | | Use the dbt Cloud IDE | ✅ | ❌ | ❌ | +| Use the dbt Cloud CLI | ✅ | ❌ | ❌ | | Use Jobs | ✅ | ❌ | ❌ | | Manage Account | ✅ | ❌ | ✅ | | API Access | ✅ | ❌ | ❌ | diff --git a/website/docs/docs/cloud/manage-access/self-service-permissions.md b/website/docs/docs/cloud/manage-access/self-service-permissions.md index 21cc765b76d..d3c9cf8f5ea 100644 --- a/website/docs/docs/cloud/manage-access/self-service-permissions.md +++ b/website/docs/docs/cloud/manage-access/self-service-permissions.md @@ -12,7 +12,8 @@ The permissions afforded to each role are described below: | ------ | ------ | ----- | | View and edit resources | ✅ | ✅ | | Trigger runs | ✅ | ✅ | -| Access the IDE | ✅ | ✅ | +| Access the dbt Cloud IDE | ✅ | ✅ | +| Access the dbt Cloud CLI | ✅ | ✅ | | Invite Members to the account | ✅ | ✅ | | Manage billing | ❌ | ✅ | | Manage team permissions | ❌ | ✅ | diff --git a/website/docs/docs/connect-adapters.md b/website/docs/docs/connect-adapters.md index f45da732abb..77ead34e51d 100644 --- a/website/docs/docs/connect-adapters.md +++ b/website/docs/docs/connect-adapters.md @@ -11,9 +11,9 @@ This section provides more details on different ways you can connect dbt to an a Explore the fastest and most reliable way to deploy dbt using dbt Cloud, a hosted architecture that runs dbt Core across your organization. dbt Cloud lets you seamlessly [connect](/docs/cloud/about-cloud-setup) with a variety of [verified](/docs/supported-data-platforms) data platform providers directly in the dbt Cloud UI. -### Install using the CLI +### Install with dbt Core -Install dbt Core, which is an open-source tool, locally using the CLI. dbt communicates with a number of different data platforms by using a dedicated adapter plugin for each. When you install dbt Core, you'll also need to install the specific adapter for your database, [connect to dbt Core](/docs/core/about-core-setup), and set up a `profiles.yml` file. +Install dbt Core, an open-source tool, locally using the command line. dbt communicates with a number of different data platforms by using a dedicated adapter plugin for each. When you install dbt Core, you'll also need to install the specific adapter for your database, [connect to dbt Core](/docs/core/about-core-setup), and set up a `profiles.yml` file. With a few exceptions [^1], you can install all [Verified adapters](/docs/supported-data-platforms) from PyPI using `pip install adapter-name`. For example to install Snowflake, use the command `pip install dbt-snowflake`. The installation will include `dbt-core` and any other required dependencies, which may include both other dependencies and even other adapter plugins. Read more about [installing dbt](/docs/core/installation). diff --git a/website/docs/docs/dbt-cloud-environments.md b/website/docs/docs/dbt-cloud-environments.md index f61ec5ef72b..333552a8da6 100644 --- a/website/docs/docs/dbt-cloud-environments.md +++ b/website/docs/docs/dbt-cloud-environments.md @@ -4,7 +4,7 @@ id: "dbt-cloud-environments" description: "Learn about dbt Cloud's development environment to execute your project in the IDE" --- -An environment determines how dbt Cloud will execute your project in both the dbt Cloud IDE (for development) and scheduled jobs (for deployment). +An environment determines how dbt Cloud will execute your project in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) (for development) and scheduled jobs (for deployment). Critically, in order to execute dbt, environments define three variables: @@ -34,7 +34,7 @@ To create a new dbt Cloud development environment: ### Set developer credentials -To use the IDE, each developer will need to set up [personal development credentials](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#access-the-cloud-ide) to your warehouse connection in their **Profile Settings**. This allows you to set separate target information and maintain individual credentials to connect to your warehouse via the dbt Cloud IDE. +To use the dbt Cloud IDE or dbt Cloud CLI, each developer will need to set up [personal development credentials](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#access-the-cloud-ide) to your warehouse connection in their **Profile Settings**. This allows you to set separate target information and maintain individual credentials to connect to your warehouse. diff --git a/website/docs/docs/environments-in-dbt.md b/website/docs/docs/environments-in-dbt.md index 54eaa68f667..0139975c5ed 100644 --- a/website/docs/docs/environments-in-dbt.md +++ b/website/docs/docs/environments-in-dbt.md @@ -18,7 +18,7 @@ Configure environments to tell dbt Cloud or dbt Core how to build and execute yo diff --git a/website/docs/docs/introduction.md b/website/docs/docs/introduction.md index c4cfd6e45ac..5fb16a0778c 100644 --- a/website/docs/docs/introduction.md +++ b/website/docs/docs/introduction.md @@ -28,6 +28,7 @@ Read more about why we want to enable analysts to work more like software engine You can access dbt using dbt Core or dbt Cloud. dbt Cloud is built around dbt Core, but it also provides: - Web-based UI so it’s more accessible +- dbt Cloud-powered command line (CLI) to develop, test, version control dbt projects, and run dbt commands - Hosted environment so it’s faster to get up and running - Differentiated features, such as metadata, in-app job scheduler, observability, integrations with other tools, integrated development environment (IDE), and more. @@ -35,7 +36,9 @@ You can learn about plans and pricing on [www.getdbt.com](https://www.getdbt.com ### dbt Cloud -dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and try one of the [dbt Cloud quickstarts](/quickstarts). +dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. dbt Cloud also natively supports developing using a command line to run dbt commands against your dbt Cloud development environment. + +Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and try one of the [dbt Cloud quickstarts](/quickstarts). ### dbt Core diff --git a/website/docs/docs/supported-data-platforms.md b/website/docs/docs/supported-data-platforms.md index 8ac782991c8..95ef9b5ef88 100644 --- a/website/docs/docs/supported-data-platforms.md +++ b/website/docs/docs/supported-data-platforms.md @@ -8,7 +8,7 @@ hide_table_of_contents: true dbt connects to and runs SQL against your database, warehouse, lake, or query engine. These SQL-speaking platforms are collectively referred to as _data platforms_. dbt connects with data platforms by using a dedicated adapter plugin for each. Plugins are built as Python modules that dbt Core discovers if they are installed on your system. Read [What are Adapters](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters) for more info. -You can [connect](/docs/connect-adapters) to adapters and data platforms either directly in the dbt Cloud user interface (UI) or install them manually using the command line (CLI). +You can [connect](/docs/connect-adapters) to adapters and data platforms natively in dbt Cloud or install them manually using dbt Core. You can also further customize how dbt works with your specific data platform via configuration: see [Configuring Postgres](/reference/resource-configs/postgres-configs) for an example. @@ -36,5 +36,5 @@ import AdaptersTrusted from '/snippets/_adapters-trusted.md'; -
* Install these adapters using the CLI as they're not currently supported in dbt Cloud.
+
* Install these adapters using dbt Core as they're not currently supported in dbt Cloud.
diff --git a/website/docs/docs/trusted-adapters.md b/website/docs/docs/trusted-adapters.md index e19bb40785f..08191e8ea42 100644 --- a/website/docs/docs/trusted-adapters.md +++ b/website/docs/docs/trusted-adapters.md @@ -6,7 +6,7 @@ hide_table_of_contents: true Trusted adapters are adapters not maintained by dbt Labs, that we feel comfortable recommending to users for use in production. -Free and open-source tools for the data professional are increasingly abundant. This is by-and-large a *good thing*, however it requires due dilligence that wasn't required in a paid-license, closed-source software world. As a user, there are questions to answer important before taking a dependency on an open-source project. The trusted adapter designation is meant to streamline this process for end users. +Free and open-source tools for the data professional are increasingly abundant. This is by-and-large a *good thing*, however it requires due diligence that wasn't required in a paid-license, closed-source software world. As a user, there are questions to answer important before taking a dependency on an open-source project. The trusted adapter designation is meant to streamline this process for end users.
Considerations for depending on an open-source project diff --git a/website/snippets/_adapters-trusted.md b/website/snippets/_adapters-trusted.md index 10af0218e22..1d685bd9261 100644 --- a/website/snippets/_adapters-trusted.md +++ b/website/snippets/_adapters-trusted.md @@ -2,7 +2,7 @@ diff --git a/website/snippets/_adapters-verified.md b/website/snippets/_adapters-verified.md index 7caf099b7d1..3cc1e800448 100644 --- a/website/snippets/_adapters-verified.md +++ b/website/snippets/_adapters-verified.md @@ -2,61 +2,60 @@ -* Install these adapters using the CLI as they're not currently supported in dbt Cloud.
diff --git a/website/snippets/_cloud-environments-info.md b/website/snippets/_cloud-environments-info.md index 5388379dc34..b0c8e86a2b5 100644 --- a/website/snippets/_cloud-environments-info.md +++ b/website/snippets/_cloud-environments-info.md @@ -3,17 +3,17 @@ In dbt Cloud, there are two types of environments: - Deployment environment — Determines the settings used when jobs created within that environment are executed. -- Development environment — Determines the settings used in the dbt Cloud IDE for that particular dbt Cloud project. +- Development environment — Determines the settings used in the dbt Cloud IDE or dbt Cloud CLI, for that particular project. Each dbt Cloud project can only have a single development environment but can have any number of deployment environments. | | Development Environments | Deployment Environments | | --- | --- | --- | -| Determines settings for | dbt Cloud IDE | dbt Cloud Job runs | +| Determines settings for | dbt Cloud IDE or dbt Cloud CLI | dbt Cloud Job runs | | How many can I have in my project? | 1 | Any number | :::note -For users familiar with development on the CLI, each environment is roughly analogous to an entry in your `profiles.yml` file, with some additional information about your repository to ensure the proper version of code is executed. More info on dbt core environments [here](/docs/core/dbt-core-environments). +For users familiar with development on dbt Core, each environment is roughly analogous to an entry in your `profiles.yml` file, with some additional information about your repository to ensure the proper version of code is executed. More info on dbt core environments [here](/docs/core/dbt-core-environments). ::: ## Common environment settings @@ -38,7 +38,7 @@ Both development and deployment environments have a section called **General Set By default, all environments will use the default branch in your repository (usually the `main` branch) when accessing your dbt code. This is overridable within each dbt Cloud Environment using the **Default to a custom branch** option. This setting have will have slightly different behavior depending on the environment type: -- **Development**: determines which branch in the dbt Cloud IDE developers create branches from and open PRs against +- **Development**: determines which branch in the dbt Cloud IDE or dbt Cloud CLI developers create branches from and open PRs against. - **Deployment:** determines the branch is cloned during job executions for each environment. For more info, check out this [FAQ page on this topic](/faqs/Environments/custom-branch-settings)! @@ -59,7 +59,7 @@ Something to note, Extended Attributes doesn't mask secret values. We recommend
-If you're developing in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or [orchestrating job runs](/docs/deploy/deployments), Extended Attributes parses through the provided YAML and extracts the `profiles.yml` attributes. For each individual attribute: +If you're developing in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), [dbt Cloud CLI](/docs/cloud/cloud-cli-installation), or [orchestrating job runs](/docs/deploy/deployments), Extended Attributes parses through the provided YAML and extracts the `profiles.yml` attributes. For each individual attribute: - If the attribute exists in another source (such as your project settings), it will replace its value (like environment-level values) in the profile. It also overrides any custom environment variables. From 32659122ba17a2029bc03297fc3ff8ed2414ee42 Mon Sep 17 00:00:00 2001 From: dave-connors-3 <73915542+dave-connors-3@users.noreply.github.com> Date: Wed, 4 Oct 2023 08:46:11 -0500 Subject: [PATCH 016/104] Update about-cloud-ide.md --- website/docs/docs/cloud/about-cloud/about-cloud-ide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 923212c1260..f0380f109f8 100644 --- a/website/docs/docs/cloud/about-cloud/about-cloud-ide.md +++ b/website/docs/docs/cloud/about-cloud/about-cloud-ide.md @@ -5,7 +5,7 @@ description: "about dbt Cloud Integrated Development Environment" sidebar_label: About dbt Cloud IDE --- -The dbt Cloud integrated development environment (IDE) is a single interface for building, testing, running, and version-controlling dbt projects from your browser. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly. The IDE leverages the open-source [dbt-rpc](/reference/commands/rpc) plugin to recompile only the changes made in your project. +The dbt Cloud integrated development environment (IDE) is a single interface for building, testing, running, and version-controlling dbt projects from your browser. With the Cloud IDE, you can compile dbt code into SQL and run it against your database directly. With the Cloud IDE, you can: From 95c7015d776224ab9166c2de559a40ae1beae7d7 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Oct 2023 15:23:38 +0100 Subject: [PATCH 017/104] cloud cli updates --- .../docs/docs/cloud/git/authenticate-azure.md | 2 +- .../docs/cloud/git/connect-azure-devops.md | 2 +- website/docs/docs/cloud/git/connect-github.md | 2 +- website/docs/docs/cloud/git/connect-gitlab.md | 8 ++++---- website/docs/docs/cloud/git/setup-azure.md | 2 +- website/docs/docs/introduction.md | 3 +-- .../run-your-dbt-projects.md | 19 +++++++++++++++---- .../running-a-dbt-project/using-threads.md | 2 +- 8 files changed, 25 insertions(+), 15 deletions(-) diff --git a/website/docs/docs/cloud/git/authenticate-azure.md b/website/docs/docs/cloud/git/authenticate-azure.md index 03020ccca73..c8a3138c6c7 100644 --- a/website/docs/docs/cloud/git/authenticate-azure.md +++ b/website/docs/docs/cloud/git/authenticate-azure.md @@ -6,7 +6,7 @@ sidebar_label: "Authenticate with Azure DevOps" --- -If you use the dbt Cloud IDE to collaborate on your team's Azure DevOps dbt repo, you need to [link your dbt Cloud profile to Azure DevOps](#link-your-dbt-cloud-profile-to-azure-devops), which provides an extra layer of authentication. +If you use the dbt Cloud IDE or dbt Cloud CLI to collaborate on your team's Azure DevOps dbt repo, you need to [link your dbt Cloud profile to Azure DevOps](#link-your-dbt-cloud-profile-to-azure-devops), which provides an extra layer of authentication. ## Link your dbt Cloud profile to Azure DevOps diff --git a/website/docs/docs/cloud/git/connect-azure-devops.md b/website/docs/docs/cloud/git/connect-azure-devops.md index bc5bb81dd24..684e837cab6 100644 --- a/website/docs/docs/cloud/git/connect-azure-devops.md +++ b/website/docs/docs/cloud/git/connect-azure-devops.md @@ -13,7 +13,7 @@ Connect your Azure DevOps cloud account in dbt Cloud to unlock new product exper - Import new Azure DevOps repos with a couple clicks during dbt Cloud project setup. - Clone repos using HTTPS rather than SSH - Enforce user authorization with OAuth 2.0. -- Carry Azure DevOps user repository permissions (read / write access) through to dbt Cloud IDE's git actions. +- Carry Azure DevOps user repository permissions (read / write access) through to dbt Cloud IDE or dbt Cloud CLI's git actions. - Trigger Continuous integration (CI) builds when pull requests are opened in Azure DevOps. diff --git a/website/docs/docs/cloud/git/connect-github.md b/website/docs/docs/cloud/git/connect-github.md index 771e4286ef6..ff0f2fff18f 100644 --- a/website/docs/docs/cloud/git/connect-github.md +++ b/website/docs/docs/cloud/git/connect-github.md @@ -74,7 +74,7 @@ To connect a personal GitHub account: 4. Once you approve authorization, you will be redirected to dbt Cloud, and you should now see your connected account. -The next time you log into dbt Cloud, you will be able to do so via OAuth through GitHub, and if you're on the Enterprise plan, you're ready to use the dbt Cloud IDE. +The next time you log into dbt Cloud, you will be able to do so via OAuth through GitHub, and if you're on the Enterprise plan, you're ready to use the dbt Cloud IDE or dbt Cloud CLI. ## FAQs diff --git a/website/docs/docs/cloud/git/connect-gitlab.md b/website/docs/docs/cloud/git/connect-gitlab.md index 53fde5f4878..e55552e2d86 100644 --- a/website/docs/docs/cloud/git/connect-gitlab.md +++ b/website/docs/docs/cloud/git/connect-gitlab.md @@ -8,7 +8,7 @@ id: "connect-gitlab" Connecting your GitLab account to dbt Cloud provides convenience and another layer of security to dbt Cloud: - Import new GitLab repos with a couple clicks during dbt Cloud project setup. - Clone repos using HTTPS rather than SSH. -- Carry GitLab user permissions through to dbt Cloud IDE's git actions. +- Carry GitLab user permissions through to dbt Cloud or dbt Cloud CLI's git actions. - Trigger [Continuous integration](/docs/deploy/continuous-integration) builds when merge requests are opened in GitLab. The steps to integrate GitLab in dbt Cloud depend on your plan. If you are on: @@ -35,7 +35,7 @@ Once you've accepted, you should be redirected back to dbt Cloud, and you'll see dbt Cloud enterprise customers have the added benefit of bringing their own GitLab OAuth application to dbt Cloud. This tier benefits from extra security, as dbt Cloud will: - Enforce user authorization with OAuth. -- Carry GitLab's user repository permissions (read / write access) through to dbt Cloud IDE's git actions. +- Carry GitLab's user repository permissions (read / write access) through to dbt Cloud or dbt Cloud CLI's git actions. In order to connect GitLab in dbt Cloud, a GitLab account admin must: 1. [Set up a GitLab OAuth application](#setting-up-a-gitlab-oauth-application). @@ -97,7 +97,7 @@ You will then be redirected to GitLab and prompted to sign into your account. Gi Once you've accepted, you should be redirected back to dbt Cloud, and your integration is ready for developers on your team to [personally authenticate with](#personally-authenticating-with-gitlab). ### Personally authenticating with GitLab -dbt Cloud developers on the Enterprise plan must each connect their GitLab profiles to dbt Cloud, as every developer's read / write access for the dbt repo is checked in the dbt Cloud IDE. +dbt Cloud developers on the Enterprise plan must each connect their GitLab profiles to dbt Cloud, as every developer's read / write access for the dbt repo is checked in the dbt Cloud IDE or dbt Cloud CLI. To connect a personal GitLab account, dbt Cloud developers should navigate to Your Profile settings by clicking the gear icon in the top right, then select **Linked Accounts** in the left menu. @@ -105,7 +105,7 @@ If your GitLab account is not connected, you’ll see "No connected account". Se -Once you approve authorization, you will be redirected to dbt Cloud, and you should see your connected account. You're now ready to start developing in the dbt Cloud IDE. +Once you approve authorization, you will be redirected to dbt Cloud, and you should see your connected account. You're now ready to start developing in the dbt Cloud IDE or dbt Cloud CLI. ## Troubleshooting diff --git a/website/docs/docs/cloud/git/setup-azure.md b/website/docs/docs/cloud/git/setup-azure.md index 9eca77d7014..843371be6ea 100644 --- a/website/docs/docs/cloud/git/setup-azure.md +++ b/website/docs/docs/cloud/git/setup-azure.md @@ -93,7 +93,7 @@ Once you connect your Azure AD app and Azure DevOps, you need to provide dbt Clo - **Directory(tenant) ID:** Found in the Azure AD App. -Your Azure AD app should now be added to your dbt Cloud Account. People on your team who want to develop in dbt Cloud's IDE can now personally [authorize Azure DevOps from their profiles](/docs/cloud/git/authenticate-azure). +Your Azure AD app should now be added to your dbt Cloud Account. People on your team who want to develop in the dbt Cloud IDE or dbt Cloud CLI can now personally [authorize Azure DevOps from their profiles](/docs/cloud/git/authenticate-azure). ## Connect a service user diff --git a/website/docs/docs/introduction.md b/website/docs/docs/introduction.md index 5fb16a0778c..454fbc2248a 100644 --- a/website/docs/docs/introduction.md +++ b/website/docs/docs/introduction.md @@ -36,8 +36,7 @@ You can learn about plans and pricing on [www.getdbt.com](https://www.getdbt.com ### dbt Cloud -dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. dbt Cloud also natively supports developing using a command line to run dbt commands against your dbt Cloud development environment. - +dbt Cloud is the fastest and most reliable way to deploy dbt. Develop, test, schedule, and investigate data models all in one web-based UI. It also natively supports developing using a command line with the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation). Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features) and try one of the [dbt Cloud quickstarts](/quickstarts). ### dbt Core diff --git a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md index 9bd57e0b280..59f20d89f1e 100644 --- a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md +++ b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md @@ -2,13 +2,23 @@ title: "Run your dbt projects" id: "run-your-dbt-projects" --- -You can run your dbt projects with [dbt Cloud](/docs/cloud/about-cloud/dbt-cloud-features) and [dbt Core](https://github.com/dbt-labs/dbt-core). dbt Cloud is a hosted application where you can develop directly from a web browser. dbt Core is an open source project where you can develop from the command line. +You can run your dbt projects with [dbt Cloud](/docs/cloud/about-cloud/dbt-cloud-features) or [dbt Core](https://github.com/dbt-labs/dbt-core): -Among other features, dbt Cloud provides a development environment to help you build, test, run, and [version control](/docs/collaborate/git-version-control) your project faster. It also includes an easier way to share your [dbt project's documentation](/docs/collaborate/build-and-view-your-docs) with your team. These development tasks are directly built into dbt Cloud for an _integrated development environment_ (IDE). Refer to [Develop in the Cloud](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) for more details. +- **dbt Cloud**: A hosted application where you can develop directly from a web browser using the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud). It also natively supports developing using a command line, [dbt Cloud CLI](/docs/cloud/cloud-cli-installation). Among other features, dbt Cloud provides: -With dbt Core, you can run your dbt projects from the command line. The command line interface (CLI) is available from your computer's terminal application such as Terminal and iTerm. When using the command line, you can run commands and do other work from the current working directory on your computer. Before running the dbt project from the command line, make sure you are working in your dbt project directory. Learning terminal commands such as `cd` (change directory), `ls` (list directory contents), and `pwd` (present working directory) can help you navigate the directory structure on your system. + - Development environment to help you build, test, run, and [version control](/docs/collaborate/git-version-control) your project faster. + - Share your [dbt project's documentation](/docs/collaborate/build-and-view-your-docs) with your team. + - Integrates with the dbt Cloud IDE, allowing you to run development tasks and environment in the dbt Cloud UI for a seamless experience. + - Use the dbt Cloud CLI to develop and run dbt commands against your dbt Cloud development environment from your local command line. + - For more details, refer to [Develop in the Cloud](/docs/cloud/about-cloud-develop). -When running your project from dbt Core or dbt Cloud, the commands you commonly use are: +- **dbt Core**: An open source project where you can develop from the command line. + +The dbt Cloud CLI and dbt Core are both command line tools that allow you to run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. + +The command line is available from your computer's terminal application such as Terminal and iTerm. With the command line, you can run commands and do other work from the current working directory on your computer. Before running the dbt project from the command line, make sure you are working in your dbt project directory. Learning terminal commands such as `cd` (change directory), `ls` (list directory contents), and `pwd` (present working directory) can help you navigate the directory structure on your system. + +In dbt Cloud or dbt Cloud, the commands you commonly use are: - [dbt run](/reference/commands/run) — Runs the models you defined in your project - [dbt build](/reference/commands/build) — Builds and tests your selected resources such as models, seeds, snapshots, and tests @@ -20,6 +30,7 @@ For information on all dbt commands and their arguments (flags), see the [dbt co - [How we set up our computers for working on dbt projects](https://discourse.getdbt.com/t/how-we-set-up-our-computers-for-working-on-dbt-projects/243) - [Model selection syntax](/reference/node-selection/syntax) +- [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) - [Cloud IDE features](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud#ide-features) - [Does dbt offer extract and load functionality?](/faqs/Project/transformation-tool) - [Why does dbt compile need a data platform connection](/faqs/Warehouse/db-connection-dbt-compile) diff --git a/website/docs/docs/running-a-dbt-project/using-threads.md b/website/docs/docs/running-a-dbt-project/using-threads.md index 519ce8aab81..11a1a72e655 100644 --- a/website/docs/docs/running-a-dbt-project/using-threads.md +++ b/website/docs/docs/running-a-dbt-project/using-threads.md @@ -18,7 +18,7 @@ Generally the optimal number of threads depends on your data warehouse and its c You can use a different number of threads than the value defined in your target by using the `--threads` option when executing a dbt command. -You will define the number of threads in your `profiles.yml` file (for CLI-users only), dbt Cloud job definition, and dbt Cloud development credentials under your profile. +You will define the number of threads in your `profiles.yml` file (for dbt Core users only), dbt Cloud job definition, and dbt Cloud development credentials under your profile. ## Related docs From c42989606c1d780f38c0104097b9c08cb30670da Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Oct 2023 17:03:21 +0100 Subject: [PATCH 018/104] update command page --- .../running-a-dbt-project/run-your-dbt-projects.md | 2 +- website/docs/reference/dbt-commands.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md index 59f20d89f1e..9cf9002ecc2 100644 --- a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md +++ b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md @@ -18,7 +18,7 @@ The dbt Cloud CLI and dbt Core are both command line tools that allow you to run The command line is available from your computer's terminal application such as Terminal and iTerm. With the command line, you can run commands and do other work from the current working directory on your computer. Before running the dbt project from the command line, make sure you are working in your dbt project directory. Learning terminal commands such as `cd` (change directory), `ls` (list directory contents), and `pwd` (present working directory) can help you navigate the directory structure on your system. -In dbt Cloud or dbt Cloud, the commands you commonly use are: +In dbt Cloud or dbt Core, the commands you commonly use are: - [dbt run](/reference/commands/run) — Runs the models you defined in your project - [dbt build](/reference/commands/build) — Builds and tests your selected resources such as models, seeds, snapshots, and tests diff --git a/website/docs/reference/dbt-commands.md b/website/docs/reference/dbt-commands.md index 862829ef809..83556d5d0fa 100644 --- a/website/docs/reference/dbt-commands.md +++ b/website/docs/reference/dbt-commands.md @@ -2,10 +2,12 @@ title: "dbt Command reference" --- -dbt is typically run one of two ways: +dbt is typically run using the following ways: -* In [dbt Cloud](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) -* On the [command line interface](/docs/core/about-the-cli) (CLI) +* In dbt Cloud using the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) +* On the command line using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) or open-sourced [dbt Core](https://github.com/dbt-labs/dbt-core) + +The dbt Cloud CLI and dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. The following sections outline the commands supported by dbt and their relevant flags. For information about selecting models on the command line, consult the docs on [Model selection syntax](/reference/node-selection/syntax). @@ -13,7 +15,7 @@ The following sections outline the commands supported by dbt and their relevant -Use the following dbt commands in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or [CLI](/docs/core/about-the-cli). Use the `dbt` prefix. For example, to run the `test` command, type `dbt test`. +Use the following dbt commands in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or command line. Use the `dbt` prefix. For example, to run the `test` command, type `dbt test`. | Command | Description | Version | | ------- | ----------- | ------- | @@ -34,7 +36,7 @@ Use the following dbt commands in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/ | [snapshot](/reference/commands/snapshot) | Executes "snapshot" jobs defined in a project | All [supported versions](/docs/dbt-versions/core) | | [source](/reference/commands/source) | Provides tools for working with source data (including validating that
sources are "fresh") | All [supported versions](/docs/dbt-versions/core) | | [test](/reference/commands/test) | Executes tests defined in a project | All [supported versions](/docs/dbt-versions/core) | -| [init](/reference/commands/init) | Initializes a new dbt project (CLI only) | All [supported versions](/docs/dbt-versions/core) | +| [init](/reference/commands/init) | Initializes a new dbt project (dbt Core only) | All [supported versions](/docs/dbt-versions/core) | From 123437f84f4ac391c803c741552af20965a563dd Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Oct 2023 17:20:35 +0100 Subject: [PATCH 019/104] clarify language --- website/docs/docs/cloud/about-cloud-setup.md | 2 ++ website/docs/docs/core/about-the-cli.md | 19 +++++++++++-------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/website/docs/docs/cloud/about-cloud-setup.md b/website/docs/docs/cloud/about-cloud-setup.md index baa2465472e..33c25c10ade 100644 --- a/website/docs/docs/cloud/about-cloud-setup.md +++ b/website/docs/docs/cloud/about-cloud-setup.md @@ -11,6 +11,8 @@ dbt Cloud is the fastest and most reliable way to deploy your dbt jobs. It conta - Configuring access to [GitHub](/docs/cloud/git/connect-github), [GitLab](/docs/cloud/git/connect-gitlab), or your own [git repo URL](/docs/cloud/git/import-a-project-by-git-url). - [Managing users and licenses](/docs/cloud/manage-access/seats-and-users) - [Configuring secure access](/docs/cloud/manage-access/about-user-access) +- Configuring the [dbt Cloud IDE](/docs/cloud/about-cloud-develop) +- Installing and configuring the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) These settings are intended for dbt Cloud administrators. If you need a more detailed first-time setup guide for specific data platforms, read our [quickstart guides](/quickstarts). diff --git a/website/docs/docs/core/about-the-cli.md b/website/docs/docs/core/about-the-cli.md index d05fb514dfa..75e4a5705a2 100644 --- a/website/docs/docs/core/about-the-cli.md +++ b/website/docs/docs/core/about-the-cli.md @@ -1,22 +1,25 @@ --- -title: "About the CLI" +title: "About dbt Core" id: "about-the-cli" -sidebar_label: "About the CLI" +sidebar_label: "About dbt Core" --- -dbt ships with a command line interface (CLI) for running your dbt project. This way of running dbt and a dbt project is free and open source. +[dbt Core](https://github.com/dbt-labs/dbt-core) is an open sourced project where you can develop from the command line and run your dbt project. + +To use dbt Core, your workflow generally looks like: -To use the CLI, your workflow generally looks like: 1. **Build your dbt project in a code editor —** popular choices include VSCode and Atom. -1. **Run your project from the command line —** macOS ships with a default Terminal program, however you can also use iTerm or the command line prompt within a code editor to execute dbt commands. +2. **Run your project from the command line —** macOS ships with a default Terminal program, however you can also use iTerm or the command line prompt within a code editor to execute dbt commands. :::info How we set up our computers for working on dbt projects -We've written a [guide](https://discourse.getdbt.com/t/how-we-set-up-our-computers-for-working-on-dbt-projects/243) for our recommended setup when running dbt projects using the CLI. +We've written a [guide](https://discourse.getdbt.com/t/how-we-set-up-our-computers-for-working-on-dbt-projects/243) for our recommended setup when running dbt projects using dbt Core. ::: -If you're using the CLI, we recommend learning some basics of your terminal to help you work more effectively. In particular, it's important to understand `cd`, `ls` and `pwd` to be able to navigate through the directory structure of your computer easily. +If you're using the command line, we recommend learning some basics of your terminal to help you work more effectively. In particular, it's important to understand `cd`, `ls` and `pwd` to be able to navigate through the directory structure of your computer easily. + +You can find more information on installing and setting up the dbt Core [here](/docs/core/installation). -You can find more information on installing and setting up the dbt CLI [here](/dbt-cli/cli-overview). +dbt also supports a [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) and both dbt Core and the dbt Cloud CLI are command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. From 169f5e0b80201b3a838e909737a7f632ae906dc5 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Wed, 4 Oct 2023 17:33:52 +0100 Subject: [PATCH 020/104] tweak language --- website/docs/docs/cloud/about-cloud-develop.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 88066d4dcd4..5a217d73442 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -9,11 +9,9 @@ pagination_next: "docs/cloud/cloud-cli-installation" dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI): - **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** — Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment. - - Note, the dbt Cloud CLI is distinct from [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source command-line tool for dbt. Both tools are command lines that use the same dbt commands, however, the dbt Cloud CLI is tailored to run specifically on dbt Cloud's infrastructure. - **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** — Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI). This documentation section provides detailed instructions on setting up the dbt Cloud CLI and dbt Cloud IDE. To get started with dbt development, you'll need a [developer](/docs/cloud/manage-access/seats-and-users) account. For a more comprehensive setup guide, refer to our [quickstart guides](/quickstarts). - - +Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. From 72058700d13df01ad575f56115a45c6a7587702b Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Wed, 4 Oct 2023 10:20:14 -0700 Subject: [PATCH 021/104] Update label.yml (#4182) ## What are you changing in this pull request and why? - Added some logging to print so we know which step the script got to - Added `github` to get proper context - Moved permissions to the secret token. ## Checklist - [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." Adding new pages (delete if not applicable): - [ ] Add page to `website/sidebars.js` - [ ] Provide a unique filename for the new page Removing or renaming existing pages (delete if not applicable): - [ ] Remove page from `website/sidebars.js` - [ ] Add an entry `website/static/_redirects` - [ ] [Ran link testing](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally) to update the links that point to the deleted page --- .github/workflows/label.yml | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index 4de2203647f..67a509f1c2f 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -2,22 +2,22 @@ name: Add/Remove Labels on: pull_request_target: - types: [ opened ] + types: [opened] jobs: add_new_contributor_label: if: github.event.action == 'opened' - permissions: - contents: read - pull-requests: write runs-on: ubuntu-latest steps: - - uses: actions/github-script@v6 - with: - script: | - const creator = context.payload.sender.login; - const opts = github.rest.issues.listForRepo.endpoint.merge({ - ...context.issue, + - name: Add new contributor label + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | + async function run() { + const creator = github.context.payload.sender.login; + const opts = github.context.repo.issues.listForRepo.endpoint.merge({ + ...github.context.issue, creator, state: 'all', }); @@ -27,7 +27,7 @@ jobs: let isAlreadyContributor = false; for (const issue of issues) { - if (issue.number === context.issue.number) { + if (issue.number === github.context.issue.number) { continue; } if (issue.pull_request && issue.user.login === creator) { @@ -37,10 +37,16 @@ jobs: } if (!isAlreadyContributor) { + console.log('Adding label: new contributor'); await github.rest.issues.addLabels({ - issue_number: context.issue.number, - owner: context.repo.owner, - repo: context.repo.repo, + issue_number: github.context.issue.number, + owner: github.context.repo.owner, + repo: github.context.repo.repo, labels: ['new contributor'], }); + } else { + console.log('User is already a contributor, no label added.'); } + } + + run(); // Call the async function to execute the code From e5cd1f4273e01b8a2f242c32a7e8177d3293839e Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Wed, 4 Oct 2023 10:34:11 -0700 Subject: [PATCH 022/104] Revert "Update label.yml" (#4184) Reverts dbt-labs/docs.getdbt.com#4182 --- .github/workflows/label.yml | 34 ++++++++++++++-------------------- 1 file changed, 14 insertions(+), 20 deletions(-) diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index 67a509f1c2f..4de2203647f 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -2,22 +2,22 @@ name: Add/Remove Labels on: pull_request_target: - types: [opened] + types: [ opened ] jobs: add_new_contributor_label: if: github.event.action == 'opened' + permissions: + contents: read + pull-requests: write runs-on: ubuntu-latest steps: - - name: Add new contributor label - uses: actions/github-script@v6 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} - script: | - async function run() { - const creator = github.context.payload.sender.login; - const opts = github.context.repo.issues.listForRepo.endpoint.merge({ - ...github.context.issue, + - uses: actions/github-script@v6 + with: + script: | + const creator = context.payload.sender.login; + const opts = github.rest.issues.listForRepo.endpoint.merge({ + ...context.issue, creator, state: 'all', }); @@ -27,7 +27,7 @@ jobs: let isAlreadyContributor = false; for (const issue of issues) { - if (issue.number === github.context.issue.number) { + if (issue.number === context.issue.number) { continue; } if (issue.pull_request && issue.user.login === creator) { @@ -37,16 +37,10 @@ jobs: } if (!isAlreadyContributor) { - console.log('Adding label: new contributor'); await github.rest.issues.addLabels({ - issue_number: github.context.issue.number, - owner: github.context.repo.owner, - repo: github.context.repo.repo, + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, labels: ['new contributor'], }); - } else { - console.log('User is already a contributor, no label added.'); } - } - - run(); // Call the async function to execute the code From 04a1b11b60b312867e39c5e6102ea174ad2b2e32 Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Wed, 4 Oct 2023 11:07:41 -0700 Subject: [PATCH 023/104] editing permissions only (#4185) ## What are you changing in this pull request and why? ## Checklist - [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." Adding new pages (delete if not applicable): - [ ] Add page to `website/sidebars.js` - [ ] Provide a unique filename for the new page Removing or renaming existing pages (delete if not applicable): - [ ] Remove page from `website/sidebars.js` - [ ] Add an entry `website/static/_redirects` - [ ] [Ran link testing](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally) to update the links that point to the deleted page --- .github/workflows/label.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index 4de2203647f..fe5bbdbe9d6 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -2,19 +2,18 @@ name: Add/Remove Labels on: pull_request_target: - types: [ opened ] + types: [opened] jobs: add_new_contributor_label: if: github.event.action == 'opened' - permissions: - contents: read - pull-requests: write runs-on: ubuntu-latest steps: - - uses: actions/github-script@v6 - with: - script: | + - name: Add new contributor label + uses: actions/github-script@v6 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + script: | const creator = context.payload.sender.login; const opts = github.rest.issues.listForRepo.endpoint.merge({ ...context.issue, @@ -37,10 +36,11 @@ jobs: } if (!isAlreadyContributor) { + console.log('Adding label: new contributor'); await github.rest.issues.addLabels({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, labels: ['new contributor'], }); - } + } From 07b58a08971daf077e77c7c60c3eb0a295e6ee94 Mon Sep 17 00:00:00 2001 From: Aaron Raff Date: Wed, 4 Oct 2023 17:17:43 -0400 Subject: [PATCH 024/104] ci-jobs: document temp schema macro limitation Converts the "Temporary schemas aren't dropping" section into a list of items. The first item remains the same, but a new item was added to note that schemas will not be dropped unless they were written to as a result of running a dbt model. --- website/docs/docs/deploy/ci-jobs.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/website/docs/docs/deploy/ci-jobs.md b/website/docs/docs/deploy/ci-jobs.md index fb603e2864e..4a95a8bf8df 100644 --- a/website/docs/docs/deploy/ci-jobs.md +++ b/website/docs/docs/deploy/ci-jobs.md @@ -94,10 +94,18 @@ If you're experiencing any issues, review some of the common questions and answe
Temporary schemas aren't dropping
-
If your temporary schemas aren't dropping after a PR merges or closes, this typically indicates you have overridden the generate_schema_name macro and it isn't using dbt_cloud_pr_ as the prefix.



To resolve this, change your macro so that the temporary PR schema name contains the required prefix. For example: +
If your temporary schemas aren't dropping after a PR merges or closes, this typically indicates one of two issues: +
    +
  • You have overridden the generate_schema_name macro and it isn't using dbt_cloud_pr_ as the prefix.



    To resolve this, change your macro so that the temporary PR schema name contains the required prefix. For example:



    - • ✅ Temporary PR schema name contains the prefix dbt_cloud_pr_ (like dbt_cloud_pr_123_456_marketing)

    - • ❌ Temporary PR schema name doesn't contain the prefix dbt_cloud_pr_ (like marketing).

    + ✅ Temporary PR schema name contains the prefix dbt_cloud_pr_ (like dbt_cloud_pr_123_456_marketing)

    + ❌ Temporary PR schema name doesn't contain the prefix dbt_cloud_pr_ (like marketing).

    +
    • +
    +
  • + A macro is creating a schema, but no dbt models are writing to that schema. dbt Cloud does not drop temporary schemas that were not written to as a result of running a dbt model. +
    • +
@@ -153,6 +161,3 @@ If you're experiencing any issues, review some of the common questions and answe If you're on a Virtual Private dbt Enterprise plan using security features like ingress PrivateLink or IP Allowlisting, registering CI hooks may not be available and can cause the job to fail silently.
- - - From 127354db98d8d27f15e301068bc68efbe63d186b Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 10:20:17 +0100 Subject: [PATCH 025/104] add coalesce banner to docs site --- website/docusaurus.config.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 0cc6299ed39..0eae62ecec3 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -71,13 +71,13 @@ var siteSettings = { announcementBar: { id: "biweekly-demos", content: - "Join our weekly demos and see dbt Cloud in action!", - backgroundColor: "#047377", + "Register now for Coalesce 2023. The Analytics Engineering Conference!", + backgroundColor: "#7444FD", textColor: "#fff", isCloseable: true, }, announcementBarActive: true, - announcementBarLink: "https://www.getdbt.com/resources/dbt-cloud-demos-with-experts/?utm_medium=event&utm_source=docs&utm_campaign=q1-2024_cloud-demos-with-experts_awareness", + announcementBarLink: "https://coalesce.getdbt.com/", // Set community spotlight member on homepage // This is the ID for a specific file under docs/community/spotlight communitySpotlightMember: "faith-lierheimer", From 50035f2ff32a31f6470c9b30050df2dd95f6e8fa Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 11:23:07 +0100 Subject: [PATCH 026/104] add linux --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 04d344dc9d8..e181197efbc 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -101,7 +101,7 @@ The following instructions explain how to update the dbt CLoud CLI to the latest #### Update with Homebrew (MacOS) To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. -#### Update manually (Windows) +#### Update manually (Windows and Linux) To update, follow the same process explained in [Install manually (Windows)](#install-manually-windows) and replace the existing `dbt.exe` executable with the new one. From 6e22f135f819fa201b1a30ce374330fb36a636e8 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 13:00:54 +0100 Subject: [PATCH 027/104] add gsheets and update sidebar per roxi --- .../avail-sl-integrations.md | 17 ++++--- .../docs/use-dbt-semantic-layer/gsheets.md | 51 +++++++++++++++++++ website/sidebars.js | 10 +++- website/snippets/_sl-partner-links.md | 34 +++++++++---- 4 files changed, 95 insertions(+), 17 deletions(-) create mode 100644 website/docs/docs/use-dbt-semantic-layer/gsheets.md diff --git a/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md b/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md index b084dedc305..dad8c505bc7 100644 --- a/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md +++ b/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md @@ -4,6 +4,7 @@ id: avail-sl-integrations description: "Discover the diverse range of partners that seamlessly integrate with the powerful dbt Semantic Layer, allowing you to query and unlock valuable insights from your data ecosystem." tags: [Semantic Layer] sidebar_label: "Available integrations" +hide_table_of_contents: true meta: api_name: dbt Semantic Layer APIs --- @@ -19,21 +20,23 @@ There are a number of data applications that seamlessly integrate with the dbt S Use the [dbt Semantic Layer APIs](/docs/dbt-cloud-apis/sl-api-overview) to simplify metric queries, optimize your development workflow, and reduce coding. This approach also ensures data governance and consistency for data consumers. - - - import AvailIntegrations from '/snippets/_sl-partner-links.md'; -### Custom integration +## Custom integration -You can create custom integrations using different languages and tools. We support connecting with JDBC, ADBC, and a GraphQL API. For more info, check out [our examples on GitHub](https://github.com/dbt-labs/example-semantic-layer-clients/). +- You can create custom integrations using different languages and tools. We support connecting with JDBC, ADBC, and a GraphQL APIs. For more info, check out [our examples on GitHub](https://github.com/dbt-labs/example-semantic-layer-clients/). +- You can also connect to tools that allow you to write SQL. These tools must meet one of the two criteria: + + - Supports a generic JDBC driver option (such as DataGrip) or + - Supports Dremio and uses ArrowFlightSQL driver version 12.0.0 or higher. ## Related docs -- {frontMatter.meta.api_name} to learn how to integrate with JDBC and GraphQL to query your metrics in downstream tools. -- [dbt Semantic Layer APIs query syntax](/docs/dbt-cloud-apis/sl-jdbc#querying-the-api-for-metric-metadata) +- {frontMatter.meta.api_name} to learn how to integrate and query your metrics in downstream tools. +- [dbt Semantic Layer API query syntax](/docs/dbt-cloud-apis/sl-jdbc#querying-the-api-for-metric-metadata) +- [Hex nd dbt Semantic Layer cells](https://learn.hex.tech/docs/logic-cell-types/transform-cells/dbt-metrics-cells) to set up SQL cells in Hex. diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md new file mode 100644 index 00000000000..df4a665243c --- /dev/null +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -0,0 +1,51 @@ +--- +title: "Google Sheets (beta)" +description: "Integrate with Google Sheets to query your metrics in a spreadsheet." +tags: [Semantic Layer] +sidebar_label: "Google Sheets (beta)" +--- + + +The dbt Semantic Layer offers a seamless integration with Google Sheets through a custom menu. This add-on allows you to build dbt Semantic Layer queries and return data on your metrics directly within Google Sheet. + +## Prerequisites + +1. You have a Google account with access to Google Sheets +2. You have the ability to install Google Add-ons +3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) +4. You have a dbt Cloud Environment Id and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account + +## Installing the add-on + +1. In Google Sheets, navigate to [**Extensions -> Add-on -> Get add-ons**](https://support.google.com/docs/answer/2942256?hl=en&co=GENIE.Platform%3DDesktop&oco=0#zippy=%2Cinstall-add-ons%2Cinstall-an-add-on). +2. Search for "dbt Semantic Layer for Sheets" and install it +3. After installing, access it by opening the Add-On menu and finding "dbt Semantic Layer for Sheets". This will open a custom menu to the right hand side of your screen. +4. Authenticate with the dbt Cloud Environment Id and Service Token +5. Start querying your metrics using the **Query Builder**! Refer to [Custom menu key functions](#custom-menu-key-functions) for more information on its capabilities. + +When querying your data with Google Sheets: + +- It returns the data to the cell you have clicked on +- The custom menu operation has a timeout limit of six (6) minutes. + +## Custom menu key functions + +The custom menu provides the following capabilities: + +| Menu items | Description | +|---------------|-------------------------------------------------------| +| Metrics | Search and select metrics | +| Group By | Search and select dimensions to group by. Dimensions are grouped by the entity of the semantic model they come from. | +| Granularity | Modify granularity of the primary time dimension | +| Where | Filter your data. This includes categorical and time filters. | +| Order By | Return your data ordered | +| Limit | Set a limit for the rows of your output | + + +## Filtering data + +To use the filter functionality, choose the dimension you want to filter by and select the operation you want to filter on. + - If it's a categorical dimension, type in the dimension value you want to filter by (no quotes needed) and press enter. + - Continue adding additional filters as needed with AND and OR. If it's a time dimension, choose the operator and select from the calendar. + +## Saving queries and refreshing data diff --git a/website/sidebars.js b/website/sidebars.js index 8b162f67af3..220f32130da 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -410,8 +410,16 @@ const sidebarSettings = { items: [ "docs/use-dbt-semantic-layer/quickstart-sl", "docs/use-dbt-semantic-layer/setup-sl", - "docs/use-dbt-semantic-layer/avail-sl-integrations", "docs/use-dbt-semantic-layer/sl-architecture", + { + type: "category", + label: "Integrations", + link: { type: "doc", id: "docs/use-dbt-semantic-layer/avail-sl-integrations" }, + items: [ + "docs/use-dbt-semantic-layer/avail-sl-integrations", + //"docs/use-dbt-semantic-layer/gsheets", + ], + }, ], }, { diff --git a/website/snippets/_sl-partner-links.md b/website/snippets/_sl-partner-links.md index e9cc6af3564..fa8146c6418 100644 --- a/website/snippets/_sl-partner-links.md +++ b/website/snippets/_sl-partner-links.md @@ -1,11 +1,27 @@ - -The dbt Semantic Layer integrations are capable of querying dbt metrics, importing definitions, surfacing the underlying data in partner tools, and more. These are the following tools that integrate with the dbt Semantic Layer: +The following tools integrate with the dbt Semantic Layer: + +
+ + + + + + + + +

+ +Before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create **Semantic Layer Only** and **Metadata Only** permissions. -1. **Mode** — To learn more about integrating with Mode, check out their [documentation](https://mode.com/help/articles/supported-databases/#dbt-semantic-layer) for more info. -2. **Hex** — To learn more about integrating with Hex, check out their [documentation](https://learn.hex.tech/docs/connect-to-data/data-connections/dbt-integration#dbt-semantic-layer-integration) for more info. Additionally, refer to [dbt Semantic Layer cells](https://learn.hex.tech/docs/logic-cell-types/transform-cells/dbt-metrics-cells) to set up SQL cells in Hex. -3. **Google Sheets** — Google Sheets integration coming soon. -4. **Tools that allows you to write SQL** — They must meet one of the two criteria: - * Supports a generic JDBC driver option (such as DataGrip) or - * Supports Dremio and uses ArrowFlightSQL driver version 12.0.0 or higher. -Before you connect to these tools, you'll need to first [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) and [generate a service token](/docs/dbt-cloud-apis/service-tokens) to create a Semantic Layer Only and Metadata Only service token. From 0b5bae9a1ff9b657ed8e99f07533129c540df470 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 13:03:27 +0100 Subject: [PATCH 028/104] add link to function --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index df4a665243c..0bc9778f7b9 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -21,8 +21,9 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through 2. Search for "dbt Semantic Layer for Sheets" and install it 3. After installing, access it by opening the Add-On menu and finding "dbt Semantic Layer for Sheets". This will open a custom menu to the right hand side of your screen. 4. Authenticate with the dbt Cloud Environment Id and Service Token -5. Start querying your metrics using the **Query Builder**! Refer to [Custom menu key functions](#custom-menu-key-functions) for more information on its capabilities. - +5. Start querying your metrics using the **Query Builder**! + - For more info on the menu functions, refer to [Custom menu key functions](#custom-menu-key-functions). + When querying your data with Google Sheets: - It returns the data to the cell you have clicked on From a9d1cdc79a5520895c7ab5c94fdbda25818a010d Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 14:12:22 +0100 Subject: [PATCH 029/104] Update sl-partner-integration-guide.md update graphql --- .../docs/guides/dbt-ecosystem/sl-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/dbt-ecosystem/sl-partner-integration-guide.md b/website/docs/guides/dbt-ecosystem/sl-partner-integration-guide.md index 68037bfd0cd..c41469bf08a 100644 --- a/website/docs/guides/dbt-ecosystem/sl-partner-integration-guide.md +++ b/website/docs/guides/dbt-ecosystem/sl-partner-integration-guide.md @@ -20,7 +20,7 @@ This is an evolving guide that is meant to provide recommendations based on our To build a dbt Semantic Layer integration: -- We offer a [JDBC](/docs/dbt-cloud-apis/sl-jdbc) API (and will soon offer a GraphQL API). Refer to the dedicated [dbt Semantic Layer API](/docs/dbt-cloud-apis/sl-api-overview) for more technical integration details. +- We offer a [JDBC](/docs/dbt-cloud-apis/sl-jdbc) API and [GraphQL API](/docs/dbt-cloud-apis/sl-graphql). Refer to the dedicated [dbt Semantic Layer API](/docs/dbt-cloud-apis/sl-api-overview) for more technical integration details. - Familiarize yourself with the [dbt Semantic Layer](/docs/use-dbt-semantic-layer/dbt-sl) and [MetricFlow](/docs/build/about-metricflow)'s key concepts. There are two main objects: From 90d4e2f1903b6351c5877c1d82480e632e5f9a08 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 15:08:25 +0100 Subject: [PATCH 030/104] Update avail-sl-integrations.md Co-authored-by: Devon Fulcher --- .../docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md b/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md index dad8c505bc7..ea5833d586b 100644 --- a/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md +++ b/website/docs/docs/use-dbt-semantic-layer/avail-sl-integrations.md @@ -36,7 +36,7 @@ import AvailIntegrations from '/snippets/_sl-partner-links.md'; - {frontMatter.meta.api_name} to learn how to integrate and query your metrics in downstream tools. - [dbt Semantic Layer API query syntax](/docs/dbt-cloud-apis/sl-jdbc#querying-the-api-for-metric-metadata) -- [Hex nd dbt Semantic Layer cells](https://learn.hex.tech/docs/logic-cell-types/transform-cells/dbt-metrics-cells) to set up SQL cells in Hex. +- [Hex dbt Semantic Layer cells](https://learn.hex.tech/docs/logic-cell-types/transform-cells/dbt-metrics-cells) to set up SQL cells in Hex. From 69f4c31fda4b29307407eae916498b0f3ca5736a Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 15:13:46 +0100 Subject: [PATCH 031/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 0bc9778f7b9..875f20f65bb 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -49,4 +49,3 @@ To use the filter functionality, choose the dimension you want to filter by and - If it's a categorical dimension, type in the dimension value you want to filter by (no quotes needed) and press enter. - Continue adding additional filters as needed with AND and OR. If it's a time dimension, choose the operator and select from the calendar. -## Saving queries and refreshing data From 7216cdfbeb6ab05f4eea5e5c08493de274a9d6e8 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 16:10:05 +0100 Subject: [PATCH 032/104] Update sl-graphql.md correct link --- website/docs/docs/dbt-cloud-apis/sl-graphql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/dbt-cloud-apis/sl-graphql.md b/website/docs/docs/dbt-cloud-apis/sl-graphql.md index 3e06df69f76..0e39f50f60a 100644 --- a/website/docs/docs/dbt-cloud-apis/sl-graphql.md +++ b/website/docs/docs/dbt-cloud-apis/sl-graphql.md @@ -423,7 +423,7 @@ query_result_request = """ """ gql_response = requests.post( - "http://localhost:8000/graphql", + "https://semantic-layer.cloud.getdbt.com/api/graphql", json={"query": query_result_request}, headers=headers, ) From 3a53c5c4444bee6ea456e50b942fd07fe5d9558a Mon Sep 17 00:00:00 2001 From: Jessica Date: Thu, 5 Oct 2023 10:55:03 -0400 Subject: [PATCH 033/104] Clairy format required for specifiying roles --- .../docs/docs/core/connect-data-platform/trino-setup.md | 2 +- .../connect-starburst-trino/roles-starburst-enterprise.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/core/connect-data-platform/trino-setup.md b/website/docs/docs/core/connect-data-platform/trino-setup.md index 396634dc6e6..70ecdbdfc96 100644 --- a/website/docs/docs/core/connect-data-platform/trino-setup.md +++ b/website/docs/docs/core/connect-data-platform/trino-setup.md @@ -83,7 +83,7 @@ The following profile fields are optional to set up. They let you configure your | Profile field | Example | Description | | ----------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `threads` | `8` | How many threads dbt should use (default is `1`) | -| `roles` | `system: analyst` | Catalog roles | +| `roles` | `system: analyst` | Catalog roles can be set under the optional `roles` parameter using following format: `catalog: role`. | | `session_properties` | `query_max_run_time: 4h` | Sets Trino session properties used in the connection. Execute `SHOW SESSION` to see available options | | `prepared_statements_enabled` | `true` or `false` | Enable usage of Trino prepared statements (used in `dbt seed` commands) (default: `true`) | | `retries` | `10` | Configure how many times all database operation is retried when connection issues arise (default: `3`) | diff --git a/website/snippets/connect-starburst-trino/roles-starburst-enterprise.md b/website/snippets/connect-starburst-trino/roles-starburst-enterprise.md index ba11508f1b4..f832d52be20 100644 --- a/website/snippets/connect-starburst-trino/roles-starburst-enterprise.md +++ b/website/snippets/connect-starburst-trino/roles-starburst-enterprise.md @@ -1,3 +1,6 @@ -[comment: For context, the section title used for this snippet is "Roles in Starburst Enterprise" ]: # +[comment: For context, the section title used for this snippet is "Roles in Starburst Enterprise" ]: # -If connecting to a Starburst Enterprise cluster with built-in access controls enabled, you can't add the role as a suffix to the username, so the default role for the provided username is used instead. +If connecting to a Starburst Enterprise cluster with built-in access controls +enabled, you must specify a role using the format detailed in [Additional +parameters](#additional-parameters). If a role is not specified, the default +role for the provided username is used. \ No newline at end of file From f9709be5a9a0c09efa6b7e723f9ffa4d53c316aa Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 16:13:44 +0100 Subject: [PATCH 034/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 + 1 file changed, 1 insertion(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index e181197efbc..8854a5000b1 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -18,6 +18,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Secure credential storage in the dbt Cloud platform. * Automatic deferral of build artifacts to your Cloud project's production environment. * Speedier, lower cost builds. +* Support for dbt Mesh (cross-project `ref`), * Significant platform improvements, to be released over the coming months. The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. From 96907de43db0eed3b96c4d4ee30a6f690ee2ad38 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 16:45:38 +0100 Subject: [PATCH 035/104] update to pp --- website/docs/docs/cloud/cloud-cli-installation.md | 6 +++--- website/docs/docs/cloud/configure-cloud-cli.md | 4 ++-- website/sidebars.js | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index e181197efbc..f50529e942f 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -5,9 +5,9 @@ description: "Instructions for installing and configuring dbt Cloud CLI" pagination_next: "docs/cloud/configure-cloud-cli" --- -:::info Beta functionality +:::info Public preview functionality -The dbt Cloud CLI is currently in [public beta](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). +The dbt Cloud CLI is currently in [public preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). ::: @@ -96,7 +96,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI execute ## Update dbt Cloud CLI -The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. During the beta period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes. +The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. During the public preview period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes. #### Update with Homebrew (MacOS) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index e1bde59be2e..12349d6ef99 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -4,9 +4,9 @@ id: configure-cloud-cli description: "Instructions on how to configure the dbt Cloud CLI" --- -:::info Beta functionality +:::info Public preview functionality -The dbt Cloud CLI is currently in [public beta](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). +The dbt Cloud CLI is currently in [public preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). ::: diff --git a/website/sidebars.js b/website/sidebars.js index d27738c061a..1de66502556 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -123,7 +123,7 @@ const sidebarSettings = { "docs/cloud/about-cloud-develop", { type: "category", - label: "dbt Cloud CLI (beta)", + label: "dbt Cloud CLI (public preview)", link: { type: "doc", id: "docs/cloud/cloud-cli-installation" }, items: [ "docs/cloud/cloud-cli-installation", From 38577effba30ee489316b93fdf2e9780762cf2bc Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Thu, 5 Oct 2023 08:55:31 -0700 Subject: [PATCH 036/104] Update action (#4197) ## What are you changing in this pull request and why? Changing the token to see if it fixes the problem where it's only labeling PRs opened by people in the dbt org. ## Checklist - [ ] Review the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) and [About versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) so my content adheres to these guidelines. - [ ] Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch." Adding new pages (delete if not applicable): - [ ] Add page to `website/sidebars.js` - [ ] Provide a unique filename for the new page Removing or renaming existing pages (delete if not applicable): - [ ] Remove page from `website/sidebars.js` - [ ] Add an entry `website/static/_redirects` - [ ] [Ran link testing](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally) to update the links that point to the deleted page --- .github/workflows/label.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml index fe5bbdbe9d6..48615e60b9e 100644 --- a/.github/workflows/label.yml +++ b/.github/workflows/label.yml @@ -12,7 +12,7 @@ jobs: - name: Add new contributor label uses: actions/github-script@v6 with: - github-token: ${{ secrets.GITHUB_TOKEN }} + github-token: ${{ secrets.DOCS_SECRET }} script: | const creator = context.payload.sender.login; const opts = github.rest.issues.listForRepo.endpoint.merge({ From f6556049b2dd15251ef54bffb0f9e584da807603 Mon Sep 17 00:00:00 2001 From: Anders Swanson Date: Thu, 5 Oct 2023 12:03:16 -0400 Subject: [PATCH 037/104] new oracle logo --- website/static/img/icons/oracle.svg | 162 +--------------------- website/static/img/icons/white/oracle.svg | 162 +--------------------- 2 files changed, 14 insertions(+), 310 deletions(-) diff --git a/website/static/img/icons/oracle.svg b/website/static/img/icons/oracle.svg index 59aa1f16c8e..67b464426de 100644 --- a/website/static/img/icons/oracle.svg +++ b/website/static/img/icons/oracle.svg @@ -1,155 +1,7 @@ - - - - - - - - 2022-03-04T16:18:02-06:00 - xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 - xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a - xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a - - - - - saved - xmp.iid:2d9bf348-863c-4d93-ac30-a8107201442a - 2021-04-27T13:41:28-05:00 - Adobe Bridge 2021 (Macintosh) - /metadata - - - - - saved - xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 - 2022-03-04T16:18:02-06:00 - Adobe Bridge 2021 (Macintosh) - /metadata - - - - - True - - - icon - Data - aggregation - management - system - business - intelligence - analytics - store - analysis - icon - Business - Data - machine learning - artificial intelligence - automate - automatization - security - backup - update - task - ADCS - autonomous - service - - - - - Oracle All Rights Reserved - - - - - Data Management - Service - Autonomous - Database - Cloud - icon - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + \ No newline at end of file diff --git a/website/static/img/icons/white/oracle.svg b/website/static/img/icons/white/oracle.svg index 59aa1f16c8e..67b464426de 100644 --- a/website/static/img/icons/white/oracle.svg +++ b/website/static/img/icons/white/oracle.svg @@ -1,155 +1,7 @@ - - - - - - - - 2022-03-04T16:18:02-06:00 - xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 - xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a - xmp.did:2d9bf348-863c-4d93-ac30-a8107201442a - - - - - saved - xmp.iid:2d9bf348-863c-4d93-ac30-a8107201442a - 2021-04-27T13:41:28-05:00 - Adobe Bridge 2021 (Macintosh) - /metadata - - - - - saved - xmp.iid:a6ee7346-7ecf-4262-873c-5321b0da03f3 - 2022-03-04T16:18:02-06:00 - Adobe Bridge 2021 (Macintosh) - /metadata - - - - - True - - - icon - Data - aggregation - management - system - business - intelligence - analytics - store - analysis - icon - Business - Data - machine learning - artificial intelligence - automate - automatization - security - backup - update - task - ADCS - autonomous - service - - - - - Oracle All Rights Reserved - - - - - Data Management - Service - Autonomous - Database - Cloud - icon - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + \ No newline at end of file From 3aec5423d9c109c795b51ca1df096472a9042e58 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:08:11 +0100 Subject: [PATCH 038/104] Delete .github/workflows/repo-sync.yml deleting per @john-rock --- .github/workflows/repo-sync.yml | 111 -------------------------------- 1 file changed, 111 deletions(-) delete mode 100644 .github/workflows/repo-sync.yml diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml deleted file mode 100644 index 8f2320217b2..00000000000 --- a/.github/workflows/repo-sync.yml +++ /dev/null @@ -1,111 +0,0 @@ -name: Repo Sync - -# **What it does**: Syncs docs.getdbt.com public repo into the docs private repo -# This GitHub Actions workflow keeps the `current` branch of those two repos in sync. -# **Why we have it**: To keep the open-source repository up-to-date -# while still having an internal repository for sensitive work. -# For more details, see https://github.com/repo-sync/repo-sync#how-it-works - -on: - schedule: - - cron: '0 6,12,18 * * *' # Run at 6:00 AM, 12:00 PM, and 6:00 PM - -jobs: - repo-sync: - permissions: - contents: write - pull-requests: write - name: Repo Sync - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - # Use the INTERMEDIATE_BRANCH as the checkout reference - ref: ${{ secrets.INTERMEDIATE_BRANCH }} - token: ${{ secrets.GITHUB_TOKEN }} - # Fetch all history for all branches and tags - fetch-depth: 0 - - # Sync the source repo to the destination branch using repo-sync/github-sync - - uses: repo-sync/github-sync@v2 - name: Sync repo to branch - with: - # Source repository to sync from - source_repo: ${{ secrets.SOURCE_REPO }} - # Source branch to sync from - source_branch: current - # Destination branch to sync to - destination_branch: ${{ secrets.INTERMEDIATE_BRANCH }} - github_token: ${{ secrets.WORKFLOW_TOKEN }} - - - name: Ship pull request - uses: actions/github-script@v6 - with: - github-token: ${{ secrets.WORKFLOW_TOKEN }} - result-encoding: string - script: | - const {owner, repo} = context.repo; - const head = '${{ secrets.INTERMEDIATE_BRANCH }}'; - const base = 'current' - - async function closePullRequest(prNumber) { - console.log('closing PR', prNumber) - await github.rest.pulls.update({ - owner, - repo, - pull_number: prNumber, - state: 'closed' - }); - console.log('closed PR', prNumber) - } - - console.log('Creating new PR') - let pull, pull_number - try { - const response = await github.rest.pulls.create({ - owner, - repo, - head, - base, - title: 'REPO SYNC - Public to Private', - body: 'This is an automated pull request to sync changes between the public and private repos.', - }); - pull = response.data - pull_number = pull.number - console.log('Created pull request successfully', pull.html_url) - - } catch (err) { - // Don't error/alert if there's no commits to sync - if (err.message?.includes('No commits')) { - console.log(err.message) - return - } - throw err - } - - const { data: prFiles } = await github.rest.pulls.listFiles({ owner, repo, pull_number }) - if (prFiles.length) { - console.log(prFiles.length, 'files have changed') - } else { - console.log('No files changed, closing') - await closePullRequest(pull_number) - return - } - - console.log('Checking for merge conflicts') - if (pull.mergeable_state === 'dirty') { - console.log('Pull request has a conflict', pull.html_url) - await closePullRequest(pull_number) - throw new Error('PR has a conflict, please resolve manually') - } - console.log('No detected merge conflicts') - - - console.log('Merging the PR') - await github.rest.pulls.merge({ - owner, - repo, - pull_number, - merge_method: 'merge', - }) - console.log('Merged the PR successfully') From 580441b03900ae9c2feeea709d4ada4200daf137 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:34:29 +0100 Subject: [PATCH 039/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 875f20f65bb..9fead9b6e81 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -5,7 +5,9 @@ tags: [Semantic Layer] sidebar_label: "Google Sheets (beta)" --- - +:::info Beta functionality +Google Sheets integration with the dbt Semantic Layer is a [beta feature](https://docs.getdbt.com/docs/dbt-versions/product-lifecycles#dbt-cloud) and is subject to change without notification. +::: The dbt Semantic Layer offers a seamless integration with Google Sheets through a custom menu. This add-on allows you to build dbt Semantic Layer queries and return data on your metrics directly within Google Sheet. ## Prerequisites From d89821201bd53dbf5448c0e0ea73b75f02ea318e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:45:26 +0100 Subject: [PATCH 040/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 9fead9b6e81..f0418b15bca 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -12,7 +12,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through ## Prerequisites -1. You have a Google account with access to Google Sheets +1. You have a Google account with access to Google Sheets. 2. You have the ability to install Google Add-ons 3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) 4. You have a dbt Cloud Environment Id and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account From fce4b9503ae8981b2cf2a743575bf6e2618455cb Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:48:52 +0100 Subject: [PATCH 041/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index f0418b15bca..27f04fb807f 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -13,7 +13,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through ## Prerequisites 1. You have a Google account with access to Google Sheets. -2. You have the ability to install Google Add-ons +2. You can install Google add-ons. 3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) 4. You have a dbt Cloud Environment Id and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account From 39a985c3e3f8ff321a89bef6bdb73c5e9cef54eb Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:49:18 +0100 Subject: [PATCH 042/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 27f04fb807f..7763d8defc9 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -15,7 +15,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through 1. You have a Google account with access to Google Sheets. 2. You can install Google add-ons. 3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) -4. You have a dbt Cloud Environment Id and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account +4. You have a dbt Cloud Environment ID and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account. ## Installing the add-on From 63b97071992b8544b57d549fed6a3b66fabd38ef Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:49:27 +0100 Subject: [PATCH 043/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 7763d8defc9..ec2c8b28aeb 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -20,7 +20,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through ## Installing the add-on 1. In Google Sheets, navigate to [**Extensions -> Add-on -> Get add-ons**](https://support.google.com/docs/answer/2942256?hl=en&co=GENIE.Platform%3DDesktop&oco=0#zippy=%2Cinstall-add-ons%2Cinstall-an-add-on). -2. Search for "dbt Semantic Layer for Sheets" and install it +2. Search for "dbt Semantic Layer for Sheets" and install it. 3. After installing, access it by opening the Add-On menu and finding "dbt Semantic Layer for Sheets". This will open a custom menu to the right hand side of your screen. 4. Authenticate with the dbt Cloud Environment Id and Service Token 5. Start querying your metrics using the **Query Builder**! From bcad093ae77a87389df06285c7197277066d9e31 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:49:33 +0100 Subject: [PATCH 044/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index ec2c8b28aeb..dd7120504a5 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -14,7 +14,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through 1. You have a Google account with access to Google Sheets. 2. You can install Google add-ons. -3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl) +3. You have [set up the dbt Semantic Layer](/docs/use-dbt-semantic-layer/setup-sl). 4. You have a dbt Cloud Environment ID and a [service token](/docs/dbt-cloud-apis/service-tokens) to authenticate with from a dbt Cloud account. ## Installing the add-on From 7332f5ff82eb7178e44f124ec34de54bdcf1a7ab Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:53:50 +0100 Subject: [PATCH 045/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index dd7120504a5..646ed089abe 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -28,7 +28,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through When querying your data with Google Sheets: -- It returns the data to the cell you have clicked on +- It returns the data to the cell you have clicked on. - The custom menu operation has a timeout limit of six (6) minutes. ## Custom menu key functions From 50ed3d638d279809311e8f915c70b62a341e7fdf Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:53:55 +0100 Subject: [PATCH 046/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 646ed089abe..7e76253b85f 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -22,7 +22,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through 1. In Google Sheets, navigate to [**Extensions -> Add-on -> Get add-ons**](https://support.google.com/docs/answer/2942256?hl=en&co=GENIE.Platform%3DDesktop&oco=0#zippy=%2Cinstall-add-ons%2Cinstall-an-add-on). 2. Search for "dbt Semantic Layer for Sheets" and install it. 3. After installing, access it by opening the Add-On menu and finding "dbt Semantic Layer for Sheets". This will open a custom menu to the right hand side of your screen. -4. Authenticate with the dbt Cloud Environment Id and Service Token +4. Authenticate with the dbt Cloud Environment ID and Service Token. 5. Start querying your metrics using the **Query Builder**! - For more info on the menu functions, refer to [Custom menu key functions](#custom-menu-key-functions). From 6e97c92ca05d803d0a002338a822545c1a363846 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:54:02 +0100 Subject: [PATCH 047/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 7e76253b85f..2c5608b52d0 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -21,7 +21,7 @@ The dbt Semantic Layer offers a seamless integration with Google Sheets through 1. In Google Sheets, navigate to [**Extensions -> Add-on -> Get add-ons**](https://support.google.com/docs/answer/2942256?hl=en&co=GENIE.Platform%3DDesktop&oco=0#zippy=%2Cinstall-add-ons%2Cinstall-an-add-on). 2. Search for "dbt Semantic Layer for Sheets" and install it. -3. After installing, access it by opening the Add-On menu and finding "dbt Semantic Layer for Sheets". This will open a custom menu to the right hand side of your screen. +3. After installing, open the Add-On menu and select the "dbt Semantic Layer for Sheets". This will open a custom menu to the right-hand side of your screen. 4. Authenticate with the dbt Cloud Environment ID and Service Token. 5. Start querying your metrics using the **Query Builder**! - For more info on the menu functions, refer to [Custom menu key functions](#custom-menu-key-functions). From a1ca87dcf05e77d122d1672ff7e9be6d25b0dc57 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:56:20 +0100 Subject: [PATCH 048/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index 2c5608b52d0..b08f0f1ab40 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -37,7 +37,7 @@ The custom menu provides the following capabilities: | Menu items | Description | |---------------|-------------------------------------------------------| -| Metrics | Search and select metrics | +| Metrics | Search and select metrics. | | Group By | Search and select dimensions to group by. Dimensions are grouped by the entity of the semantic model they come from. | | Granularity | Modify granularity of the primary time dimension | | Where | Filter your data. This includes categorical and time filters. | From 455bf0d340e3523ac46b796e5440b70d43fc7226 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:56:29 +0100 Subject: [PATCH 049/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index b08f0f1ab40..f074cfa82e8 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -41,7 +41,7 @@ The custom menu provides the following capabilities: | Group By | Search and select dimensions to group by. Dimensions are grouped by the entity of the semantic model they come from. | | Granularity | Modify granularity of the primary time dimension | | Where | Filter your data. This includes categorical and time filters. | -| Order By | Return your data ordered | +| Order By | Return your data ordered. | | Limit | Set a limit for the rows of your output | From 4a9a99c10f5dede4601df00a039604ce8b848173 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:56:37 +0100 Subject: [PATCH 050/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index f074cfa82e8..aa900ce35af 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -42,7 +42,7 @@ The custom menu provides the following capabilities: | Granularity | Modify granularity of the primary time dimension | | Where | Filter your data. This includes categorical and time filters. | | Order By | Return your data ordered. | -| Limit | Set a limit for the rows of your output | +| Limit | Set a limit for the rows of your output. | ## Filtering data From 8edd79902d0846e7b1081faa823cce584f50f20c Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Thu, 5 Oct 2023 17:56:43 +0100 Subject: [PATCH 051/104] Update website/docs/docs/use-dbt-semantic-layer/gsheets.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/use-dbt-semantic-layer/gsheets.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/use-dbt-semantic-layer/gsheets.md b/website/docs/docs/use-dbt-semantic-layer/gsheets.md index aa900ce35af..8ddaae0364c 100644 --- a/website/docs/docs/use-dbt-semantic-layer/gsheets.md +++ b/website/docs/docs/use-dbt-semantic-layer/gsheets.md @@ -39,7 +39,7 @@ The custom menu provides the following capabilities: |---------------|-------------------------------------------------------| | Metrics | Search and select metrics. | | Group By | Search and select dimensions to group by. Dimensions are grouped by the entity of the semantic model they come from. | -| Granularity | Modify granularity of the primary time dimension | +| Granularity | Modify the granularity of the primary time dimension. | | Where | Filter your data. This includes categorical and time filters. | | Order By | Return your data ordered. | | Limit | Set a limit for the rows of your output. | From b55c0fb0733c16f89790682bc4af1debcb341de5 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Thu, 5 Oct 2023 18:01:45 +0100 Subject: [PATCH 052/104] turn into tabs --- .../docs/docs/cloud/cloud-cli-installation.md | 84 +++++++++++++++++-- 1 file changed, 76 insertions(+), 8 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index b009294e962..cf60d3c6851 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -27,20 +27,76 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: -* [Install with Homebrew (MacOS)](#install-with-homebrew-macos)
-* [Install manually (Windows)](#install-manually-windows)
-* [Install manually (Linux)](#install-manually-linux)
+ -:::caution + -For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). +Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). -If you have dbt Core installed locally, ensure that you deactivate your Python environment or uninstall it using `pip uninstall dbt` before proceeding. Alternatively, advanced users can modify the $PATH environment variable to correctly point to the dbt Cloud CLI binary to use both dbt Cloud CLI and dbt Core together. +1. Run the following command to verify that there is no conflict with a dbt Core installation on your system: + +```bash +which dbt +``` + - This should return a `dbt not found`. If the dbt help text appears, use `pip uninstall dbt` to deactivate dbt Core from your machine. + +2. Install the dbt Cloud CLI with Homebrew: + +```bash +brew tap dbt-labs/dbt-cli +brew install dbt-cloud-cli +``` + +3. Verify the installation by running `dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Windows release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). + +2. Extract the `dbt.exe` executeable into the same folder as your dbt project. + +:::info + +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). + +Note that if you are using VS Code, you'll need to restart it to pick up modified environment variables. +::: + +3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Linux release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). (Pick the file based on your CPU architecture) + +2. Extract the `dbt-cloud-cli` binary to the same folder as your dbt project. + +```bash +tar -xf dbt_0.29.9_linux_amd64.tar.gz +./dbt --version +``` + +:::info + +Advanced users can configure multiple projects to use the same Cloud CLI executeable by adding it to their PATH environment variable in their shell profile. -You can always uninstall the Cloud CLI to return to using dbt Core. ::: +3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed."> + + + + + + ## Update dbt Cloud CLI The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. During the public preview period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes. @@ -115,3 +171,15 @@ After installation, you can [configure](/docs/cloud/configure-cloud-cli) the dbt dbt deps dbt compile ``` + +## FAQs + +
+ +How do I solve for path conflicts +For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). + +If you have dbt Core installed locally, ensure that you deactivate your Python environment or uninstall it using `pip uninstall dbt` before proceeding. Alternatively, advanced users can modify the $PATH environment variable to correctly point to the dbt Cloud CLI binary to use both dbt Cloud CLI and dbt Core together. + +You can always uninstall the Cloud CLI to return to using dbt Core. +
From f3fedc79c2883fc003de9f109c08e2de464c32f1 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 10:09:07 +0100 Subject: [PATCH 053/104] Update website/docs/docs/cloud/about-cloud-develop.md --- website/docs/docs/cloud/about-cloud-develop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 5a217d73442..5d9aef955b6 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -14,4 +14,4 @@ dbt Cloud offers a fast and reliable way to work on your dbt project. You can us This documentation section provides detailed instructions on setting up the dbt Cloud CLI and dbt Cloud IDE. To get started with dbt development, you'll need a [developer](/docs/cloud/manage-access/seats-and-users) account. For a more comprehensive setup guide, refer to our [quickstart guides](/quickstarts). -Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. +Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). From 81c11a870cf8f53f11abf7a86ffb0622b5d5b0e2 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 10:09:24 +0100 Subject: [PATCH 054/104] Update website/docs/docs/cloud/about-cloud-develop.md --- website/docs/docs/cloud/about-cloud-develop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 88066d4dcd4..6890942029b 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -9,7 +9,7 @@ pagination_next: "docs/cloud/cloud-cli-installation" dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI): - **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** — Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment. - - Note, the dbt Cloud CLI is distinct from [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source command-line tool for dbt. Both tools are command lines that use the same dbt commands, however, the dbt Cloud CLI is tailored to run specifically on dbt Cloud's infrastructure. + - The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). - **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** — Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI). From f36bed168603b9016b024184606e7daf6ae5dde7 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 10:13:48 +0100 Subject: [PATCH 055/104] Update about-cloud-develop.md --- website/docs/docs/cloud/about-cloud-develop.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 6890942029b..a20ecc331e5 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -9,7 +9,8 @@ pagination_next: "docs/cloud/cloud-cli-installation" dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI): - **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** — Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment. - - The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). + + - Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). - **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** — Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI). From e28e84b5ec6f146d5fbddba9f0bce7ded5d231cc Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 12:13:24 +0100 Subject: [PATCH 056/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index cf60d3c6851..f1a235d8b34 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -21,7 +21,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Support for dbt Mesh (cross-project `ref`), * Significant platform improvements, to be released over the coming months. -The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. +The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). ## Install dbt Cloud CLI From 2c287c4372d53f4e6387bc7b0d5d2f725d71b999 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 6 Oct 2023 13:19:04 +0100 Subject: [PATCH 057/104] update commands --- .../docs/docs/cloud/about-cloud-develop.md | 20 ++++-- .../docs/docs/cloud/cloud-cli-installation.md | 67 +++---------------- .../docs/docs/cloud/configure-cloud-cli.md | 1 + website/docs/reference/dbt-commands.md | 61 +++++++++-------- website/sidebars.js | 2 +- 5 files changed, 62 insertions(+), 89 deletions(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 4ea2172775d..3a3d1a3d83f 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -4,15 +4,27 @@ id: about-cloud-develop description: "Learn how to develop your dbt projects using dbt Cloud." sidebar_label: "About developing in dbt Cloud" pagination_next: "docs/cloud/cloud-cli-installation" +hide_table_of_contents: true --- -dbt Cloud offers a fast and reliable way to work on your dbt project. You can use it through an integrated development environment (IDE) in your browser or a dbt Cloud-powered command line interface (CLI): +dbt Cloud offers a fast and reliable way to work on your dbt project. It runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based integrated development environment (IDE) or a dbt Cloud-powered command line interface (CLI)[^1]. This allows you to seamlessly develop, test, and run dbt commands in the dbt Cloud IDE or through the dbt Cloud CLI. -- **[dbt Cloud CLI](/docs/cloud/cloud-cli-installation)** — Allows you to develop and run dbt commands from your local command line or code editor against your dbt Cloud development environment. +
- - Something to note is that the dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). + -- **[dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud)** — Develop directly in your browser, making dbt project development efficient by compiling code into SQL and managing project changes seamlessly using an intuitive user interface (UI). + + +

This documentation section provides detailed instructions on setting up the dbt Cloud CLI and dbt Cloud IDE. To get started with dbt development, you'll need a [developer](/docs/cloud/manage-access/seats-and-users) account. For a more comprehensive setup guide, refer to our [quickstart guides](/quickstarts). +[^1]: The dbt Cloud CLI and the open-sourced dbt Core are both command line tools that let you run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features). diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index cf60d3c6851..43052086f32 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -1,10 +1,12 @@ --- title: Install dbt Cloud CLI +sidebar_label: "Install dbt Cloud CLI" id: cloud-cli-installation description: "Instructions for installing and configuring dbt Cloud CLI" pagination_next: "docs/cloud/configure-cloud-cli" --- + :::info Public preview functionality The dbt Cloud CLI is currently in [public preview](/docs/dbt-versions/product-lifecycles#dbt-cloud). Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). @@ -21,8 +23,6 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Support for dbt Mesh (cross-project `ref`), * Significant platform improvements, to be released over the coming months. -The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. - ## Install dbt Cloud CLI You can install the dbt Cloud CLI on the command line by using one of these methods: @@ -96,61 +96,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI execute - ## Update dbt Cloud CLI The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. During the public preview period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes. @@ -176,6 +122,11 @@ dbt compile
+What's the difference between the dbt Cloud CLI and dbt Core? +The dbt Cloud CLI and dbt Core, an open-source project, are both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its features. +
+ +
How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). @@ -183,3 +134,7 @@ If you have dbt Core installed locally, ensure that you deactivate your Python e You can always uninstall the Cloud CLI to return to using dbt Core.
+ + + + diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 12349d6ef99..a03b0470295 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -2,6 +2,7 @@ title: Configure dbt Cloud CLI id: configure-cloud-cli description: "Instructions on how to configure the dbt Cloud CLI" +sidebar_label: "Configure dbt Cloud CLI" --- :::info Public preview functionality diff --git a/website/docs/reference/dbt-commands.md b/website/docs/reference/dbt-commands.md index 83556d5d0fa..cf970129169 100644 --- a/website/docs/reference/dbt-commands.md +++ b/website/docs/reference/dbt-commands.md @@ -2,42 +2,47 @@ title: "dbt Command reference" --- -dbt is typically run using the following ways: +so debug is for cli (dbt core) and dbt cancel and dbt reattach are for the cloud cli and NOT dbt core? or dbt core? (sorry i’m trying to be super clear here) -* In dbt Cloud using the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) -* On the command line using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) or open-sourced [dbt Core](https://github.com/dbt-labs/dbt-core) +You can run dbt using the following tools: -The dbt Cloud CLI and dbt Core are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. +- In dbt Cloud using the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) +- On the command line interface using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) or open-source [dbt Core](https://github.com/dbt-labs/dbt-core), both of which enable you to execute dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features). The following sections outline the commands supported by dbt and their relevant flags. For information about selecting models on the command line, consult the docs on [Model selection syntax](/reference/node-selection/syntax). ### Available commands - -Use the following dbt commands in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) or command line. Use the `dbt` prefix. For example, to run the `test` command, type `dbt test`. - -| Command | Description | Version | -| ------- | ----------- | ------- | -| [build](/reference/commands/build) | Build and test all selected resources (models, seeds, snapshots, tests) | All [supported versions](/docs/dbt-versions/core) | -| [clean](/reference/commands/clean) | Deletes artifacts present in the dbt project | All [supported versions](/docs/dbt-versions/core) | -| [clone](/reference/commands/clone) | Clone selected models from the specified state | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | -| [compile](/reference/commands/compile) | Compiles (but does not run) the models in a project | All [supported versions](/docs/dbt-versions/core) | -| [debug](/reference/commands/debug) | Debugs dbt connections and projects | All [supported versions](/docs/dbt-versions/core) | -| [deps](/reference/commands/deps) | Downloads dependencies for a project | All [supported versions](/docs/dbt-versions/core) | -| [docs](/reference/commands/cmd-docs) | Generates documentation for a project | All [supported versions](/docs/dbt-versions/core) | -| [list](/reference/commands/list) | Lists resources defined in a dbt project | All [supported versions](/docs/dbt-versions/core) | -| [parse](/reference/commands/parse) | Parses a project and writes detailed timing info | All [supported versions](/docs/dbt-versions/core) | -| [retry](/reference/commands/retry) | Retry the last run `dbt` command from the point of failure | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | -| [run](/reference/commands/run) | Runs the models in a project | All [supported versions](/docs/dbt-versions/core) | -| [run-operation](/reference/commands/run-operation) | Invoke a macro, including running arbitrary maintenance SQL against
the database | All [supported versions](/docs/dbt-versions/core) | -| [seed](/reference/commands/seed) | Loads CSV files into the database | All [supported versions](/docs/dbt-versions/core) | -| [show](/reference/commands/show) | Preview table rows post-transformation | All [supported versions](/docs/dbt-versions/core) | -| [snapshot](/reference/commands/snapshot) | Executes "snapshot" jobs defined in a project | All [supported versions](/docs/dbt-versions/core) | -| [source](/reference/commands/source) | Provides tools for working with source data (including validating that
sources are "fresh") | All [supported versions](/docs/dbt-versions/core) | -| [test](/reference/commands/test) | Executes tests defined in a project | All [supported versions](/docs/dbt-versions/core) | -| [init](/reference/commands/init) | Initializes a new dbt project (dbt Core only) | All [supported versions](/docs/dbt-versions/core) | + +All commands in the table are compatible with either the dbt Cloud IDE, dbt Cloud CLI, or dbt Core. + +You can run dbt commands in your specific tool by prefixing them with `dbt`. For example, to run the `test` command, type `dbt test`. + +| Command | Description | Compatible tools | Version | +| ------- | ----------- | ---------------- | ------- | +| [build](/reference/commands/build) | Build and test all selected resources (models, seeds, snapshots, tests) | All | All [supported versions](/docs/dbt-versions/core) | +| cancel | Cancels the most recent invocation.| dbt Cloud CLI | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | +| [clean](/reference/commands/clean) | Deletes artifacts present in the dbt project | All | All [supported versions](/docs/dbt-versions/core) | +| [clone](/reference/commands/clone) | Clone selected models from the specified state | dbt Cloud CLI
dbt Core | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | +| [compile](/reference/commands/compile) | Compiles (but does not run) the models in a project | All | All [supported versions](/docs/dbt-versions/core) | +| [debug](/reference/commands/debug) | Debugs dbt connections and projects | dbt Core | All [supported versions](/docs/dbt-versions/core) | +| [deps](/reference/commands/deps) | Downloads dependencies for a project | All | All [supported versions](/docs/dbt-versions/core) | +| [docs](/reference/commands/cmd-docs) | Generates documentation for a project | All | All [supported versions](/docs/dbt-versions/core) | +| help | Displays help information for any command | dbt Core
dbt Cloud CLI | All [supported versions](/docs/dbt-versions/core) | +| [list](/reference/commands/list) | Lists resources defined in a dbt project | All | All [supported versions](/docs/dbt-versions/core) | +| [parse](/reference/commands/parse) | Parses a project and writes detailed timing info | All | All [supported versions](/docs/dbt-versions/core) | +| reattach | Reattaches to the most recent invocation to retrieve logs and artifacts. | dbt Cloud CLI | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | +| [retry](/reference/commands/retry) | Retry the last run `dbt` command from the point of failure | All | Requires [dbt v1.6 or higher](/docs/dbt-versions/core) | +| [run](/reference/commands/run) | Runs the models in a project | All | All [supported versions](/docs/dbt-versions/core) | +| [run-operation](/reference/commands/run-operation) | Invoke a macro, including running arbitrary maintenance SQL against the database | All | All [supported versions](/docs/dbt-versions/core) | +| [seed](/reference/commands/seed) | Loads CSV files into the database | All | All [supported versions](/docs/dbt-versions/core) | +| [show](/reference/commands/show) | Preview table rows post-transformation | All | All [supported versions](/docs/dbt-versions/core) | +| [snapshot](/reference/commands/snapshot) | Executes "snapshot" jobs defined in a project | All | All [supported versions](/docs/dbt-versions/core) | +| [source](/reference/commands/source) | Provides tools for working with source data (including validating that sources are "fresh") | All | All [supported versions](/docs/dbt-versions/core) | +| [test](/reference/commands/test) | Executes tests defined in a project | All | All [supported versions](/docs/dbt-versions/core) | +| [init](/reference/commands/init) | Initializes a new dbt project | dbt Core | All [supported versions](/docs/dbt-versions/core) | @@ -66,7 +71,7 @@ Use the following dbt commands in the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/ - + Use the following dbt commands in the [CLI](/docs/core/about-the-cli) and use the `dbt` prefix. For example, to run the `test` command, type `dbt test`. diff --git a/website/sidebars.js b/website/sidebars.js index 1de66502556..66cbff70945 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -123,7 +123,7 @@ const sidebarSettings = { "docs/cloud/about-cloud-develop", { type: "category", - label: "dbt Cloud CLI (public preview)", + label: "dbt Cloud CLI", link: { type: "doc", id: "docs/cloud/cloud-cli-installation" }, items: [ "docs/cloud/cloud-cli-installation", From abd67fa7a499ffab348a8a87c4b491e2890b3025 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 6 Oct 2023 14:00:09 +0100 Subject: [PATCH 058/104] address issue 4041 --- .../global-configs/command-line-flags.md | 59 ++++++++++++++----- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/website/docs/reference/global-configs/command-line-flags.md b/website/docs/reference/global-configs/command-line-flags.md index 6496c92da6d..ce34ba85b41 100644 --- a/website/docs/reference/global-configs/command-line-flags.md +++ b/website/docs/reference/global-configs/command-line-flags.md @@ -4,60 +4,91 @@ id: "command-line-flags" sidebar: "Command line flags" --- -Command line (CLI) flags immediately follow `dbt` and precede your subcommand. When set, CLI flags override environment variables and profile configs. +For consistency, command line (CLI) flags should come right after the `dbt` prefix and its subcommands. This includes "global" flags (supported for all commands). When set, CLI flags override environment variables and profile configs. -Use this non-boolean config structure, replacing `` with the config you are enabling or disabling, `` with the new setting for the config, and `` with the command this config applies to: +For example, instead of using: + +```bash +dbt --no-populate-cache run +``` + +You should use: + +```bash +dbt run --no-populate-cache +``` + +Historically, passing flags (such as "global flags") _before_ the subcommand is a legacy functionality that dbt Labs can remove at any time. We do not support using the same flag before and after the subcommand. + + + + + +Use this non-boolean config structure: +- Replacing `` with the command this config applies to. +- `` with the config you are enabling or disabling, and +- `` with the new setting for the config. ```text -$ --= + --= ``` -Non-boolean config examples: +### Example ```text -dbt --printer-width=80 run -dbt --indirect-selection=eager test +dbt run --printer-width=80 +dbt test --indirect-selection=eager ``` -To turn on boolean configs, you would use the `--` CLI flag, and a `--no-` CLI flag to turn off boolean configs, replacing `` with the config you are enabling or disabling and `` with the command this config applies to. + + + + +To enable or disable boolean configs: +- Use `` this config applies to. +- Followed by `--` to turn it on, or `--no-` to turn it off. +- Replace `` with the config you are enabling or disabling -Boolean config structure: ```text -dbt -- -dbt --no- +dbt -- +dbt --no- ``` -Boolean config example: +### Example ```text -dbt --version-check run -dbt --no-version-check run +dbt run --version-check +dbt run --no-version-check ``` - \ No newline at end of file + + + + + From 533f1d6cec5bd310568d86e6f928ba2d9b5f4a43 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 14:26:41 +0100 Subject: [PATCH 059/104] Update website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md --- .../docs/docs/running-a-dbt-project/run-your-dbt-projects.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md index 9cf9002ecc2..436ec6def1c 100644 --- a/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md +++ b/website/docs/docs/running-a-dbt-project/run-your-dbt-projects.md @@ -14,7 +14,7 @@ You can run your dbt projects with [dbt Cloud](/docs/cloud/about-cloud/dbt-cloud - **dbt Core**: An open source project where you can develop from the command line. -The dbt Cloud CLI and dbt Core are both command line tools that allow you to run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. +The dbt Cloud CLI and dbt Core are both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features). The command line is available from your computer's terminal application such as Terminal and iTerm. With the command line, you can run commands and do other work from the current working directory on your computer. Before running the dbt project from the command line, make sure you are working in your dbt project directory. Learning terminal commands such as `cd` (change directory), `ls` (list directory contents), and `pwd` (present working directory) can help you navigate the directory structure on your system. From 0d5b0f7085a1ff20a3e89c5083f8ab97a4d3e0dd Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Fri, 6 Oct 2023 14:27:18 +0100 Subject: [PATCH 060/104] Update website/docs/docs/core/about-the-cli.md --- website/docs/docs/core/about-the-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/about-the-cli.md b/website/docs/docs/core/about-the-cli.md index 75e4a5705a2..48777ed7703 100644 --- a/website/docs/docs/core/about-the-cli.md +++ b/website/docs/docs/core/about-the-cli.md @@ -22,4 +22,4 @@ If you're using the command line, we recommend learning some basics of your term You can find more information on installing and setting up the dbt Core [here](/docs/core/installation). -dbt also supports a [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) and both dbt Core and the dbt Cloud CLI are command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure. +dbt also supports a dbt Cloud CLI and dbt Core, both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features). From 090c4f7f4c341bbc1deee4f1e840879562a1c49c Mon Sep 17 00:00:00 2001 From: Anders Swanson Date: Fri, 6 Oct 2023 10:52:22 -0400 Subject: [PATCH 061/104] updated logo --- website/snippets/_adapters-trusted.md | 2 +- website/static/img/icons/oracle.svg | 52 ++++++++++++++++++++--- website/static/img/icons/white/oracle.svg | 52 ++++++++++++++++++++--- 3 files changed, 93 insertions(+), 13 deletions(-) diff --git a/website/snippets/_adapters-trusted.md b/website/snippets/_adapters-trusted.md index 003c12cc370..96f62a925eb 100644 --- a/website/snippets/_adapters-trusted.md +++ b/website/snippets/_adapters-trusted.md @@ -13,7 +13,7 @@ icon="materialize"/> diff --git a/website/static/img/icons/oracle.svg b/website/static/img/icons/oracle.svg index 67b464426de..6868dea2eb3 100644 --- a/website/static/img/icons/oracle.svg +++ b/website/static/img/icons/oracle.svg @@ -1,7 +1,47 @@ - - - - - + + + + \ No newline at end of file diff --git a/website/static/img/icons/white/oracle.svg b/website/static/img/icons/white/oracle.svg index 67b464426de..6868dea2eb3 100644 --- a/website/static/img/icons/white/oracle.svg +++ b/website/static/img/icons/white/oracle.svg @@ -1,7 +1,47 @@ - - - - - + + + + \ No newline at end of file From 7de8890bbcebcaceddafe3a9898d555d6123b1c6 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 6 Oct 2023 16:33:34 +0100 Subject: [PATCH 062/104] add dbt mesh --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- website/docs/docs/cloud/configure-cloud-cli.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index f1a235d8b34..fbc614a887a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -18,7 +18,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Secure credential storage in the dbt Cloud platform. * Automatic deferral of build artifacts to your Cloud project's production environment. * Speedier, lower cost builds. -* Support for dbt Mesh (cross-project `ref`), +* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 12349d6ef99..5e33716beef 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -60,4 +60,6 @@ dbt-cloud: The dbt Cloud CLI shares the same set of commands as dbt Core. When you invoke a dbt command, that command is sent to dbt Cloud for processing. Since this is still invoking dbt under the hood, you'll still need to run `dbt deps`, followed by the same model build commands you typically run. +The dbt Cloud CLI supports [project dependencies](/docs/collaborate/govern/project-dependencies), which is an exciting way to depend on another project using the metadata service in dbt Cloud. It instantly resolves references (or `ref`) to public models defined in other projects. You don't need to execute or analyze these upstream models yourself. Instead, you treat them as an API that returns a dataset. + Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). From 2074866c780f584a815e14e43c865c391940f9e0 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Fri, 6 Oct 2023 16:38:01 +0100 Subject: [PATCH 063/104] improve ux --- website/docs/docs/cloud/about-cloud-develop.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/about-cloud-develop.md b/website/docs/docs/cloud/about-cloud-develop.md index 3a3d1a3d83f..920ea1d57ba 100644 --- a/website/docs/docs/cloud/about-cloud-develop.md +++ b/website/docs/docs/cloud/about-cloud-develop.md @@ -9,7 +9,7 @@ hide_table_of_contents: true dbt Cloud offers a fast and reliable way to work on your dbt project. It runs dbt Core in a hosted (single or multi-tenant) environment with a browser-based integrated development environment (IDE) or a dbt Cloud-powered command line interface (CLI)[^1]. This allows you to seamlessly develop, test, and run dbt commands in the dbt Cloud IDE or through the dbt Cloud CLI. -
+
Date: Fri, 6 Oct 2023 13:15:08 -0400 Subject: [PATCH 064/104] Adding databricks materialization --- website/docs/guides/migration/versions/01-upgrading-to-v1.6.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md b/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md index bdb47bbf2ea..a3ebc947aaf 100644 --- a/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md +++ b/website/docs/guides/migration/versions/01-upgrading-to-v1.6.md @@ -59,7 +59,7 @@ Supported on: - [Postgres](/reference/resource-configs/postgres-configs#materialized-view) - [Redshift](/reference/resource-configs/redshift-configs#materialized-view) - [Snowflake](/reference/resource-configs/snowflake-configs#dynamic-tables) -- Databricks (docs forthcoming) +- [Databricks](/reference/resource-configs/databricks-configs#materialized-views-and-streaming-tables) Support for BigQuery coming soon. From 05876a872f9a5953926dc1178414f9242b353e2d Mon Sep 17 00:00:00 2001 From: Greg McKeon Date: Fri, 6 Oct 2023 16:02:13 -0400 Subject: [PATCH 065/104] Update website/docs/docs/cloud/cloud-cli-installation.md Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index fbc614a887a..5470a0c7c4a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -168,7 +168,6 @@ To update, follow the same process explained in [Install manually (Windows)](#in After installation, you can [configure](/docs/cloud/configure-cloud-cli) the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, you can execute the following commands to compile a project using dbt Cloud: ```bash -dbt deps dbt compile ``` From 2da6f8029dc9fd428740e032e0dc50a9d1b90af0 Mon Sep 17 00:00:00 2001 From: Greg McKeon Date: Fri, 6 Oct 2023 16:03:00 -0400 Subject: [PATCH 066/104] Update website/docs/docs/cloud/configure-cloud-cli.md Co-authored-by: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/cloud/configure-cloud-cli.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/configure-cloud-cli.md b/website/docs/docs/cloud/configure-cloud-cli.md index 5e33716beef..2df176fbdd7 100644 --- a/website/docs/docs/cloud/configure-cloud-cli.md +++ b/website/docs/docs/cloud/configure-cloud-cli.md @@ -58,7 +58,7 @@ dbt-cloud: ## Use the dbt Cloud CLI -The dbt Cloud CLI shares the same set of commands as dbt Core. When you invoke a dbt command, that command is sent to dbt Cloud for processing. Since this is still invoking dbt under the hood, you'll still need to run `dbt deps`, followed by the same model build commands you typically run. +The dbt Cloud CLI shares the same set of commands as dbt Core. When you invoke a dbt command, that command is sent to dbt Cloud for processing. The dbt Cloud CLI supports [project dependencies](/docs/collaborate/govern/project-dependencies), which is an exciting way to depend on another project using the metadata service in dbt Cloud. It instantly resolves references (or `ref`) to public models defined in other projects. You don't need to execute or analyze these upstream models yourself. Instead, you treat them as an API that returns a dataset. From 045f5c3f67c126a22db9b23d7274c28e8f1c16e3 Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Fri, 6 Oct 2023 13:04:19 -0700 Subject: [PATCH 067/104] Update website/docs/docs/deploy/ci-jobs.md --- website/docs/docs/deploy/ci-jobs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/deploy/ci-jobs.md b/website/docs/docs/deploy/ci-jobs.md index 4a95a8bf8df..de8285a5e5b 100644 --- a/website/docs/docs/deploy/ci-jobs.md +++ b/website/docs/docs/deploy/ci-jobs.md @@ -98,7 +98,7 @@ If you're experiencing any issues, review some of the common questions and answe
  • You have overridden the generate_schema_name macro and it isn't using dbt_cloud_pr_ as the prefix.



    To resolve this, change your macro so that the temporary PR schema name contains the required prefix. For example:



    - ✅ Temporary PR schema name contains the prefix dbt_cloud_pr_ (like dbt_cloud_pr_123_456_marketing)

    + ✅ Temporary PR schema name contains the prefix dbt_cloud_pr_ (like dbt_cloud_pr_123_456_marketing).

    ❌ Temporary PR schema name doesn't contain the prefix dbt_cloud_pr_ (like marketing).


    • From 7be1c64b446bc818e92957971d20002f0d46eef5 Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Fri, 6 Oct 2023 13:06:16 -0700 Subject: [PATCH 068/104] Update website/docs/docs/deploy/ci-jobs.md --- website/docs/docs/deploy/ci-jobs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/deploy/ci-jobs.md b/website/docs/docs/deploy/ci-jobs.md index de8285a5e5b..86c71b9b313 100644 --- a/website/docs/docs/deploy/ci-jobs.md +++ b/website/docs/docs/deploy/ci-jobs.md @@ -103,7 +103,7 @@ If you're experiencing any issues, review some of the common questions and answe
  • - A macro is creating a schema, but no dbt models are writing to that schema. dbt Cloud does not drop temporary schemas that were not written to as a result of running a dbt model. + A macro is creating a schema but there are no dbt models writing to that schema. dbt Cloud doesn't drop temporary schemas that weren't written to as a result of running a dbt model.
From b2ddeae5d14e3a35d0febcc121cdb31ea6b74bfb Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Fri, 6 Oct 2023 13:06:36 -0700 Subject: [PATCH 069/104] Update website/docs/docs/deploy/ci-jobs.md --- website/docs/docs/deploy/ci-jobs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/deploy/ci-jobs.md b/website/docs/docs/deploy/ci-jobs.md index 86c71b9b313..30a858c64e7 100644 --- a/website/docs/docs/deploy/ci-jobs.md +++ b/website/docs/docs/deploy/ci-jobs.md @@ -94,7 +94,7 @@ If you're experiencing any issues, review some of the common questions and answe
Temporary schemas aren't dropping
-
If your temporary schemas aren't dropping after a PR merges or closes, this typically indicates one of two issues: +
If your temporary schemas aren't dropping after a PR merges or closes, this typically indicates one of these issues:
  • You have overridden the generate_schema_name macro and it isn't using dbt_cloud_pr_ as the prefix.



    To resolve this, change your macro so that the temporary PR schema name contains the required prefix. For example:



    From b10dd6b28da0adf7724240bc1c1bd58910768b81 Mon Sep 17 00:00:00 2001 From: asarraf <6273915+anksu2024@users.noreply.github.com> Date: Fri, 6 Oct 2023 17:49:19 -0700 Subject: [PATCH 070/104] Update the link for new Discussion --- .github/ISSUE_TEMPLATE/a-improve-docs.yml | 2 +- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- README.md | 2 +- website/docs/community/resources/oss-expectations.md | 4 ++-- website/docs/terms/materialization.md | 2 +- website/docs/terms/table.md | 2 +- website/docs/terms/view.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/a-improve-docs.yml b/.github/ISSUE_TEMPLATE/a-improve-docs.yml index 70b173e49a4..03e13092791 100644 --- a/.github/ISSUE_TEMPLATE/a-improve-docs.yml +++ b/.github/ISSUE_TEMPLATE/a-improve-docs.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/discussions) + * You can ask questions or submit ideas for the dbt docs in [Discussions](https://discourse.getdbt.com) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index dd585324f89..dcee91566f6 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/discussions) + * You can ask questions or submit ideas for the dbt docs in [Discussions](https://discourse.getdbt.com) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). diff --git a/README.md b/README.md index da82ab45fd6..7d7222642c9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Creating an inclusive and equitable environment for our documents is more import We welcome contributions from community members to this repo: - **Fixes**: When you notice an error, you can use the `Edit this page` button at the bottom of each page to suggest a change. - **New documentation**: If you contributed code in [dbt-core](https://github.com/dbt-labs/dbt-core), we encourage you to also write the docs here! Please reach out in the dbt community if you need help finding a place for these docs. -- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new?assignees=&labels=content%2Cimprovement&template=improve-docs.yml) or [start a discussion](https://github.com/dbt-labs/docs.getdbt.com/discussions) to propose ideas for a content area that requires attention. +- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new?assignees=&labels=content%2Cimprovement&template=improve-docs.yml) or [start a discussion](https://discourse.getdbt.com) to propose ideas for a content area that requires attention. You can use components documented in the [docusaurus library](https://v2.docusaurus.io/docs/markdown-features/). diff --git a/website/docs/community/resources/oss-expectations.md b/website/docs/community/resources/oss-expectations.md index 649a9dea94f..1940d098b9b 100644 --- a/website/docs/community/resources/oss-expectations.md +++ b/website/docs/community/resources/oss-expectations.md @@ -4,7 +4,7 @@ title: "Expectations for OSS contributors" Whether it's a dbt package, a plugin, `dbt-core`, or this very documentation site, contributing to the open source code that supports the dbt ecosystem is a great way to level yourself up as a developer, and to give back to the community. The goal of this page is to help you understand what to expect when contributing to dbt open source software (OSS). While we can only speak for our own experience as open source maintainers, many of these guidelines apply when contributing to other open source projects, too. -Have you seen things in other OSS projects that you quite like, and think we could learn from? [Open a discussion on the Developer Hub](https://github.com/dbt-labs/docs.getdbt.com/discussions/new), or start a conversation in the dbt Community Slack (for example: `#community-strategy`, `#dbt-core-development`, `#package-ecosystem`, `#adapter-ecosystem`). We always appreciate hearing from you! +Have you seen things in other OSS projects that you quite like, and think we could learn from? [Open a discussion on the DBT Community Forum](https://discourse.getdbt.com), or start a conversation in the dbt Community Slack (for example: `#community-strategy`, `#dbt-core-development`, `#package-ecosystem`, `#adapter-ecosystem`). We always appreciate hearing from you! ## Principles @@ -51,7 +51,7 @@ An issue could be a bug you’ve identified while using the product or reading t ### Best practices for issues -- Issues are **not** for support / troubleshooting / debugging help. Please [open a discussion on the Developer Hub](https://github.com/dbt-labs/docs.getdbt.com/discussions/new), so other future users can find and read proposed solutions. If you need help formulating your question, you can post in the `#advice-dbt-help` channel in the [dbt Community Slack](https://www.getdbt.com/community/). +- Issues are **not** for support / troubleshooting / debugging help. Please [open a discussion on the DBT Community Forum](https://discourse.getdbt.com), so other future users can find and read proposed solutions. If you need help formulating your question, you can post in the `#advice-dbt-help` channel in the [dbt Community Slack](https://www.getdbt.com/community/). - Always search existing issues first, to see if someone else had the same idea / found the same bug you did. - Many repositories offer templates for creating issues, such as when reporting a bug or requesting a new feature. If available, please select the relevant template and fill it out to the best of your ability. This will help other people understand your issue and respond. diff --git a/website/docs/terms/materialization.md b/website/docs/terms/materialization.md index fdeaaebfcc8..05769ec31e4 100644 --- a/website/docs/terms/materialization.md +++ b/website/docs/terms/materialization.md @@ -11,7 +11,7 @@ hoverSnippet: The exact Data Definition Language (DDL) that dbt will use when cr :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the docs.getdbt.com GitHub repository](https://github.com/dbt-labs/docs.getdbt.com/discussions) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! ::: The exact Data Definition Language (DDL) that dbt will use when creating the model’s equivalent in a . It's the manner in which the data is represented, and each of those options is defined either canonically (tables, views, incremental), or bespoke. diff --git a/website/docs/terms/table.md b/website/docs/terms/table.md index 69fc2b3e6b6..f97a42c7ec1 100644 --- a/website/docs/terms/table.md +++ b/website/docs/terms/table.md @@ -6,7 +6,7 @@ displayText: table hoverSnippet: In simplest terms, a table is the direct storage of data in rows and columns. Think excel sheet with raw values in each of the cells. --- :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the docs.getdbt.com GitHub repository](https://github.com/dbt-labs/docs.getdbt.com/discussions) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! ::: In simplest terms, a table is the direct storage of data in rows and columns. Think excel sheet with raw values in each of the cells. diff --git a/website/docs/terms/view.md b/website/docs/terms/view.md index 5d9238256e0..15f4302fa4f 100644 --- a/website/docs/terms/view.md +++ b/website/docs/terms/view.md @@ -6,7 +6,7 @@ displayText: view hoverSnippet: A view (as opposed to a table) is a defined passthrough SQL query that can be run against a database (or data warehouse). --- :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the docs.getdbt.com GitHub repository](https://github.com/dbt-labs/docs.getdbt.com/discussions) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! ::: A view (as opposed to a ) is a defined passthrough SQL query that can be run against a database (or ). A view doesn’t store data, like a table does, but it defines the logic that you need to fetch the underlying data. From 45fce443bbdc5de2254bd6c5aafa09d36e2bb0ff Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Sat, 7 Oct 2023 16:09:00 -0600 Subject: [PATCH 071/104] `config` for metrics is singular rather than plural --- website/docs/docs/build/metrics-overview.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/build/metrics-overview.md b/website/docs/docs/build/metrics-overview.md index e6d875386ee..b699bf4d959 100644 --- a/website/docs/docs/build/metrics-overview.md +++ b/website/docs/docs/build/metrics-overview.md @@ -16,7 +16,7 @@ The keys for metrics definitions are: | `description` | Provide the description for your metric. | Optional | | `type` | Define the type of metric, which can be `simple`, `ratio`, `cumulative`, or `derived`. | Required | | `type_params` | Additional parameters used to configure metrics. `type_params` are different for each metric type. | Required | -| `configs` | Provide the specific configurations for your metric. | Optional | +| `config` | Provide the specific configurations for your metric. | Optional | | `label` | The display name for your metric. This value will be shown in downstream tools. | Required | | `filter` | You can optionally add a filter string to any metric type, applying filters to dimensions, entities, or time dimensions during metric computation. Consider it as your WHERE clause. | Optional | | `meta` | Additional metadata you want to add to your metric. | Optional | @@ -31,7 +31,7 @@ metrics: type: the type of the metric ## Required type_params: ## Required - specific properties for the metric type - configs: here for `enabled` ## Optional + config: here for `enabled` ## Optional label: The display name for your metric. This value will be shown in downstream tools. ## Required filter: | ## Optional {{ Dimension('entity__name') }} > 0 and {{ Dimension(' entity__another name') }} is not From 27a0129f44d8e64b7e12283f2a85a928230b57ed Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Sat, 7 Oct 2023 16:16:49 -0600 Subject: [PATCH 072/104] Fix rendering of "Advice" for when to use materialized views --- website/docs/docs/build/materializations.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docs/docs/build/materializations.md b/website/docs/docs/build/materializations.md index 463651ccc77..ae75b575d5f 100644 --- a/website/docs/docs/build/materializations.md +++ b/website/docs/docs/build/materializations.md @@ -140,8 +140,7 @@ required with incremental materializations less configuration options available, see your database platform's docs for more details * Materialized views may not be supported by every database platform * **Advice:** - * Consider materialized views for use cases where incremental models are sufficient, -but you would like the data platform to manage the incremental logic and refresh. + * Consider materialized views for use cases where incremental models are sufficient, but you would like the data platform to manage the incremental logic and refresh. ## Python materializations From c87c133f970348b97998a9fedc001d3085e0b045 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:29:52 +0100 Subject: [PATCH 073/104] Update cloud-cli-installation.md update alpha docs with new changes --- .../docs/docs/cloud/cloud-cli-installation.md | 177 +++++++++++++----- 1 file changed, 125 insertions(+), 52 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 68a8ef365d6..efded6041dc 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -1,5 +1,5 @@ --- -title: Installing the dbt Cloud CLI (Alpha) +title: Install the dbt Cloud CLI (Alpha) id: cloud-cli-installation description: "Instructions for installing and configuring dbt Cloud CLI" --- @@ -12,99 +12,172 @@ These instructions are not intended for general audiences at this time. ::: -## Installing dbt Cloud CLI -### Install and update with Brew on MacOS (recommended) +dbt Cloud natively supports developing using a command line (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The dbt Cloud CLI allows you to run dbt commands against your dbt Cloud development environment from your local command line. -1. Install the dbt Cloud CLI: +dbt commands are run against dbt Cloud's infrastructure and benefit from: + +* Secure credential storage in the dbt Cloud platform. +* Automatic deferral of build artifacts to your Cloud project's production environment. +* Speedier, lower-cost builds. +* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), +* Significant platform improvements, to be released over the coming months. + +The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). + +## Install dbt Cloud CLI + +You can install the dbt Cloud CLI on the command line by using one of these methods: +* Note, the `dbt deps` command is not required anymore. + + + + + +Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Run the following command to verify that there is no conflict with a dbt Core installation on your system: + +```bash +which dbt +``` + - This should return a `dbt not found`. If the dbt help text appears, use `pip uninstall dbt` to deactivate dbt Core from your machine. + +2. Install the dbt Cloud CLI with Homebrew: ```bash brew tap dbt-labs/dbt-cli brew install dbt-cloud-cli ``` -2. Verify the installation by requesting your homebrew installation path (not your dbt core installs). If the `which dbt` command returns nothing, then you should modify your PATH in `~.zshrc` or create an alias. +3. Verify the installation by running `dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Windows release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). + +2. Extract the `dbt.exe` executeable into the same folder as your dbt project. + +:::info + +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). + +Note that if you are using VS Code, you'll need to restart it to pick up modified environment variables. +::: + +3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. + + + + + +If your operating system runs into path conflicts, refer to the [FAQs](#faqs). + +1. Download the latest Linux release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). (Pick the file based on your CPU architecture) + +2. Extract the `dbt-cloud-cli` binary to the same folder as your dbt project. ```bash -which dbt -dbt --help +tar -xf dbt_0.29.9_linux_amd64.tar.gz +./dbt --version ``` -### Manually install (Windows and Linux) +:::info -1. Download the latest release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). -2. Add the `dbt` executable to your path. -3. Move to a directory with a dbt project, and create a `dbt_cloud.yml` file containing your `project-id` from dbt Cloud. -4. Invoke `dbt --help` from your terminal to see a list of supported commands. +Advanced users can configure multiple projects to use the same Cloud CLI executable by adding it to their PATH environment variable in their shell profile. -#### Updating your dbt Cloud installation (Windows + Linux) +::: -Follow the same process in [Installing dbt Cloud CLI](#manually-install-windows-only) and replace the existing `dbt` executable with the new one. You should not have to go through the security steps again. +3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed."> -## Setting up the CLI + -The following instructions are for setting up the dbt Cloud CLI. + -1. Ensure that you have created a project in [dbt Cloud](https://cloud.getdbt.com/). +## Update dbt Cloud CLI -2. Ensure that your personal [development credentials](https://cloud.getdbt.com/settings/profile/credentials) are set on the project. +The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. -3. Navigate to [your profile](https://cloud.getdbt.com/settings/profile) and enable the **Beta** flag under **Experimental Features.** +#### Update with Homebrew (MacOS) -4. Create an environment variable with your [dbt Cloud API key](https://cloud.getdbt.com/settings/profile#api-access): +To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. +#### Update manually (Windows and Linux) -```bash -vi ~/.zshrc +To update, follow the same process explained in [Install manually (Windows)](#install-manually-windows) and replace the existing `dbt.exe` executable with the new one. -# dbt Cloud CLI -export DBT_CLOUD_API_KEY="1234" # Replace "1234" with your API key -``` -5. Load the new environment variable. Note: You may need to reactivate your Python virtual environment after sourcing your shell's dot file. Alternatively, restart your shell instead of sourcing the shell's dot file +## Configure the dbt Cloud CLI + +After installation, you can configure the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, you can execute the following commands to compile a project using dbt Cloud: ```bash -source ~/.zshrc +dbt compile ``` -6. Navigate to a dbt project +### Prerequisites + +- You must set up a project in dbt Cloud. +- You must have your [personal development credentials](/docs/dbt-cloud-environments#set-developer-credentials) set for that project. The dbt Cloud CLI will use these credentials, stored securely in dbt Cloud, to communicate with your data platform. +- You must [enroll](/docs/dbt-versions/experimental-features) in the dbt Cloud beta features. + - To enroll, navigate to your **Profile Settings** and enable the **Beta** flag under **Experimental Features**. + +Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt Cloud project. + +1. Ensure you meet the prerequisites above. +2. Create an environment variable with your [dbt Cloud API key](/docs/dbt-cloud-apis/user-tokens): + - On MacOS, Linux, or Windows add an environment variable: + + ```bash + export DBT_CLOUD_API_KEY="1234" # Replace 1234 with your API key + ``` + + - In Powershell, add an environment variable: IS THIS MISSING SOMETHING? + - Note that this variable resets if you restart your shell. To add an environment variable permanently, add a system environment variable in your platform. + +3. Navigate to a dbt project in your terminal: ```bash cd ~/dbt-projects/jaffle_shop ``` -7. Create a `dbt_cloud.yml` in the root project directory. The file is required to have a `project-id` field with a valid [project ID](#glossary). Enter the following commands: +4. In your `dbt_project.yml` file, ensure there is a section titled `dbt-cloud`. This section is required to have a `project-id` field with a valid project ID. -```bash -pwd # Input -/Users/user/dbt-projects/jaffle_shop # Output -``` +```yaml +# dbt_project.yml +name: -```bash -echo "project-id: ''" > dbt_cloud.yml # Input -``` +version: +... -```bash -cat dbt_cloud.yml # Input -project-id: '123456' # Output +dbt-cloud: + project-id: PROJECT_ID ``` -You can find your project ID by selecting your project and clicking on **Develop** in the navigation bar. Your project ID is the number in the URL: https://cloud.getdbt.com/develop/26228/projects/PROJECT_ID. +- To find your project ID, go to **Develop** in the navigation menu. Select the dbt Cloud project URL, such as `https://cloud.getdbt.com/develop/26228/projects123456`, where the project ID is `123456`. -If `dbt_cloud.yml` already exists, edit the file, and verify the project ID field uses a valid project ID. -#### Upgrade the CLI with Brew +## Use the dbt Cloud CLI -```bash -brew update -brew upgrade dbt-cloud-cli -``` +The dbt Cloud CLI shares the same set of commands as dbt Core. When you invoke a dbt command, that command is sent to dbt Cloud for processing. + +The dbt Cloud CLI supports [project dependencies](/docs/collaborate/govern/project-dependencies), which is an exciting way to depend on another project using the metadata service in dbt Cloud. It instantly resolves references (or `ref`) to public models defined in other projects. You don't need to execute or analyze these upstream models yourself. Instead, you treat them as an API that returns a dataset. + +Share feedback or request features you'd like to see on the [dbt community Slack](https://getdbt.slack.com/archives/C05M77P54FL). + + +## FAQs + +
    -## Using dbt Cloud CLI +How do I solve for path conflicts +For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). -**Coming soon** +If you have dbt Core installed locally, ensure that you deactivate your Python environment or uninstall it using `pip uninstall dbt` before proceeding. Alternatively, advanced users can modify the $PATH environment variable to correctly point to the dbt Cloud CLI binary to use both dbt Cloud CLI and dbt Core together. -## Glossary +You can always uninstall the Cloud CLI to return to using dbt Core. +
    -- **dbt cloud API key:** Your API key found by navigating to the **gear icon**, clicking **Profile Settings**, and scrolling down to **API**. -- **Project ID:** The ID of the dbt project you're working with. Can be retrieved from the dbt Cloud URL after a project has been selected, for example, `https://cloud.getdbt.com/deploy/{accountID}/projects/{projectID}` -- **Development credentials:** Your personal warehouse credentials for the project you’re working with. They can be set by selecting the project and entering them in dbt Cloud. Navigate to the **gear icon**, click **Profile Settings**, and click **Credentials** from the left-side menu. From ecd32c779b49d09e45f6a10644f8de73cd1e3235 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:47:40 +0100 Subject: [PATCH 074/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index efded6041dc..3d7d13817c9 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -28,7 +28,6 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- ## Install dbt Cloud CLI You can install the dbt Cloud CLI on the command line by using one of these methods: -* Note, the `dbt deps` command is not required anymore. From c7c1db9b52b1e1df001de7f08c7c3eab941fb670 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:49:44 +0100 Subject: [PATCH 075/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 3d7d13817c9..675efcb600b 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -51,6 +51,8 @@ brew install dbt-cloud-cli 3. Verify the installation by running `dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. +* You no longer need to use the `dbt deps` command. Previously, you had to run that command. + From 011f50b0b41d4e979dffb4377d0a6462fc34ba43 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:50:03 +0100 Subject: [PATCH 076/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 675efcb600b..576765d4427 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -72,6 +72,8 @@ Note that if you are using VS Code, you'll need to restart it to pick up modifie 3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. +* You no longer need to use the `dbt deps` command. Previously, you had to run that command. + From 0530de724e5e3a195137332fad0aa5cdd7e40b68 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:50:48 +0100 Subject: [PATCH 077/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 576765d4427..6b5330f0acd 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -95,7 +95,9 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa ::: -3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed."> +3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. + +* You no longer need to use the `dbt deps` command. Previously, you had to run that command. From 90ac0339647ec5c22a9c58fdd7f070f1f288cc3c Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:51:05 +0100 Subject: [PATCH 078/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 6b5330f0acd..fc14c7bed8d 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -123,7 +123,7 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje dbt compile ``` -### Prerequisites +**Prerequisites** - You must set up a project in dbt Cloud. - You must have your [personal development credentials](/docs/dbt-cloud-environments#set-developer-credentials) set for that project. The dbt Cloud CLI will use these credentials, stored securely in dbt Cloud, to communicate with your data platform. From 8034bdd493fc7bc75d411cf6e26b8e2f5b827ace Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:53:16 +0100 Subject: [PATCH 079/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index fc14c7bed8d..839c75557ad 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -121,7 +121,6 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje ```bash dbt compile -``` **Prerequisites** From 7ba82e2ad2282cedae7ee4f71e6aea9ed4f17f4c Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:53:28 +0100 Subject: [PATCH 080/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 839c75557ad..96286838fdc 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -117,7 +117,7 @@ To update, follow the same process explained in [Install manually (Windows)](#in ## Configure the dbt Cloud CLI -After installation, you can configure the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, you can execute the following commands to compile a project using dbt Cloud: +After installation, you can configure the dbt Cloud CLI for your dbt Cloud project and use it to run [dbt commands](/reference/dbt-commands) similar to dbt Core. For example, you can execute the following command to compile a project using dbt Cloud: ```bash dbt compile From e4ec12e9441213a67a8cfcb7aa1d4bf96686344a Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:55:40 +0100 Subject: [PATCH 081/104] Update website/docs/community/resources/oss-expectations.md --- website/docs/community/resources/oss-expectations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/community/resources/oss-expectations.md b/website/docs/community/resources/oss-expectations.md index 1940d098b9b..c94fe87f3d5 100644 --- a/website/docs/community/resources/oss-expectations.md +++ b/website/docs/community/resources/oss-expectations.md @@ -4,7 +4,7 @@ title: "Expectations for OSS contributors" Whether it's a dbt package, a plugin, `dbt-core`, or this very documentation site, contributing to the open source code that supports the dbt ecosystem is a great way to level yourself up as a developer, and to give back to the community. The goal of this page is to help you understand what to expect when contributing to dbt open source software (OSS). While we can only speak for our own experience as open source maintainers, many of these guidelines apply when contributing to other open source projects, too. -Have you seen things in other OSS projects that you quite like, and think we could learn from? [Open a discussion on the DBT Community Forum](https://discourse.getdbt.com), or start a conversation in the dbt Community Slack (for example: `#community-strategy`, `#dbt-core-development`, `#package-ecosystem`, `#adapter-ecosystem`). We always appreciate hearing from you! +Have you seen things in other OSS projects that you quite like, and think we could learn from? [Open a discussion on the dbt Community Forum](https://discourse.getdbt.com), or start a conversation in the dbt Community Slack (for example: `#community-strategy`, `#dbt-core-development`, `#package-ecosystem`, `#adapter-ecosystem`). We always appreciate hearing from you! ## Principles From 9eefafad72fb07def47ef506e623ab88572156ab Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:56:02 +0100 Subject: [PATCH 082/104] Update website/docs/terms/view.md --- website/docs/terms/view.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/terms/view.md b/website/docs/terms/view.md index 15f4302fa4f..e242ae34dc0 100644 --- a/website/docs/terms/view.md +++ b/website/docs/terms/view.md @@ -6,7 +6,7 @@ displayText: view hoverSnippet: A view (as opposed to a table) is a defined passthrough SQL query that can be run against a database (or data warehouse). --- :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the dbt Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! ::: A view (as opposed to a ) is a defined passthrough SQL query that can be run against a database (or ). A view doesn’t store data, like a table does, but it defines the logic that you need to fetch the underlying data. From 0d1afff558445c70c05888d822e76457ebc82579 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:57:18 +0100 Subject: [PATCH 083/104] Update website/docs/terms/table.md --- website/docs/terms/table.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/terms/table.md b/website/docs/terms/table.md index f97a42c7ec1..cbe36ec1315 100644 --- a/website/docs/terms/table.md +++ b/website/docs/terms/table.md @@ -6,7 +6,7 @@ displayText: table hoverSnippet: In simplest terms, a table is the direct storage of data in rows and columns. Think excel sheet with raw values in each of the cells. --- :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create an issue in the docs.getdbt.com repository](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) to begin the process of becoming a glossary contributor! ::: In simplest terms, a table is the direct storage of data in rows and columns. Think excel sheet with raw values in each of the cells. From 7b34be21db7099168e5f64a62f6bca2b0db9de1b Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:57:38 +0100 Subject: [PATCH 084/104] Update website/docs/terms/view.md --- website/docs/terms/view.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/terms/view.md b/website/docs/terms/view.md index e242ae34dc0..90cd5d1f36f 100644 --- a/website/docs/terms/view.md +++ b/website/docs/terms/view.md @@ -6,7 +6,7 @@ displayText: view hoverSnippet: A view (as opposed to a table) is a defined passthrough SQL query that can be run against a database (or data warehouse). --- :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the dbt Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create an issue in the docs.getdbt.com repository](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) to begin the process of becoming a glossary contributor! ::: A view (as opposed to a ) is a defined passthrough SQL query that can be run against a database (or ). A view doesn’t store data, like a table does, but it defines the logic that you need to fetch the underlying data. From 7e3700d67fb15bce012f1c941abbc0e589c68131 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:58:12 +0100 Subject: [PATCH 085/104] Update website/docs/terms/materialization.md --- website/docs/terms/materialization.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/terms/materialization.md b/website/docs/terms/materialization.md index 05769ec31e4..328076f1483 100644 --- a/website/docs/terms/materialization.md +++ b/website/docs/terms/materialization.md @@ -11,7 +11,7 @@ hoverSnippet: The exact Data Definition Language (DDL) that dbt will use when cr :::important This page could use some love -This term would benefit from additional depth and examples. Have knowledge to contribute? [Create a discussion in the DBT Community Forum](https://discourse.getdbt.com) to begin the process of becoming a glossary contributor! +This term would benefit from additional depth and examples. Have knowledge to contribute? [Create an issue in the docs.getdbt.com repository](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) to begin the process of becoming a glossary contributor! ::: The exact Data Definition Language (DDL) that dbt will use when creating the model’s equivalent in a . It's the manner in which the data is represented, and each of those options is defined either canonically (tables, views, incremental), or bespoke. From 3bcab55cc06cbc93e1004b00883d05ef02b2f8bc Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 09:58:58 +0100 Subject: [PATCH 086/104] Update website/docs/community/resources/oss-expectations.md --- website/docs/community/resources/oss-expectations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/community/resources/oss-expectations.md b/website/docs/community/resources/oss-expectations.md index c94fe87f3d5..9c916de1240 100644 --- a/website/docs/community/resources/oss-expectations.md +++ b/website/docs/community/resources/oss-expectations.md @@ -51,7 +51,7 @@ An issue could be a bug you’ve identified while using the product or reading t ### Best practices for issues -- Issues are **not** for support / troubleshooting / debugging help. Please [open a discussion on the DBT Community Forum](https://discourse.getdbt.com), so other future users can find and read proposed solutions. If you need help formulating your question, you can post in the `#advice-dbt-help` channel in the [dbt Community Slack](https://www.getdbt.com/community/). +- Issues are **not** for support / troubleshooting / debugging help. Please [open a discussion on the dbt Community Forum](https://discourse.getdbt.com), so other future users can find and read proposed solutions. If you need help formulating your question, you can post in the `#advice-dbt-help` channel in the [dbt Community Slack](https://www.getdbt.com/community/). - Always search existing issues first, to see if someone else had the same idea / found the same bug you did. - Many repositories offer templates for creating issues, such as when reporting a bug or requesting a new feature. If available, please select the relevant template and fill it out to the best of your ability. This will help other people understand your issue and respond. From b09f9192681794a4a7e0301e7b5d32d294b7d4e2 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:01:48 +0100 Subject: [PATCH 087/104] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d7222642c9..c749fedf95a 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Creating an inclusive and equitable environment for our documents is more import We welcome contributions from community members to this repo: - **Fixes**: When you notice an error, you can use the `Edit this page` button at the bottom of each page to suggest a change. - **New documentation**: If you contributed code in [dbt-core](https://github.com/dbt-labs/dbt-core), we encourage you to also write the docs here! Please reach out in the dbt community if you need help finding a place for these docs. -- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new?assignees=&labels=content%2Cimprovement&template=improve-docs.yml) or [start a discussion](https://discourse.getdbt.com) to propose ideas for a content area that requires attention. +- **Major rewrites**: You can [file an issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) to propose ideas for a content area that requires attention. You can use components documented in the [docusaurus library](https://v2.docusaurus.io/docs/markdown-features/). From 45249526e861bc6d7a92e5070af0cbd4ccb24e0f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:02:26 +0100 Subject: [PATCH 088/104] Update .github/ISSUE_TEMPLATE/improve-the-site.yml --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index dcee91566f6..97be63caecd 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://discourse.getdbt.com) + * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). From 4fe5b42562f17a111a83ec3f4b7b41b1cbaba1fe Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:02:43 +0100 Subject: [PATCH 089/104] Update .github/ISSUE_TEMPLATE/a-improve-docs.yml --- .github/ISSUE_TEMPLATE/a-improve-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/a-improve-docs.yml b/.github/ISSUE_TEMPLATE/a-improve-docs.yml index 03e13092791..3fee82062b4 100644 --- a/.github/ISSUE_TEMPLATE/a-improve-docs.yml +++ b/.github/ISSUE_TEMPLATE/a-improve-docs.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://discourse.getdbt.com) + * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). From 6caadaae74dc8a12ae96e13855852146d11aa691 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:03:23 +0100 Subject: [PATCH 090/104] Update .github/ISSUE_TEMPLATE/a-improve-docs.yml --- .github/ISSUE_TEMPLATE/a-improve-docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/a-improve-docs.yml b/.github/ISSUE_TEMPLATE/a-improve-docs.yml index 3fee82062b4..c9030bc227b 100644 --- a/.github/ISSUE_TEMPLATE/a-improve-docs.yml +++ b/.github/ISSUE_TEMPLATE/a-improve-docs.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) + * You can ask questions or submit ideas for the dbt docs in [Issues](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). From 69b3a842660207ed6fe8f0e01a7e1dac9c607620 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:08:06 +0100 Subject: [PATCH 091/104] Update .github/ISSUE_TEMPLATE/improve-the-site.yml --- .github/ISSUE_TEMPLATE/improve-the-site.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml index 97be63caecd..01ebdea711a 100644 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ b/.github/ISSUE_TEMPLATE/improve-the-site.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - * You can ask questions or submit ideas for the dbt docs in [Discussions](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) + * You can ask questions or submit ideas for the dbt docs in [Issues](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). From f36307902ad0836f07ddaf4f9aafe866ebb200b5 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:10:55 +0100 Subject: [PATCH 092/104] Update cloud-cli-installation.md add tabs --- website/docs/docs/cloud/cloud-cli-installation.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 96286838fdc..854ce15fb01 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -107,13 +107,21 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. -#### Update with Homebrew (MacOS) + + + + + ## Configure the dbt Cloud CLI @@ -121,6 +129,7 @@ After installation, you can configure the dbt Cloud CLI for your dbt Cloud proje ```bash dbt compile +``` **Prerequisites** From a9346b793789d3de7ddbe95ec3b5416aacf5948f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:12:07 +0100 Subject: [PATCH 093/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 854ce15fb01..395cc33f72a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -186,6 +186,11 @@ Share feedback or request features you'd like to see on the [dbt community Slack
    +What's the difference between the dbt Cloud CLI and dbt Core? +The dbt Cloud CLI and dbt Core, an open-source project, are both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its features. + +
    + How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). From 63977c148e4330101f1a5e0b544c066834f41b4e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:24:38 +0100 Subject: [PATCH 094/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 395cc33f72a..a2a00fd2b73 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -29,7 +29,7 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: - + @@ -65,7 +65,7 @@ If your operating system runs into path conflicts, refer to the [FAQs](#faqs). :::info -Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). Note that if you are using VS Code, you'll need to restart it to pick up modified environment variables. ::: @@ -117,7 +117,7 @@ To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. From 17c84f7111baf56987c7daf623af690b3ee0512f Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:32:40 +0100 Subject: [PATCH 095/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index a2a00fd2b73..aa8a6e48157 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -30,7 +30,6 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: - Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). @@ -100,7 +99,6 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa * You no longer need to use the `dbt deps` command. Previously, you had to run that command. - ## Update dbt Cloud CLI @@ -108,19 +106,16 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. - - ## Configure the dbt Cloud CLI From 97856f13ed33e71ade1ab04c6fb9f021a87eaae6 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:42:16 +0100 Subject: [PATCH 096/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index aa8a6e48157..0c5c7cc134f 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -30,6 +30,7 @@ The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open- You can install the dbt Cloud CLI on the command line by using one of these methods: + Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). @@ -99,6 +100,7 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa * You no longer need to use the `dbt deps` command. Previously, you had to run that command. + ## Update dbt Cloud CLI @@ -106,16 +108,18 @@ Advanced users can configure multiple projects to use the same Cloud CLI executa The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. - To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. - To update, follow the same process explained in [Install manually (Windows)](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one. + ## Configure the dbt Cloud CLI From bc9bcd42b60ba7086dc36c7b00f1ced847ec28cb Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 10:58:54 +0100 Subject: [PATCH 097/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 0c5c7cc134f..00b85a4603a 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -1,5 +1,5 @@ --- -title: Install the dbt Cloud CLI (Alpha) +title: Installing the dbt Cloud CLI (Alpha) id: cloud-cli-installation description: "Instructions for installing and configuring dbt Cloud CLI" --- @@ -190,6 +190,7 @@ The dbt Cloud CLI and dbt Core +
    How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). From 5dde8fa15ffa88198c04d4a0ac67a1c16907c25e Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:08:06 +0100 Subject: [PATCH 098/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 00b85a4603a..43bc70e1805 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -20,7 +20,7 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Secure credential storage in the dbt Cloud platform. * Automatic deferral of build artifacts to your Cloud project's production environment. * Speedier, lower-cost builds. -* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), +* Support for dbt Mesh ([cross-project `ref`](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). From 2ff2ee391e040aa9f3ad295a49f5c9c19b28cfab Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:08:38 +0100 Subject: [PATCH 099/104] Update cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 43bc70e1805..94c10a7e4f8 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -109,12 +109,12 @@ The following instructions explain how to update the dbt CLoud CLI to the latest - + To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. - + To update, follow the same process explained in [Install manually (Windows)](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one. From 84524cecea7bcf6e3a22a6197e70c0a0985fbf9a Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:12:31 +0100 Subject: [PATCH 100/104] Update cloud-cli-installation.md --- .../docs/docs/cloud/cloud-cli-installation.md | 96 +++++-------------- 1 file changed, 26 insertions(+), 70 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 5470a0c7c4a..fc51a9aa94b 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -17,22 +17,19 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Secure credential storage in the dbt Cloud platform. * Automatic deferral of build artifacts to your Cloud project's production environment. -* Speedier, lower cost builds. -* Support for dbt Mesh ([cross-project `ref`)](/docs/collaborate/govern/project-dependencies)), +* Speedier, lower-cost builds. +* Support for dbt Mesh ([cross-project `ref`](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. -The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). - ## Install dbt Cloud CLI You can install the dbt Cloud CLI on the command line by using one of these methods: - - + -Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. If your operating system runs into path conflicts, refer to the [FAQs](#faqs). +Before you begin, make sure you have [Homebrew installed](http://brew.sh/) in your code editor or command line terminal. Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. 1. Run the following command to verify that there is no conflict with a dbt Core installation on your system: @@ -54,7 +51,7 @@ brew install dbt-cloud-cli -If your operating system runs into path conflicts, refer to the [FAQs](#faqs). +Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. 1. Download the latest Windows release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). @@ -62,9 +59,9 @@ If your operating system runs into path conflicts, refer to the [FAQs](#faqs). :::info -Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executeable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). +Advanced users can configure multiple projects to use the same dbt Cloud CLI by placing the executable in the Program Files folder and [adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53). -Note that if you are using VS Code, you'll need to restart it to pick up modified environment variables. +Note that if you are using VS Code, you must restart it to pick up modified environment variables. ::: 3. Verify the installation by running `./dbt --help` from the command line. If the help text doesn't indicate that you're using the dbt Cloud CLI, make sure you've deactivated your pyenv or venv and don't have a version of dbt globally installed. @@ -73,7 +70,7 @@ Note that if you are using VS Code, you'll need to restart it to pick up modifie -If your operating system runs into path conflicts, refer to the [FAQs](#faqs). +Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. 1. Download the latest Linux release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). (Pick the file based on your CPU architecture) @@ -86,7 +83,7 @@ tar -xf dbt_0.29.9_linux_amd64.tar.gz :::info -Advanced users can configure multiple projects to use the same Cloud CLI executeable by adding it to their PATH environment variable in their shell profile. +Advanced users can configure multiple projects to use the same Cloud CLI executable by adding it to their PATH environment variable in their shell profile. ::: @@ -96,71 +93,24 @@ Advanced users can configure multiple projects to use the same Cloud CLI execute - ## Update dbt Cloud CLI The following instructions explain how to update the dbt CLoud CLI to the latest version depending on your operating system. During the public preview period, we recommend updating before filing a bug report. This is because the API is subject to breaking changes. -#### Update with Homebrew (MacOS) + + + To update the dbt Cloud CLI, run `brew upgrade dbt-cloud-cli`. -#### Update manually (Windows and Linux) -To update, follow the same process explained in [Install manually (Windows)](#install-manually-windows) and replace the existing `dbt.exe` executable with the new one. + + + +To update, follow the same process explained in [Install manually (Windows)](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one. + + + + ## Next steps @@ -175,6 +125,12 @@ dbt compile
    +What's the difference between the dbt Cloud CLI and dbt Core? +The dbt Cloud CLI and dbt Core, an open-source project, are both command line tools that enable you to run dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its features. + +
    + +
    How do I solve for path conflicts For compatibility, both the dbt Cloud CLI and dbt Core are invoked by running `dbt`. This can create path conflicts if your operating system selects one over the other based on your $PATH environment variable (settings). From fa36b4847ac806e521babfb9ababfe5c3ff9e125 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 11:16:40 +0100 Subject: [PATCH 101/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 94c10a7e4f8..0140f271f92 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -23,7 +23,6 @@ dbt commands are run against dbt Cloud's infrastructure and benefit from: * Support for dbt Mesh ([cross-project `ref`](/docs/collaborate/govern/project-dependencies)), * Significant platform improvements, to be released over the coming months. -The dbt Cloud CLI and [dbt Core](https://github.com/dbt-labs/dbt-core), an open-source project, are both command line tools that let you run your dbt projects and use the same dbt commands. The key difference is that the dbt Cloud CLI is designed to work specifically with dbt Cloud's infrastructure and integrates those builds with all [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-features). ## Install dbt Cloud CLI From fc0a3aae5303de6916988bec7443a5d5830f33d6 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 12:00:34 +0100 Subject: [PATCH 102/104] Update website/docs/docs/cloud/cloud-cli-installation.md --- website/docs/docs/cloud/cloud-cli-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index fc51a9aa94b..36ba1370ffb 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -55,7 +55,7 @@ Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. 1. Download the latest Windows release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). -2. Extract the `dbt.exe` executeable into the same folder as your dbt project. +2. Extract the `dbt.exe` executable into the same folder as your dbt project. :::info From b7ed745d5ce493c99f4a6967104a9ff4f048fbec Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Mon, 9 Oct 2023 13:34:35 +0100 Subject: [PATCH 103/104] Update cloud-cli-installation.md remove comment --- website/docs/docs/cloud/cloud-cli-installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/docs/cloud/cloud-cli-installation.md b/website/docs/docs/cloud/cloud-cli-installation.md index 0140f271f92..44d411bbf2d 100644 --- a/website/docs/docs/cloud/cloud-cli-installation.md +++ b/website/docs/docs/cloud/cloud-cli-installation.md @@ -77,7 +77,7 @@ Note that if you are using VS Code, you'll need to restart it to pick up modifie -If your operating system runs into path conflicts, refer to the [FAQs](#faqs). +Refer to the [FAQs](#faqs) if your operating system runs into path conflicts. 1. Download the latest Linux release for your platform from [GitHub](https://github.com/dbt-labs/dbt-cli/releases). (Pick the file based on your CPU architecture) @@ -146,7 +146,7 @@ Once you install the dbt Cloud CLI, you need to configure it to connect to a dbt export DBT_CLOUD_API_KEY="1234" # Replace 1234 with your API key ``` - - In Powershell, add an environment variable: IS THIS MISSING SOMETHING? + - In Powershell, add an environment variable: - Note that this variable resets if you restart your shell. To add an environment variable permanently, add a system environment variable in your platform. 3. Navigate to a dbt project in your terminal: From 9a399cb6e66c8076fbb2161d1ec1ad9a04803e89 Mon Sep 17 00:00:00 2001 From: mirnawong1 Date: Mon, 9 Oct 2023 16:12:58 +0100 Subject: [PATCH 104/104] update intro --- website/docs/reference/dbt-commands.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/website/docs/reference/dbt-commands.md b/website/docs/reference/dbt-commands.md index cf970129169..d62e3a678bc 100644 --- a/website/docs/reference/dbt-commands.md +++ b/website/docs/reference/dbt-commands.md @@ -2,11 +2,9 @@ title: "dbt Command reference" --- -so debug is for cli (dbt core) and dbt cancel and dbt reattach are for the cloud cli and NOT dbt core? or dbt core? (sorry i’m trying to be super clear here) - You can run dbt using the following tools: -- In dbt Cloud using the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) +- In you browser with the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) - On the command line interface using the [dbt Cloud CLI](/docs/cloud/cloud-cli-installation) or open-source [dbt Core](https://github.com/dbt-labs/dbt-core), both of which enable you to execute dbt commands. The key distinction is the dbt Cloud CLI is tailored for dbt Cloud's infrastructure and integrates with all its [features](/docs/cloud/about-cloud/dbt-cloud-features). The following sections outline the commands supported by dbt and their relevant flags. For information about selecting models on the command line, consult the docs on [Model selection syntax](/reference/node-selection/syntax).