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 19 commits into
base: current
Choose a base branch
from
Open
Changes from 15 commits
Commits
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
103 changes: 103 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,106 @@ 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

### 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 &mdash; 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
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the key part, and it looks good 👍

python3 -m pip install --pre dbt-core dbt-adapter-name

Note: it will also install any pre-releases of all dependencies.

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
#### Install prereleases of dbt-adapters on different operating systems
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[custom.SentenceCaseHeaders] 'Install prereleases of dbt-adapters on different operating systems' should use sentence-style capitalization. Try 'Install prereleases of dbt adapters on different operating systems' instead.


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

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

```
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
py -m pip install --pre dbt-core dbt-adapter-name
.venv\Scripts\activate
dbt --version
```
2. Install the prerelease using the following command:

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

</Expandable>


</VersionBlock>

<VersionBlock lastVersion="1.7">

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.7'?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.8+'?


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

</VersionBlock>
Loading