Skip to content

Commit 53143f1

Browse files
committed
Merge branch 'log-size-limits' of github.com:dbt-labs/docs.getdbt.com into log-size-limits
2 parents 4d952a4 + 042150e commit 53143f1

File tree

11 files changed

+162
-77
lines changed

11 files changed

+162
-77
lines changed

website/constants.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export const CONSTANTS = {
1414
fusion: 'Fusion',
1515
fusion_engine: 'dbt Fusion Engine',
1616
dbt: 'dbt',
17-
cloud_cli: 'Cloud CLI',
17+
cloud_cli: 'dbt CLI',
1818
explorer: 'Catalog',
1919
visual_editor: 'Canvas',
2020
query_page: 'Insights',

website/docs/docs/build/incremental-strategy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Click the name of the adapter in the following table for more information about
3434
| [dbt-redshift](/reference/resource-configs/redshift-configs#incremental-materialization-strategies) |||| ||
3535
| [dbt-bigquery](/reference/resource-configs/bigquery-configs#merge-behavior-incremental-models) | || |||
3636
| [dbt-spark](/reference/resource-configs/spark-configs#incremental-models) ||| |||
37-
| [dbt-databricks](/reference/resource-configs/databricks-configs#incremental-models) ||| |||
37+
| [dbt-databricks](/reference/resource-configs/databricks-configs#incremental-models) ||| |||
3838
| [dbt-snowflake](/reference/resource-configs/snowflake-configs#merge-behavior-incremental-models) ||||||
3939
| [dbt-trino](/reference/resource-configs/trino-configs#incremental) |||| ||
4040
| [dbt-fabric](/reference/resource-configs/fabric-configs#incremental) |||| | |

website/docs/docs/build/latest-metrics-spec.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ The latest Semantic Layer specification creates an open standard for defining me
1212
With the new spec, you get simpler configuration without losing flexibility, faster onboarding for new contributors, and a clearer path to consistent, governed metrics across your organization.
1313

1414
:::info Availability
15-
The new YAML spec is currently only available in the <Constant name="fusion_engine" />, and will be coming soon to the <Constant name="dbt_platform" /> **Latest** release track and <Constant name="core" /> v1.12 (coming in 1H 2026).
15+
The new YAML spec is currently only available in the <Constant name="fusion_engine" />, and will be coming soon to the <Constant name="dbt_platform" /> **Latest** release track and <Constant name="core" /> v1.12.
16+
17+
For more information about availability, reach out to your account manager or post in the [#dbt-semantic-layer](https://getdbt.slack.com/archives/C046L0VTVR6) channel in the [dbt Community Slack](https://www.getdbt.com/community/join-the-community/).
1618
:::
1719

1820
## Changes in the latest spec

website/docs/docs/cloud/cloud-cli-installation.md

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,23 @@
22
title: Install dbt CLI
33
sidebar_label: "Installation"
44
id: cloud-cli-installation
5-
description: "Instructions for installing and configuring dbt CLI"
5+
description: "Instructions for installing and configuring dbt platform's CLI tool."
66
pagination_next: "docs/cloud/configure-cloud-cli"
77
---
88

9-
<Constant name="cloud" /> natively supports developing using a command line (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The <Constant name="cloud" /> CLI allows you to run dbt commands against your <Constant name="cloud" /> development environment from your local command line.
9+
import LongSession from '/snippets/_long-sessions-cli.md';
1010

11-
dbt commands are run against <Constant name="cloud" />'s infrastructure and benefit from:
11+
The <Constant name="dbt_platform" /> natively supports developing using a command line interface (CLI), empowering team members to contribute with enhanced flexibility and collaboration. The dbt CLI allows you to run dbt commands against your <Constant name="dbt_platform" /> development environment from your local command line.
1212

13-
* Secure credential storage in the <Constant name="cloud" /> platform
13+
:::note CLI compatibility
14+
15+
The dbt CLI is a <Constant name="dbt_platform" /> tool available to users on any [available plan](https://www.getdbt.com/pricing). It is not compatible with existing installations of the <Constant name="core" /> or <Constant name="fusion_engine" /> CLIs.
16+
17+
:::
18+
19+
dbt commands run against the platform's infrastructure and benefit from:
20+
21+
* Secure credential storage in the <Constant name="dbt_platform" />
1422
* [Automatic deferral](/docs/cloud/about-cloud-develop-defer) of build artifacts to your Cloud project's production environment
1523
* Speedier, lower-cost builds
1624
* Support for dbt Mesh ([cross-project `ref`](/docs/mesh/govern/project-dependencies))
@@ -19,18 +27,11 @@ dbt commands are run against <Constant name="cloud" />'s infrastructure and bene
1927
<Lightbox src="/img/docs/dbt-cloud/cloud-cli-overview.jpg" title="Diagram of how the dbt CLI works with dbt's infrastructure to run dbt commands from your local command line." />
2028

2129
## Prerequisites
22-
The <Constant name="cloud" /> CLI is available in all [deployment regions](/docs/cloud/about-cloud/access-regions-ip-addresses) and for both multi-tenant and single-tenant accounts.
30+
The <Constant name="cloud_CLI" /> is available in all [deployment regions](/docs/cloud/about-cloud/access-regions-ip-addresses) and for both multi-tenant and single-tenant accounts.
2331

2432
## Install dbt CLI
2533

26-
You can install the <Constant name="cloud" /> CLI on the command line by using one of these methods.
27-
28-
<details>
29-
<summary>View a video tutorial for a step-by-step guide to installation.</summary>
30-
31-
<LoomVideo id="dd80828306c5432a996d4580135041b6?sid=fe1895b7-1281-4e42-9968-5f7d11768000"/>
32-
33-
</details>
34+
You can install the <Constant name="cloud_cli" /> via the command line by using one of the following methods:
3435

3536
<Tabs queryString="install">
3637

@@ -68,14 +69,14 @@ pip uninstall dbt
6869
```
6970
If you have multiple taps, use `brew install dbt-labs/dbt-cli/dbt`.
7071

71-
3. Verify your installation by running `dbt --help` in the command line. If you see the following output, your installation is correct:
72+
3. Verify your installation by running `dbt --help` in the command line. If you see the following output, you installed it correctly:
7273
```bash
7374
The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...
7475
```
7576
7677
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
7778
78-
* Note that you no longer need to run the `dbt deps` command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
79+
* Note that you no longer need to run the `dbt deps` command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
7980
8081
4. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
8182
@@ -93,7 +94,7 @@ Refer to the [FAQs](#faqs) if your operating system runs into path conflicts.
9394
9495
:::info
9596
96-
Advanced users can configure multiple projects to use the same <Constant name="cloud" /> CLI by:
97+
Advanced users can configure multiple projects to use the same <Constant name="cloud_cli" /> by:
9798
9899
1. Placing the executable file (`.exe`) in the "Program Files" folder
99100
2. [Adding it to their Windows PATH environment variable](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53)
@@ -102,14 +103,14 @@ Advanced users can configure multiple projects to use the same <Constant name="c
102103
Note that if you're using VS Code, you must restart it to pick up modified environment variables.
103104
:::
104105
105-
4. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct:
106+
4. Verify your installation by running `./dbt --help` in the command line. If you see the following output, you installed it correctly:
106107
```bash
107108
The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...
108109
```
109110
110111
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
111112
112-
* Note that you no longer need to run the `dbt deps` command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
113+
* Note that you no longer need to run the `dbt deps` command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
113114
114115
5. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
115116
@@ -136,14 +137,14 @@ Advanced users can configure multiple projects to use the same dbt CLI executabl
136137
137138
:::
138139
139-
3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, your installation is correct:
140+
3. Verify your installation by running `./dbt --help` in the command line. If you see the following output, you installed it correctly:
140141
```bash
141142
The dbt CLI - an ELT tool for running SQL transformations and data models in dbt...
142143
```
143144
144145
If you don't see this output, check that you've deactivated pyenv or venv and don't have a global dbt version installed.
145146
146-
* Note that you no longer need to run the `dbt deps` command when your environment starts. This step was previously required during initialization. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
147+
* Note that you no longer need to run the `dbt deps` command when your environment starts. Previously, initialization required this step. However, you should still run `dbt deps` if you make any changes to your `packages.yml` file.
147148
148149
4. Clone your repository to your local computer using `git clone`. For example, to clone a GitHub repo using HTTPS format, run `git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY`.
149150
@@ -168,7 +169,7 @@ If you already have dbt Core installed, the <Constant name="cloud_cli" /> may co
168169
169170
--------
170171
171-
Before installing the <Constant name="cloud_cli" />, make sure you have Python installed and your virtual environment venv or pyenv . If you already have a Python environment configured, you can skip to the [pip installation step](#install-dbt-cloud-cli-in-pip).
172+
Before installing the <Constant name="cloud_cli" />, make sure you have Python installed and your virtual environment (venv or pyenv) configured. If you already have a Python environment configured, you can skip to the [pip installation step](#install-dbt-cloud-cli-in-pip).
172173
173174
### Install a virtual environment
174175
@@ -197,7 +198,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`.
197198
dbt --version
198199
```
199200
200-
2. Make sure you're in your virtual environment and run the following command to install the <Constant name="cloud" /> CLI:
201+
2. Make sure you're in your virtual environment and run the following command to install the <Constant name="cloud_cli" />:
201202
202203
```bash
203204
pip install dbt --no-cache-dir
@@ -208,7 +209,7 @@ We recommend using virtual environments (venv) to namespace `cloud-cli`.
208209
pip install dbt --no-cache-dir --force-reinstall
209210
```
210211
211-
3. (Optional) To revert to <Constant name="core" />, first uninstall both the <Constant name="cloud" /> CLI and <Constant name="core" />. Then reinstall <Constant name="core" />.
212+
3. (Optional) To revert to <Constant name="core" />, first uninstall both the <Constant name="cloud_cli" /> and <Constant name="core" />. Then reinstall <Constant name="core" />.
212213
213214
```bash
214215
pip uninstall dbt-core dbt
@@ -233,19 +234,19 @@ The following instructions explain how to update the <Constant name="cloud_cli"
233234
234235
<TabItem value="mac" label="macOS (brew)">
235236
236-
To update the <Constant name="cloud_cli" /> run `brew update` and then `brew upgrade dbt`.
237+
To update the <Constant name="cloud_cli" />, run `brew update` and then `brew upgrade dbt`.
237238
238239
</TabItem>
239240
240241
<TabItem value="windows" label="Windows (executable)">
241242
242-
To update, follow the same process explained in [Windows](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one.
243+
To update, follow the [Windows installation instructions](/docs/cloud/cloud-cli-installation?install=windows#install-dbt-cloud-cli) and replace the existing `dbt.exe` executable with the new one.
243244
244245
</TabItem>
245246
246247
<TabItem value="linux" label="Linux (executable)">
247248
248-
To update, follow the same process explained in [Linux](/docs/cloud/cloud-cli-installation?install=linux#install-dbt-cloud-cli) and replace the existing `dbt` executable with the new one.
249+
To update, follow the [Linux installation instructions](/docs/cloud/cloud-cli-installation?install=linux#install-dbt-cloud-cli) and replace the existing `dbt` executable with the new one.
249250
250251
</TabItem>
251252
@@ -272,7 +273,7 @@ import CloudCliRelativePath from '/snippets/_cloud-cli-relative-path.md';
272273
273274
The <Constant name="cloud_cli" /> and <a href="https://github.com/dbt-labs/dbt-core">dbt Core</a>, an open-source project, are both command line tools that enable you to run dbt commands.
274275
275-
The key distinction is the <Constant name="cloud_cli" /> is tailored for <Constant name="cloud" />'s infrastructure and integrates with all its <a href="https://docs.getdbt.com/docs/cloud/about-cloud/dbt-cloud-features">features</a>.
276+
The key distinction is that the <Constant name="cloud_cli" /> is tailored for the <Constant name="dbt_platform" />'s infrastructure and integrates with all its <a href="https://docs.getdbt.com/docs/cloud/about-cloud/dbt-cloud-features">features</a>.
276277
277278
</DetailsToggle>
278279
@@ -314,9 +315,13 @@ This alias will allow you to use the <code>dbt-cloud</code> command to invoke th
314315
315316
<DetailsToggle alt_header="Why am I receiving a `Stuck session` error when trying to run a new command?">
316317
317-
The<Constant name="cloud_cli" /> allows only one command that writes to the data warehouse at a time. If you attempt to run multiple write commands simultaneously (for example, `dbt run` and `dbt build`), you will encounter a `stuck session` error. To resolve this, cancel the specific invocation by passing its ID to the cancel command. For more information, refer to [parallel execution](/reference/dbt-commands#parallel-execution).
318+
The <Constant name="cloud_cli" /> allows only one command that writes to the data warehouse at a time. If you attempt to run multiple write commands simultaneously (for example, `dbt run` and `dbt build`), you will encounter a `stuck session` error. To resolve this, cancel the specific invocation by passing its ID to the cancel command. For more information, refer to [parallel execution](/reference/dbt-commands#parallel-execution).
318319
319320
</DetailsToggle>
320321
321-
<FAQ path="Troubleshooting/long-sessions-cloud-cli" />
322+
<DetailsToggle alt_header="I'm getting a `Session occupied` error in dbt CLI?">
323+
324+
<LongSession />
325+
326+
</DetailsToggle>
322327

0 commit comments

Comments
 (0)