Integrates with SQLFluff using a newly added dbt_osmosis.sqlfluff_util.lint_command() function.
Implements an alternative dbt templater that uses dbt-osmosis. It's based on sqlfluff-templater-dbt but using dbt-osmosis makes it much shorter. Most of the sqlfluff-templater-dbt are included, to help ensure quality and compatibility.
Notes:
I've tested this extensively with unit tests and the functional test in src/dbt_osmosis/sqlfluff_util.py, but it hasn't been integration tested or tested with a UI, VSCode, etc. (Using it with VSCode will require updating the plugin to call /lint rather than running sqlfluff lint.)
The /lint API requires a SQL file path. How important would it be to support passing a SQL string instead? I took an initial look at this but had some issues so I dropped it for now. I notice that sqlfluff-templater-dbt has the same limitation (i.e. it will not lint dbt files from "stdin"). I don't know if there's a strong reason for that limitation.
During testing, I saw some dbt database connection issues when multiple dbt projects were registered, e.g. with the macro dbt_utils.group_by(), which uses dbt's adapter object to connect to the database at compile time. I don't think this issue is specific to this PR. For more detail, and a way to reproduce this issue, see the comments in tests/sqlfluff_templater/conftest.py.
Adds a a new
/lintAPI to theserver_v2.py.Highlights:
dbt_osmosis.sqlfluff_util.lint_command()function.dbttemplater that usesdbt-osmosis. It's based onsqlfluff-templater-dbtbut usingdbt-osmosismakes it much shorter. Most of thesqlfluff-templater-dbtare included, to help ensure quality and compatibility.Notes:
src/dbt_osmosis/sqlfluff_util.py, but it hasn't been integration tested or tested with a UI, VSCode, etc. (Using it with VSCode will require updating the plugin to call/lintrather than runningsqlfluff lint.)/lintAPI requires a SQL file path. How important would it be to support passing a SQL string instead? I took an initial look at this but had some issues so I dropped it for now. I notice thatsqlfluff-templater-dbthas the same limitation (i.e. it will not lint dbt files from "stdin"). I don't know if there's a strong reason for that limitation.dbt_utils.group_by(), which uses dbt'sadapterobject to connect to the database at compile time. I don't think this issue is specific to this PR. For more detail, and a way to reproduce this issue, see the comments intests/sqlfluff_templater/conftest.py.