Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nfiann-prerelease #6502

Open
wants to merge 42 commits into
base: current
Choose a base branch
from
Open
Changes from 40 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
92c1d65
Added section to pip install doc for prerelease
nataliefiann Nov 13, 2024
62a91d5
Added a section to the Install with pip doc for Installing pre-releases
nataliefiann Nov 18, 2024
10c07c9
Added version block
nataliefiann Nov 18, 2024
8998396
Merge branch 'current' into nfiann-prerelease
mirnawong1 Nov 19, 2024
5a6f70f
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 19, 2024
3be97b9
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 19, 2024
301f7d0
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 19, 2024
1e5b5bb
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 28, 2024
d5bce3d
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 28, 2024
7d14815
Update website/docs/docs/core/pip-install.md
nataliefiann Nov 28, 2024
be5a954
Updated commands
nataliefiann Nov 29, 2024
566fe06
Merge branch 'current' into nfiann-prerelease
matthewshaver Dec 5, 2024
24e2f96
Merge branch 'current' into nfiann-prerelease
nataliefiann Dec 11, 2024
4e69098
Updated doc
nataliefiann Dec 13, 2024
a958413
Updated PR
nataliefiann Dec 16, 2024
73f24c1
Update website/docs/docs/core/pip-install.md
nataliefiann Dec 17, 2024
8e68a5c
Merge branch 'current' into nfiann-prerelease
mirnawong1 Dec 19, 2024
b777a21
Merge branch 'current' into nfiann-prerelease
nataliefiann Dec 23, 2024
83c6e82
Update website/docs/docs/core/pip-install.md
nataliefiann Dec 23, 2024
ef6c9fd
Updated steps to activate virtual environment
nataliefiann Dec 30, 2024
8142d5f
Merge branch 'nfiann-prerelease' of https://github.com/dbt-labs/docs.…
nataliefiann Dec 30, 2024
ea46b86
Merge branch 'current' into nfiann-prerelease
nataliefiann Dec 30, 2024
1a04088
Merge branch 'current' into nfiann-prerelease
mirnawong1 Jan 6, 2025
33864b0
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
e573e96
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
56a67d4
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
c720517
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
828fc0e
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
ddad530
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
5c72d28
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 6, 2025
b35623f
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
5d3c589
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
9793a44
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
79afd1e
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
0c21155
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
cf14e3e
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
0dd0d7a
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
f4098be
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
1d08ef2
Update website/docs/docs/core/pip-install.md
nataliefiann Jan 9, 2025
3a80f73
Update website/docs/docs/core/pip-install.md
runleonarun Jan 9, 2025
0e85bf2
Merge branch 'current' into nfiann-prerelease
runleonarun Jan 9, 2025
05e3dd2
Amended backticks
nataliefiann Jan 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions website/docs/docs/core/pip-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,3 +154,105 @@ python -m pip install \
```

Or, better yet, just install the package(s) you need!

<VersionBlock firstVersion="1.8">
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

### 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 &mdash; 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.

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)

```shell
python3 -m pip install --pre dbt-core dbt-adapter-name
````
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

For example, if you’re using Snowflake, you would use the command:


```shell
python3 -m pip install --pre dbt-core dbt-snowflake

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
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
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-adapter-name
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
source .venv/bin/activate
dbt --version
```
Note, this will also install any pre-releases of all dependencies.

nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
#### Activate 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.

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:

<Expandable alt_header="Unix/macOS" >
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

1. Activate your virtual environment:

```shell
source .venv/bin/activate
which python
.venv/bin/python

```
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved
2. Install the prerelease using the following command:


```shell
python3 -m pip install --pre dbt-core dbt-adapter-name
source .venv/bin/activate
dbt --version
```

</Expandable>

<Expandable alt_header="Windows" >

1. Activate your virtual environment:

```shell
.venv\Scripts\activate
where python
.venv\Scripts\python
```
2. Install the prerelease using the following command:
nataliefiann marked this conversation as resolved.
Show resolved Hide resolved

```shell
py -m pip install --pre dbt-core dbt-adapter-name
.venv\Scripts\activate
dbt --version
```

</Expandable>


</VersionBlock>

<VersionBlock lastVersion="1.7">

### Installing prereleases

`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`.
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved
dbeatty10 marked this conversation as resolved.
Show resolved Hide resolved

```shell
python -m pip uninstall -y dbt-adapters
python -m pip install --upgrade --pre dbt-core dbt-common dbt-adapters
dbt --version
```

</VersionBlock>
Loading