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.

Sign up for GitHub

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

Initial docs for new adapter testing framework #1263

Merged
merged 8 commits into from
Apr 8, 2022
Merged

Initial docs for new adapter testing framework #1263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cc2b4b9
Initial docs for new adapter testing framework
jtcohen6 Mar 22, 2022
cb4e4cc
Show deprecation info always
jtcohen6 Mar 24, 2022
98d7e0d
PR feedback
jtcohen6 Mar 26, 2022
32cde1f
Self review
jtcohen6 Mar 29, 2022
066ad02
Small feedback
jtcohen6 Apr 5, 2022
b32365a
PR feedback
jtcohen6 Apr 7, 2022
e510dc7
Update migration guide
jtcohen6 Apr 7, 2022
a4b63a6
While here: add unique_key note to mig guide
jtcohen6 Apr 8, 2022
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
16 changes: 12 additions & 4 deletions website/dbt-versions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ exports.versions = [
EOLDate: "2023-04-27", // TODO estimated for now
isPrerelease: true
},
{
version: "1.1",
EOLDate: "2024-5-01"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

TBD based on final release date

},
{
version: "1.0",
EOLDate: "2023-12-03"
Expand All @@ -19,8 +23,12 @@ exports.versions = [
]

exports.versionedPages = [
{
"page": "docs/guides/migration-guide/upgrading-to-v1.1",
"firstVersion": "1.1",
}
{
"page": "docs/contributing/testing-a-new-adapter",
"firstVersion": "1.1",
},
{
"page": "docs/guides/migration-guide/upgrading-to-v1.1",
"firstVersion": "1.1",
}
]
4 changes: 2 additions & 2 deletions website/docs/docs/contributing/building-a-new-adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,13 +347,13 @@ See examples:

#### `__version__.py`

To assure that `dbt --version` provides the latest dbt core version the adapter supports, be sure include a `__version__.py` file. The filepath will be `dbt/adapters/<adapter_name>/__version__.py`. We recommend using the latest dbt core version and as the adapter is made compatiable with later versions, this file will need to be updated. For a sample file, check out this [example](https://github.com/dbt-labs/dbt-core/blob/develop/plugins/snowflake/dbt/adapters/snowflake/__version__.py).
To assure that `dbt --version` provides the latest dbt core version the adapter supports, be sure include a `__version__.py` file. The filepath will be `dbt/adapters/<adapter_name>/__version__.py`. We recommend using the latest dbt core version and as the adapter is made compatible with later versions, this file will need to be updated. For a sample file, check out this [example](https://github.com/dbt-labs/dbt-core/blob/develop/plugins/snowflake/dbt/adapters/snowflake/__version__.py).

It should be noted that both of these files are included in the bootstrapped output of the `create_adapter_plugins.py` so when using that script, these files will be included.

### Testing your new adapter

You can use a pre-configured [dbt adapter test suite](https://github.com/dbt-labs/dbt-adapter-tests) to test that your new adapter works. These tests include much of dbt's basic functionality, with the option to override or disable functionality that may not be supported on your adapter.
This has moved to its own page: ["Testing a new adapter"](testing-a-new-adapter)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yay! Do we need to version the old paragraph for versions below 1.1?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good callout:

  • The target audience here is developers of adapter integrations, not most dbt end users. I wouldn't expect anyone building a new adapter to build it for any versions older than the latest.
  • The "Testing a new adapter" page mentions and links to the old testing suite, so that we acknowledge its existence, while also explaining why we recommend the new approach in its place


### Documenting your new adapter

Expand Down
Loading