From 92c1d65060bb061ffb619cf03ceb65356ea4cc98 Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Wed, 13 Nov 2024 14:40:03 +0000 Subject: [PATCH 01/33] Added section to pip install doc for prerelease --- website/docs/docs/core/pip-install.md | 77 +++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 6d94d92a64b..ad604ed7777 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -154,3 +154,80 @@ python -m pip install \ ``` Or, better yet, just install the package(s) you need! + +### Install prereleases of dbt adapters + +To install prerelease versions of dbt Core and your adapter, use this command: + +```shell +python3 -m pip install --pre dbt-core dbt-adapter-name +```` +We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to activate and install your virtual environment. You’ll need to activate your virtual environment before you start installing or using packages in your virtual environment. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following command: + +```shell +dbt --version +python3 -m venv venv +source venv/bin/activate +python3 -m pip install --upgrade pip +python3 -m pip install --pre dbt-core dbt-adaptername +source venv/bin/activate +dbt --version +``` +For additional details on how to create a virtual Python environment, refer to ADD LINK TO YOUR NEW VIRTUAL ENV PAGE. + +#### Install prereleases on different operating systems + +To binstall or use packages within your virtual environment: + +- Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. You can run the following commands to activate your virtual environment. + +- Select your operating system to activate your virtual environment. + + + +```shell +source .venv/bin/activate +which python +.venv/bin/python +``` + +These commands will install the prerelease: + +```shell +python3 -m pip install --upgrade pip +python3 -m pip --version +pip 23.3.1 from .../.venv/lib/python3.9/site-packages (python 3.9) +``` + + + + + +```shell +.venv\Scripts\activate +where python +.venv\Scripts\python +``` +These commands will install the prerelease: + +```shell +py -m pip install --upgrade pip +py -m pip --version +pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4) +``` + + + +If you’re using a different operating system, refer to [Git issue on Instructions to create a python virtual environment](https://github.com/dbt-labs/docs.getdbt.com/discussions/2143) for more information. + + + +For dbt v1.7 or earlier, you can install prereleases using this command: + +```shell +python -m pip uninstall -y dbt-adapters +python -m pip install --upgrade dbt-core dbt-common dbt-adapters +dbt --version +``` + + \ No newline at end of file From 62a91d51730cfca95d8e3b334f50ed72dc71f606 Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Mon, 18 Nov 2024 16:04:50 -0500 Subject: [PATCH 02/33] Added a section to the Install with pip doc for Installing pre-releases --- website/docs/docs/core/pip-install.md | 16 ++-------------- 1 file changed, 2 insertions(+), 14 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index ad604ed7777..5a8ee529b7b 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -162,7 +162,7 @@ To install prerelease versions of dbt Core and your adapter, use this command: ```shell python3 -m pip install --pre dbt-core dbt-adapter-name ```` -We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to activate and install your virtual environment. You’ll need to activate your virtual environment before you start installing or using packages in your virtual environment. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following command: +We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to activate and install your virtual environment. You’ll need to activate your virtual environment before you start installing or using packages within it. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following command: ```shell dbt --version @@ -173,11 +173,10 @@ python3 -m pip install --pre dbt-core dbt-adaptername source venv/bin/activate dbt --version ``` -For additional details on how to create a virtual Python environment, refer to ADD LINK TO YOUR NEW VIRTUAL ENV PAGE. #### Install prereleases on different operating systems -To binstall or use packages within your virtual environment: +To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. You can run the following commands to activate your virtual environment. @@ -220,14 +219,3 @@ pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4) If you’re using a different operating system, refer to [Git issue on Instructions to create a python virtual environment](https://github.com/dbt-labs/docs.getdbt.com/discussions/2143) for more information. - - -For dbt v1.7 or earlier, you can install prereleases using this command: - -```shell -python -m pip uninstall -y dbt-adapters -python -m pip install --upgrade dbt-core dbt-common dbt-adapters -dbt --version -``` - - \ No newline at end of file From 10c07c9e64761b194313d4703ab94bec9014728d Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Mon, 18 Nov 2024 16:12:53 -0500 Subject: [PATCH 03/33] Added version block --- website/docs/docs/core/pip-install.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 5a8ee529b7b..fab700c5cf0 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -155,6 +155,8 @@ python -m pip install \ Or, better yet, just install the package(s) you need! + + ### Install prereleases of dbt adapters To install prerelease versions of dbt Core and your adapter, use this command: @@ -219,3 +221,4 @@ pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4) If you’re using a different operating system, refer to [Git issue on Instructions to create a python virtual environment](https://github.com/dbt-labs/docs.getdbt.com/discussions/2143) for more information. + \ No newline at end of file From 5a6f70f49941a5bab16cb5382b6109cea0d21515 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 19 Nov 2024 14:46:37 -0500 Subject: [PATCH 04/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index fab700c5cf0..9245563c0d9 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -171,7 +171,7 @@ dbt --version python3 -m venv venv source venv/bin/activate python3 -m pip install --upgrade pip -python3 -m pip install --pre dbt-core dbt-adaptername +python3 -m pip install --pre dbt-core dbt-adapter-name source venv/bin/activate dbt --version ``` From 3be97b91b4c71ff336580fb789f61eae09155b20 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 19 Nov 2024 14:47:03 -0500 Subject: [PATCH 05/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 9245563c0d9..c7e79d09355 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -180,7 +180,9 @@ dbt --version To install or use packages within your virtual environment: -- Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. You can run the following commands to activate your virtual environment. +- Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. + + Select your operating system and run the following commands to activate it: - Select your operating system to activate your virtual environment. From 301f7d025acabc4a5830ee61779c93ebd7c43ea6 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 19 Nov 2024 14:47:16 -0500 Subject: [PATCH 06/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index c7e79d09355..76cb0f261a6 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -184,7 +184,6 @@ To install or use packages within your virtual environment: Select your operating system and run the following commands to activate it: -- Select your operating system to activate your virtual environment. From 1e5b5bb219b76d01701421e3f3d9bc12b5403fff Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 28 Nov 2024 10:51:50 +0000 Subject: [PATCH 07/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 76cb0f261a6..0bcc159e009 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -164,7 +164,7 @@ To install prerelease versions of dbt Core and your adapter, use this command: ```shell python3 -m pip install --pre dbt-core dbt-adapter-name ```` -We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to activate and install your virtual environment. You’ll need to activate your virtual environment before you start installing or using packages within it. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following command: +We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to create your virtual environment, activate it, and install within it. You’ll need to activate your virtual environment before you start installing or using packages within it. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: ```shell dbt --version From d5bce3d578122448cb6bc43a0f635d471c0516bb Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 28 Nov 2024 10:54:21 +0000 Subject: [PATCH 08/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 0bcc159e009..04f1b37d116 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -164,7 +164,7 @@ To install prerelease versions of dbt Core and your adapter, use this command: ```shell python3 -m pip install --pre dbt-core dbt-adapter-name ```` -We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). You can run the commands to create your virtual environment, activate it, and install within it. You’ll need to activate your virtual environment before you start installing or using packages within it. For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: +We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: ```shell dbt --version From 7d14815c1cac8f2913e9b7aac1b79edf11f013af Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 28 Nov 2024 10:56:24 +0000 Subject: [PATCH 09/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 04f1b37d116..ed5f39ac262 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -175,7 +175,7 @@ python3 -m pip install --pre dbt-core dbt-adapter-name source venv/bin/activate dbt --version ``` - +Not, the command `python3 -m pip install --pre dbt-core dbt-adapter-name` will also install any pre-releases of all dependencies. #### Install prereleases on different operating systems To install or use packages within your virtual environment: From be5a9548a31e5e367ed0ecb21c2306c1739409c2 Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Fri, 29 Nov 2024 12:16:45 +0000 Subject: [PATCH 10/33] Updated commands --- website/docs/docs/core/pip-install.md | 73 ++++++++++++++++++++------- 1 file changed, 56 insertions(+), 17 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index ed5f39ac262..00dc7e56338 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -175,51 +175,90 @@ python3 -m pip install --pre dbt-core dbt-adapter-name source venv/bin/activate dbt --version ``` -Not, the command `python3 -m pip install --pre dbt-core dbt-adapter-name` will also install any pre-releases of all dependencies. +Note, this will also install any pre-releases of all dependencies. + #### Install prereleases on different operating systems To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. - Select your operating system and run the following commands to activate it: + Select your operating system and run the following command to activate it: ```shell +python3 -m pip install --pre dbt-core dbt-adapter-name source .venv/bin/activate -which python -.venv/bin/python +dbt --version ``` -These commands will install the prerelease: + + + ```shell -python3 -m pip install --upgrade pip -python3 -m pip --version -pip 23.3.1 from .../.venv/lib/python3.9/site-packages (python 3.9) +py -m pip install --pre dbt-core dbt-adapter-name +.venv\Scripts\activate +dbt --version ``` - + ```shell -.venv\Scripts\activate -where python -.venv\Scripts\python +python3 -m pip install --pre dbt-core dbt-adapter-name +source venv/bin/activate +dbt --version ``` -These commands will install the prerelease: + + + + ```shell -py -m pip install --upgrade pip -py -m pip --version -pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4) +python3 -m pip install --pre dbt-core dbt-adapter-name +source venv/bin/activate.fish ``` -If you’re using a different operating system, refer to [Git issue on Instructions to create a python virtual environment](https://github.com/dbt-labs/docs.getdbt.com/discussions/2143) for more information. + + +```shell +python3 -m pip install --pre dbt-core dbt-adapter-name +source venv/bin/activate.csh +``` + + + + + +```shell +python3 -m pip install --pre dbt-core dbt-adapter-name +venv/bin/Activate.ps1 +``` + + + + + +```shell +python -m pip install --pre dbt-core dbt-adapter-name +venv\Scripts\activate.bat +``` + + + + + +```shell +python -m pip install --pre dbt-core dbt-adapter-name +venv\Scripts\Activate.ps1 +``` + + \ No newline at end of file From 4e690981dee1ed3db582302166ad98b201f8256b Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Fri, 13 Dec 2024 15:10:16 +0000 Subject: [PATCH 11/33] Updated doc --- website/docs/docs/core/pip-install.md | 83 +++++++++++---------------- 1 file changed, 35 insertions(+), 48 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 00dc7e56338..cc570ec0025 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -159,11 +159,25 @@ Or, better yet, just install the package(s) you need! ### Install prereleases of dbt adapters +A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality. + +Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. Innovation opportunities — leverage new features to improve your work and stay competitive. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. + +Prereleases also have some drawbacks such as performance issues as they may not be fully optimized, potentially resulting in slower performance or inefficiency. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. + To install prerelease versions of dbt Core and your adapter, use this command: ```shell python3 -m pip install --pre dbt-core dbt-adapter-name ```` + +For example, if you’re using Snowflake, you would use the command: + + +```shell +python3 -m pip install --pre dbt-core dbt-snowflake +```` + We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: ```shell @@ -183,11 +197,23 @@ To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. - Select your operating system and run the following command to activate it: +For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) +Select your operating system and run the following command to activate it: +1. Activate your virtual environment: + +```shell +source .venv/bin/activate +which python +venv/bin/python + + ``` + 2. Install the prerelease using the following command: + + ```shell python3 -m pip install --pre dbt-core dbt-adapter-name source .venv/bin/activate @@ -198,67 +224,28 @@ dbt --version +1. Activate your virtual environment: + ```shell py -m pip install --pre dbt-core dbt-adapter-name .venv\Scripts\activate dbt --version ``` - - - - +2. Install the prerelease using the following command: ```shell -python3 -m pip install --pre dbt-core dbt-adapter-name -source venv/bin/activate +py -m pip install --pre dbt-core dbt-adapter-name +.venv\Scripts\activate dbt --version ``` - - -```shell -python3 -m pip install --pre dbt-core dbt-adapter-name -source venv/bin/activate.fish -``` - - - - -```shell -python3 -m pip install --pre dbt-core dbt-adapter-name -source venv/bin/activate.csh -``` - - - - - -```shell -python3 -m pip install --pre dbt-core dbt-adapter-name -venv/bin/Activate.ps1 -``` - - - - - -```shell -python -m pip install --pre dbt-core dbt-adapter-name -venv\Scripts\activate.bat -``` - - - - + -```shell -python -m pip install --pre dbt-core dbt-adapter-name -venv\Scripts\Activate.ps1 -``` + - +hello \ No newline at end of file From a9584133e4aa12957ff6ecb779490afc2dac98cb Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Mon, 16 Dec 2024 10:40:26 +0000 Subject: [PATCH 12/33] Updated PR --- website/docs/docs/core/pip-install.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index cc570ec0025..b3c46001197 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -157,7 +157,7 @@ Or, better yet, just install the package(s) you need! -### Install prereleases of dbt adapters +### Install prereleases of dbt-adapters A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality. @@ -191,7 +191,7 @@ dbt --version ``` Note, this will also install any pre-releases of all dependencies. -#### Install prereleases on different operating systems +#### Install prereleases of dbt-adapters on different operating systems To install or use packages within your virtual environment: @@ -246,6 +246,14 @@ dbt --version -hello +### Install prereleases of dbt-adapters + +dbt-adapters are only compatible with dbt Core 1.8+. If you are on dbt Core v1.7 or below, follow the steps to upgrade to v1.8+ to install prereleases of dbt-adapters. + +```shell +python -m pip uninstall -y dbt-adapters +python -m pip install --upgrade dbt-core dbt-common dbt-adapters +dbt --version +``` \ No newline at end of file From 73f24c16b4d7854794b228b86d2e31cac225eaf2 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 17 Dec 2024 14:25:54 +0000 Subject: [PATCH 13/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index b3c46001197..9462fee61eb 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -197,7 +197,7 @@ To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. -For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) +For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) and [Create a Python Virtual Environment](/docs/core/create-a-python-virtual-environment). Select your operating system and run the following command to activate it: From 83c6e82fcd0c568cf384ad98c5d50c6208be125c Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 23 Dec 2024 10:51:49 +0000 Subject: [PATCH 14/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 7a386ae080f..11563390dea 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -197,7 +197,7 @@ To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. -For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) and [Create a Python Virtual Environment](/docs/core/create-a-python-virtual-environment). +For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) and [Create a Python virtual environment](/docs/core/create-a-python-virtual-environment). Select your operating system and run the following command to activate it: From ef6c9fd532590d9359342ad772c0d0fcc4be709b Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Mon, 30 Dec 2024 16:20:01 +0000 Subject: [PATCH 15/33] Updated steps to activate virtual environment --- website/docs/docs/core/pip-install.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index b3c46001197..317ad174bec 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -227,10 +227,11 @@ dbt --version 1. Activate your virtual environment: ```shell -py -m pip install --pre dbt-core dbt-adapter-name -.venv\Scripts\activate -dbt --version -``` +env\Scripts\activate +where python +env\Scripts\python + + ``` 2. Install the prerelease using the following command: ```shell From 33864b026f9205bcade05f798afcd0c8d3fe52b9 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:45:55 +0000 Subject: [PATCH 16/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 3bbf89d1b0a..f8e7f376dee 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -159,7 +159,7 @@ Or, better yet, just install the package(s) you need! ### Install prereleases of dbt-adapters -A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality. +A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality — ensuring your system will be ready for the final release. Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. Innovation opportunities — leverage new features to improve your work and stay competitive. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. From e573e96c65424bb0a587139e49aedb94426a5806 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:47:02 +0000 Subject: [PATCH 17/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index f8e7f376dee..29fc02a8ad2 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -161,7 +161,7 @@ Or, better yet, just install the package(s) you need! A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality — ensuring your system will be ready for the final release. -Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. Innovation opportunities — leverage new features to improve your work and stay competitive. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. +Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. Prereleases also have some drawbacks such as performance issues as they may not be fully optimized, potentially resulting in slower performance or inefficiency. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. From 56a67d4914abc2d8a78ff6ab5a7c9ee07deecf94 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:47:24 +0000 Subject: [PATCH 18/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 29fc02a8ad2..5ea70feaefb 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -163,7 +163,7 @@ A prerelease adapter is a version released before the final, stable version. It Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. -Prereleases also have some drawbacks such as performance issues as they may not be fully optimized, potentially resulting in slower performance or inefficiency. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. +Note that using a prerelease version before the final, stable version means the version isn't fully optimized and can result in unexpected behavior. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. To install prerelease versions of dbt Core and your adapter, use this command: From c720517ba3af51d556e5c57ec3dfd8303052a0c3 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:47:42 +0000 Subject: [PATCH 19/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 5ea70feaefb..5faf39a481f 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -165,7 +165,7 @@ Using a prerelease of an adapter has many benefits such as granting you early ac Note that using a prerelease version before the final, stable version means the version isn't fully optimized and can result in unexpected behavior. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. -To install prerelease versions of dbt Core and your adapter, use this command: +To install prerelease versions of dbt Core and your adapter, use this command (replace `dbt-adapter-name` with your adapter) ```shell python3 -m pip install --pre dbt-core dbt-adapter-name From 828fc0edacfd2a58e21529f1ef3736739d4679ef Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:48:14 +0000 Subject: [PATCH 20/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 5faf39a481f..ca7b911bad0 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -249,7 +249,7 @@ dbt --version ### Install prereleases of dbt-adapters -dbt-adapters are only compatible with dbt Core 1.8+. If you are on dbt Core v1.7 or below, follow the steps to upgrade to v1.8+ to install prereleases of dbt-adapters. +dbt-adapters are only compatible with dbt Core 1.8 and higher. If you're on dbt Core v1.7 or lower, follow these steps to upgrade to v1.8 or higher to install prereleases of dbt-adapters. ```shell python -m pip uninstall -y dbt-adapters From ddad5303d950d54fa2100d49e14a525dc3346a34 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 12:50:37 +0000 Subject: [PATCH 21/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index ca7b911bad0..095a7781bd0 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -197,7 +197,7 @@ To install or use packages within your virtual environment: - Activate the virtual environment to add its specific Python and `pip` executables to your shell’s PATH. This ensures you use the environment’s isolated setup. -For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) and [Create a Python virtual environment](/docs/core/create-a-python-virtual-environment). +For more information, refer to [Create and use virtual environments](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments). Select your operating system and run the following command to activate it: From 5c72d281f54cfeac1460c2e47869029f575082a6 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 6 Jan 2025 13:51:57 +0000 Subject: [PATCH 22/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 095a7781bd0..e48b2225c3a 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -191,7 +191,7 @@ dbt --version ``` Note, this will also install any pre-releases of all dependencies. -#### Install prereleases of dbt-adapters on different operating systems +#### Activate your virtual environment To install or use packages within your virtual environment: From b35623f1dc0b552ca9f3c20dcc813716719f08bc Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:04:48 +0000 Subject: [PATCH 23/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index e48b2225c3a..643ab4a2325 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -157,7 +157,7 @@ Or, better yet, just install the package(s) you need! -### Install prereleases of dbt-adapters +### Installing prereleases A prerelease adapter is a version released before the final, stable version. It allows users to test new features, provide feedback, and get early access to upcoming functionality — ensuring your system will be ready for the final release. From 5d3c5896bbb9703002b24ba89441bf36b6eba1c6 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:06:10 +0000 Subject: [PATCH 24/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 643ab4a2325..2a5c18a1173 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -182,11 +182,11 @@ We recommend you install prereleases in a [virtual Python environment](https://p ```shell dbt --version -python3 -m venv venv -source venv/bin/activate +python3 -m venv .venv +source .venv/bin/activate python3 -m pip install --upgrade pip python3 -m pip install --pre dbt-core dbt-adapter-name -source venv/bin/activate +source .venv/bin/activate dbt --version ``` Note, this will also install any pre-releases of all dependencies. From 9793a446c36074ae10bb2ede5e0a9978a110ad6e Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:06:28 +0000 Subject: [PATCH 25/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 2a5c18a1173..8dea187e10d 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -208,7 +208,7 @@ Select your operating system and run the following command to activate it: ```shell source .venv/bin/activate which python -venv/bin/python +.venv/bin/python ``` 2. Install the prerelease using the following command: From 79afd1e8e3eb76dc9a96306af89caeaab591b9e7 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:06:38 +0000 Subject: [PATCH 26/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 8dea187e10d..b71efedac82 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -227,10 +227,9 @@ dbt --version 1. Activate your virtual environment: ```shell -env\Scripts\activate +.venv\Scripts\activate where python -env\Scripts\python - +.venv\Scripts\python ``` 2. Install the prerelease using the following command: From 0c211554ef45097da2da60b0659e0387a0c8cf83 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:14:04 +0000 Subject: [PATCH 27/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index b71efedac82..cc77df69e9d 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -163,7 +163,7 @@ A prerelease adapter is a version released before the final, stable version. It Using a prerelease of an adapter has many benefits such as granting you early access to new features and improvements ahead of the stable release. As well as compatibility testing, allowing you to test the adapter in your environment to catch integration issues early, ensuring your system will be ready for the final release. -Note that using a prerelease version before the final, stable version means the version isn't fully optimized and can result in unexpected behavior. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. +Note that using a prerelease version before the final, stable version means the version isn't fully optimized and can result in unexpected behavior. Additionally, frequent updates and patches during the prerelease phase may require extra time and effort to maintain. Furthermore, the `--pre flag` may install compatible prerelease versions of other dependencies, which could introduce additional instability. To install prerelease versions of dbt Core and your adapter, use this command (replace `dbt-adapter-name` with your adapter) From cf14e3ee11069c5f0f3ffbc2504ab30856de154e Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:16:20 +0000 Subject: [PATCH 28/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index cc77df69e9d..f735f0c593f 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -246,7 +246,7 @@ dbt --version -### Install prereleases of dbt-adapters +### Install prereleases dbt-adapters are only compatible with dbt Core 1.8 and higher. If you're on dbt Core v1.7 or lower, follow these steps to upgrade to v1.8 or higher to install prereleases of dbt-adapters. From 0dd0d7a97fe01647c40ad149941187ebef6f4175 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:33:57 +0000 Subject: [PATCH 29/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index f735f0c593f..96b52be8317 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -246,7 +246,7 @@ dbt --version -### Install prereleases +### Installing prereleases dbt-adapters are only compatible with dbt Core 1.8 and higher. If you're on dbt Core v1.7 or lower, follow these steps to upgrade to v1.8 or higher to install prereleases of dbt-adapters. From f4098bea4ce44676137bd1432b0c8704745357bd Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:36:33 +0000 Subject: [PATCH 30/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 96b52be8317..510be5a4b79 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -252,7 +252,7 @@ dbt-adapters are only compatible with dbt Core 1.8 and higher. If you're on dbt ```shell python -m pip uninstall -y dbt-adapters -python -m pip install --upgrade dbt-core dbt-common dbt-adapters +python -m pip install --upgrade --pre dbt-core dbt-common dbt-adapters dbt --version ``` From 1d08ef2de7dc0b5aef75e67152c0b766aa79ceaf Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Thu, 9 Jan 2025 20:36:43 +0000 Subject: [PATCH 31/33] Update website/docs/docs/core/pip-install.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/docs/core/pip-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index 510be5a4b79..d6ea9c8eab6 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -248,7 +248,7 @@ dbt --version ### Installing prereleases -dbt-adapters are only compatible with dbt Core 1.8 and higher. If you're on dbt Core v1.7 or lower, follow these steps to upgrade to v1.8 or higher to install prereleases of dbt-adapters. +`dbt-adapters` is only compatible with dbt Core 1.8 and higher. If you're on dbt Core v1.7 or lower, follow these steps to upgrade to v1.8 or higher to install prereleases of `dbt-adapters`. ```shell python -m pip uninstall -y dbt-adapters From 3a80f739b3ff8469421086544dd577c8b4d610a1 Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Thu, 9 Jan 2025 13:12:07 -0800 Subject: [PATCH 32/33] Update website/docs/docs/core/pip-install.md --- website/docs/docs/core/pip-install.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index d6ea9c8eab6..b3458ea9fee 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -176,7 +176,6 @@ For example, if you’re using Snowflake, you would use the command: ```shell python3 -m pip install --pre dbt-core dbt-snowflake -```` We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: From 05e3dd25e6a8722e8f2d187a5ed6cca59e1d430d Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Thu, 9 Jan 2025 21:44:01 +0000 Subject: [PATCH 33/33] Amended backticks --- website/docs/docs/core/pip-install.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/core/pip-install.md b/website/docs/docs/core/pip-install.md index b3458ea9fee..6ed9ca06f8e 100644 --- a/website/docs/docs/core/pip-install.md +++ b/website/docs/docs/core/pip-install.md @@ -169,7 +169,7 @@ To install prerelease versions of dbt Core and your adapter, use this command (r ```shell python3 -m pip install --pre dbt-core dbt-adapter-name -```` +``` For example, if you’re using Snowflake, you would use the command: @@ -177,6 +177,8 @@ For example, if you’re using Snowflake, you would use the command: ```shell python3 -m pip install --pre dbt-core dbt-snowflake +``` + We recommend you install prereleases in a [virtual Python environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/). For example, to install a prerelease in a `POSIX bash`/`zsh` virtual Python environment, use the following commands: ```shell @@ -209,7 +211,7 @@ source .venv/bin/activate which python .venv/bin/python - ``` +``` 2. Install the prerelease using the following command: @@ -229,7 +231,8 @@ dbt --version .venv\Scripts\activate where python .venv\Scripts\python - ``` +``` + 2. Install the prerelease using the following command: ```shell