Skip to content

Commit

Permalink
Initial docs for new adapter testing framework (#1263)
Browse files Browse the repository at this point in the history
* Initial docs for new adapter testing framework

* Show deprecation info always

* PR feedback

* Self review

* Small feedback

* PR feedback

* Update migration guide

* While here: add unique_key note to mig guide
  • Loading branch information
jtcohen6 committed Apr 8, 2022
1 parent ef8014e commit 50d46b0
Show file tree
Hide file tree
Showing 5 changed files with 509 additions and 8 deletions.
16 changes: 12 additions & 4 deletions website/dbt-versions.js
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"
},
{
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
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)

### Documenting your new adapter

Expand Down
Loading

0 comments on commit 50d46b0

Please sign in to comment.