Skip to content

Commit

Permalink
Moving adapter behavior changes (#6151)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

To reduce the risk of the behavior changes page becoming unwieldy, we're
moving the adapter-specific behavior changes to their own folder, so
each adapter's change will have its own page.

This is light on content now, with only a single adapter, but it is
expected to grow quickly.

## Checklist
- [ ] I have reviewed the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [ ] The topic I'm writing about is for specific dbt version(s) and I
have versioned it according to the [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and/or [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content)
guidelines.
- [ ] I have added checklist item(s) to this list for anything anything
that needs to happen before this PR is merged, such as "needs technical
review" or "change base branch."
<!--
PRE-RELEASE VERSION OF dbt (if so, uncomment):
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/docs/dbt-versions/core-upgrade)
-->
<!-- 
ADDING OR REMOVING PAGES (if so, uncomment):
- [ ] Add/remove page in `website/sidebars.js`
- [ ] Provide a unique filename for new pages
- [ ] Add an entry for deleted pages in `website/vercel.json`
- [ ] Run link testing locally with `npm run build` to update the links
that point to deleted pages
-->

---------

Co-authored-by: Ly Nguyen <[email protected]>
Co-authored-by: Leona B. Campbell <[email protected]>
  • Loading branch information
3 people authored Oct 2, 2024
1 parent 536b278 commit 29ceb1d
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 7 deletions.
23 changes: 23 additions & 0 deletions website/docs/reference/global-configs/adapter-behavior-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "About adapter-specific behavior changes"
id: "adapter-behavior-changes"
sidebar_label: "Adapter behavior changes"
description: "Adapter-specific behavior changes"
hide_table_of_contents: true
pagination_next: null
pagination_prev: null
---


Some adapters can display behavior changes when certain flags are enabled. The following sections contain details about these adapter-specific behavior changes.


<div className="grid--3-col">

<Card
title="Redshift"
body="Behavior changes for the Amazon Redshift adapter."
link="reference/global-configs/redshift-changes"
icon="redshift"/>

</div>
7 changes: 0 additions & 7 deletions website/docs/reference/global-configs/behavior-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,10 +129,3 @@ on-run-start:
```
</File>

## Adapter-specific behavior changes
Some adapters may show behavior changes when certain flags are enabled. Refer to the following sections for each respective adapter.
### [Redshift] restrict_direct_pg_catalog_access

Originally, the `dbt-redshift` adapter was built on top of the `dbt-postgres` adapter and used Postgres tables for metadata access. With this flag enabled, the adapter will use the Redshift API (through the Python client) if available, or query Redshift's `information_schema` tables instead of using `pg_` tables.

While we don't expect any user-noticeable behavior changes due to this change, out of caution we are gating it behind a behavior-change flag and encouraging users to test it before it becomes the default for everyone.
11 changes: 11 additions & 0 deletions website/docs/reference/global-configs/redshift-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Amazon Redshift adapter behavior changes"
id: "redshift-changes"
sidebar: "Redshift"
---

## The restrict_direct_pg_catalog_access flag

Originally, the `dbt-redshift` adapter was built on top of the `dbt-postgres` adapter and used Postgres tables for metadata access. When this flag is enabled, the adapter uses the Redshift API (through the Python client) if available, or queries Redshift's `information_schema` tables instead of using the `pg_` tables.

While you shouldn't notice any behavior changes due to this change, however, to be cautious dbt Labs is gating it behind a behavior-change flag and encouraging you to test it before it becoming the default.
8 changes: 8 additions & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1095,6 +1095,14 @@ const sidebarSettings = {
items: [
"reference/global-configs/about-global-configs",
"reference/global-configs/behavior-changes",
{ type: "category",
label: "Adapter behavior changes",
link: { type: "doc", id: "reference/global-configs/adapter-behavior-changes" },
items: [
"reference/global-configs/adapter-behavior-changes",
"reference/global-configs/redshift-changes",
],
},
{
type: "category",
label: "Setting flags",
Expand Down

0 comments on commit 29ceb1d

Please sign in to comment.