Skip to content

Commit cfe751e

Browse files
authored
Nfiann-prerelease (#6502)
2 parents 64efb00 + 8cc5e88 commit cfe751e

File tree

1 file changed

+105
-0
lines changed

1 file changed

+105
-0
lines changed

website/docs/docs/core/pip-install.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,3 +154,108 @@ python -m pip install \
154154
```
155155

156156
Or, better yet, just install the package(s) you need!
157+
158+
<VersionBlock firstVersion="1.8">
159+
160+
### Installing prereleases
161+
162+
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.
163+
164+
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.
165+
166+
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.
167+
168+
To install prerelease versions of dbt Core and your adapter, use this command (replace `dbt-adapter-name` with your adapter)
169+
170+
```shell
171+
python3 -m pip install --pre dbt-core dbt-adapter-name
172+
```
173+
174+
For example, if you’re using Snowflake, you would use the command:
175+
176+
177+
```shell
178+
python3 -m pip install --pre dbt-core dbt-snowflake
179+
180+
```
181+
182+
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:
183+
184+
```shell
185+
dbt --version
186+
python3 -m venv .venv
187+
source .venv/bin/activate
188+
python3 -m pip install --upgrade pip
189+
python3 -m pip install --pre dbt-core dbt-adapter-name
190+
source .venv/bin/activate
191+
dbt --version
192+
```
193+
Note, this will also install any pre-releases of all dependencies.
194+
195+
#### Activate your virtual environment
196+
197+
To install or use packages within your virtual environment:
198+
199+
- 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.
200+
201+
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).
202+
203+
Select your operating system and run the following command to activate it:
204+
205+
<Expandable alt_header="Unix/macOS" >
206+
207+
1. Activate your virtual environment:
208+
209+
```shell
210+
source .venv/bin/activate
211+
which python
212+
.venv/bin/python
213+
214+
```
215+
2. Install the prerelease using the following command:
216+
217+
218+
```shell
219+
python3 -m pip install --pre dbt-core dbt-adapter-name
220+
source .venv/bin/activate
221+
dbt --version
222+
```
223+
224+
</Expandable>
225+
226+
<Expandable alt_header="Windows" >
227+
228+
1. Activate your virtual environment:
229+
230+
```shell
231+
.venv\Scripts\activate
232+
where python
233+
.venv\Scripts\python
234+
```
235+
236+
2. Install the prerelease using the following command:
237+
238+
```shell
239+
py -m pip install --pre dbt-core dbt-adapter-name
240+
.venv\Scripts\activate
241+
dbt --version
242+
```
243+
244+
</Expandable>
245+
246+
247+
</VersionBlock>
248+
249+
<VersionBlock lastVersion="1.7">
250+
251+
### Installing prereleases
252+
253+
`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`.
254+
255+
```shell
256+
python -m pip uninstall -y dbt-adapters
257+
python -m pip install --upgrade --pre dbt-core dbt-common dbt-adapters
258+
dbt --version
259+
```
260+
261+
</VersionBlock>

0 commit comments

Comments
 (0)