| Name | sqlfluff JSON |
| Version |
3.3.0
JSON |
| download |
| home_page | None |
| Summary | The SQL Linter for Humans |
| upload_time | 2024-12-10 12:23:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Alan Cruickshank Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sqlfluff
sql
linter
formatter
athena
bigquery
clickhouse
databricks
db2
duckdb
exasol
greenplum
hive
impala
materialize
mariadb
mysql
postgres
redshift
snowflake
soql
sparksql
sqlite
starrocks
teradata
trino
tsql
vertica
dbt
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# The SQL Linter for Humans
[](https://pypi.org/project/sqlfluff/)
[](https://pypi.org/project/sqlfluff/)
[](https://pypi.org/project/sqlfluff/)
[](https://pypi.org/project/sqlfluff/)
[](https://pypi.org/project/sqlfluff/)
[](https://github.com/sqlfluff/sqlfluff/actions/workflows/ci-tests.yml?query=branch%3Amain)
[](https://sqlfluff.readthedocs.io)
[](https://github.com/psf/black)
[](https://hub.docker.com/r/sqlfluff/sqlfluff)
[](https://gurubase.io/g/sqlfluff)
**SQLFluff** is a dialect-flexible and configurable SQL linter. Designed
with ELT applications in mind, **SQLFluff** also works with Jinja templating
and dbt. **SQLFluff** will auto-fix most linting errors, allowing you to focus
your time on what matters.
## Table of Contents
1. [Dialects Supported](#dialects-supported)
2. [Templates Supported](#templates-supported)
3. [VS Code Extension](#vs-code-extension)
4. [Getting Started](#getting-started)
5. [Documentation](#documentation)
6. [Releases](#releases)
7. [SQLFluff on Slack](#sqlfluff-on-slack)
8. [SQLFluff on Twitter](#sqlfluff-on-twitter)
9. [Contributing](#contributing)
10. [Sponsors](#sponsors)
## Dialects Supported
Although SQL is reasonably consistent in its implementations, there are several
different dialects available with variations of syntax and grammar. **SQLFluff**
currently supports the following SQL dialects (though perhaps not in full):
- ANSI SQL - this is the base version and on occasion may not strictly follow
the ANSI/ISO SQL definition
- [Athena](https://aws.amazon.com/athena/)
- [BigQuery](https://cloud.google.com/bigquery/)
- [ClickHouse](https://clickhouse.com/)
- [Databricks](https://databricks.com/) (note: this extends the `sparksql` dialect with
[Unity Catalog](https://docs.databricks.com/data-governance/unity-catalog/index.html) syntax).
- [Db2](https://www.ibm.com/analytics/db2)
- [DuckDB](https://duckdb.org/)
- [Exasol](https://www.exasol.com/)
- [Greenplum](https://greenplum.org/)
- [Hive](https://hive.apache.org/)
- [Impala](https://impala.apache.org/)
- [Materialize](https://materialize.com/)
- [MySQL](https://www.mysql.com/)
- [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/index.html)
- [PostgreSQL](https://www.postgresql.org/) (aka Postgres)
- [Redshift](https://docs.aws.amazon.com/redshift/index.html)
- [Snowflake](https://www.snowflake.com/)
- [SOQL](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm)
- [SparkSQL](https://spark.apache.org/docs/latest/)
- [SQLite](https://www.sqlite.org/)
- [StarRocks](https://www.starrocks.io)
- [Teradata](https://www.teradata.com/)
- [Transact-SQL](https://docs.microsoft.com/en-us/sql/t-sql/language-reference) (aka T-SQL)
- [Trino](https://trino.io/)
- [Vertica](https://www.vertica.com/)
We aim to make it easy to expand on the support of these dialects and also
add other, currently unsupported, dialects. Please [raise issues](https://github.com/sqlfluff/sqlfluff/issues)
(or upvote any existing issues) to let us know of demand for missing support.
Pull requests from those that know the missing syntax or dialects are especially
welcomed and are the question way for you to get support added. We are happy
to work with any potential contributors on this to help them add this support.
Please raise an issue first for any large feature change to ensure it is a good
fit for this project before spending time on this work.
## Templates Supported
SQL itself does not lend itself well to [modularity](https://docs.getdbt.com/docs/viewpoint#section-modularity),
so to introduce some flexibility and reusability it is often [templated](https://en.wikipedia.org/wiki/Template_processor)
as discussed more in [our modularity documentation](https://docs.sqlfluff.com/en/stable/perma/modularity.html).
**SQLFluff** supports the following templates:
- [Jinja](https://jinja.palletsprojects.com/) (aka Jinja2)
- SQL placeholders (e.g. SQLAlchemy parameters)
- [Python format strings](https://docs.python.org/3/library/string.html#format-string-syntax)
- [dbt](https://www.getdbt.com/) (requires plugin)
Again, please raise issues if you wish to support more templating languages/syntaxes.
## VS Code Extension
We also have a VS Code extension:
- [Github Repository](https://github.com/sqlfluff/vscode-sqlfluff)
- [Extension in VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=dorzey.vscode-sqlfluff)
# Getting Started
To get started, install the package and run `sqlfluff lint` or `sqlfluff fix`.
```shell
$ pip install sqlfluff
$ echo " SELECT a + b FROM tbl; " > test.sql
$ sqlfluff lint test.sql --dialect ansi
== [test.sql] FAIL
L: 1 | P: 1 | LT01 | Expected only single space before 'SELECT' keyword.
| Found ' '. [layout.spacing]
L: 1 | P: 1 | LT02 | First line should not be indented.
| [layout.indent]
L: 1 | P: 1 | LT13 | Files must not begin with newlines or whitespace.
| [layout.start_of_file]
L: 1 | P: 11 | LT01 | Expected only single space before binary operator '+'.
| Found ' '. [layout.spacing]
L: 1 | P: 14 | LT01 | Expected only single space before naked identifier.
| Found ' '. [layout.spacing]
L: 1 | P: 27 | LT01 | Unnecessary trailing whitespace at end of file.
| [layout.spacing]
L: 1 | P: 27 | LT12 | Files must end with a single trailing newline.
| [layout.end_of_file]
All Finished 📜 🎉!
```
Alternatively, you can use the [**Official SQLFluff Docker Image**](https://hub.docker.com/r/sqlfluff/sqlfluff)
or have a play using [**SQLFluff online**](https://online.sqlfluff.com/).
For full [CLI usage](https://docs.sqlfluff.com/en/stable/perma/cli.html) and
[rules reference](https://docs.sqlfluff.com/en/stable/perma/rules.html), see
[the SQLFluff docs](https://docs.sqlfluff.com/en/stable/).
# Documentation
For full documentation visit [docs.sqlfluff.com](https://docs.sqlfluff.com/en/stable/).
This documentation is generated from this repository so please raise
[issues](https://github.com/sqlfluff/sqlfluff/issues) or pull requests
for any additions, corrections, or clarifications.
# Releases
**SQLFluff** adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
so breaking changes should be restricted to major versions releases. Some
elements (such as the python API) are in a less stable state and may see more
significant changes more often. For details on breaking changes and how
to migrate between versions, see our
[release notes](https://docs.sqlfluff.com/en/latest/perma/releasenotes.html). See the
[changelog](CHANGELOG.md) for more details. If you would like to join in, please
consider [contributing](CONTRIBUTING.md).
New releases are made monthly. For more information, visit
[Releases](https://github.com/sqlfluff/sqlfluff/releases).
# SQLFluff on Slack
We have a fast-growing community
[on Slack](https://join.slack.com/t/sqlfluff/shared_invite/zt-2qtu36kdt-OS4iONPbQ3aCz2DIbYJdWg),
come and join us!
# SQLFluff on Twitter
Follow us [on Twitter @SQLFluff](https://twitter.com/SQLFluff) for announcements
and other related posts.
# Contributing
We are grateful to all our [contributors](https://github.com/sqlfluff/sqlfluff/graphs/contributors).
There is a lot to do in this project, and we are just getting started.
If you want to understand more about the architecture of **SQLFluff**, you can
find [more here](https://docs.sqlfluff.com/en/latest/perma/architecture.html).
If you would like to contribute, check out the
[open issues on GitHub](https://github.com/sqlfluff/sqlfluff/issues). You can also see
the guide to [contributing](CONTRIBUTING.md).
# Sponsors
<img src="images/datacoves.png" alt="Datacoves" width="150"/><br>
The turnkey analytics stack, find out more at [Datacoves.com](https://datacoves.com/).
Raw data
{
"_id": null,
"home_page": null,
"name": "sqlfluff",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "sqlfluff, sql, linter, formatter, athena, bigquery, clickhouse, databricks, db2, duckdb, exasol, greenplum, hive, impala, materialize, mariadb, mysql, postgres, redshift, snowflake, soql, sparksql, sqlite, starrocks, teradata, trino, tsql, vertica, dbt",
"author": null,
"author_email": "Alan Cruickshank <alan@designingoverload.com>",
"download_url": "https://files.pythonhosted.org/packages/6d/1f/d4d5f97110a917e01c4f5c921852eb11a3b69d6c5decdbb6ddd5658ccdcd/sqlfluff-3.3.0.tar.gz",
"platform": null,
"description": "\n\n# The SQL Linter for Humans\n\n[](https://pypi.org/project/sqlfluff/)\n[](https://pypi.org/project/sqlfluff/)\n[](https://pypi.org/project/sqlfluff/)\n[](https://pypi.org/project/sqlfluff/)\n[](https://pypi.org/project/sqlfluff/)\n\n[](https://github.com/sqlfluff/sqlfluff/actions/workflows/ci-tests.yml?query=branch%3Amain)\n[](https://sqlfluff.readthedocs.io)\n[](https://github.com/psf/black)\n[](https://hub.docker.com/r/sqlfluff/sqlfluff)\n[](https://gurubase.io/g/sqlfluff)\n\n**SQLFluff** is a dialect-flexible and configurable SQL linter. Designed\nwith ELT applications in mind, **SQLFluff** also works with Jinja templating\nand dbt. **SQLFluff** will auto-fix most linting errors, allowing you to focus\nyour time on what matters.\n\n## Table of Contents\n\n1. [Dialects Supported](#dialects-supported)\n2. [Templates Supported](#templates-supported)\n3. [VS Code Extension](#vs-code-extension)\n4. [Getting Started](#getting-started)\n5. [Documentation](#documentation)\n6. [Releases](#releases)\n7. [SQLFluff on Slack](#sqlfluff-on-slack)\n8. [SQLFluff on Twitter](#sqlfluff-on-twitter)\n9. [Contributing](#contributing)\n10. [Sponsors](#sponsors)\n\n## Dialects Supported\n\nAlthough SQL is reasonably consistent in its implementations, there are several\ndifferent dialects available with variations of syntax and grammar. **SQLFluff**\ncurrently supports the following SQL dialects (though perhaps not in full):\n\n- ANSI SQL - this is the base version and on occasion may not strictly follow\n the ANSI/ISO SQL definition\n- [Athena](https://aws.amazon.com/athena/)\n- [BigQuery](https://cloud.google.com/bigquery/)\n- [ClickHouse](https://clickhouse.com/)\n- [Databricks](https://databricks.com/) (note: this extends the `sparksql` dialect with\n [Unity Catalog](https://docs.databricks.com/data-governance/unity-catalog/index.html) syntax).\n- [Db2](https://www.ibm.com/analytics/db2)\n- [DuckDB](https://duckdb.org/)\n- [Exasol](https://www.exasol.com/)\n- [Greenplum](https://greenplum.org/)\n- [Hive](https://hive.apache.org/)\n- [Impala](https://impala.apache.org/)\n- [Materialize](https://materialize.com/)\n- [MySQL](https://www.mysql.com/)\n- [Oracle](https://docs.oracle.com/en/database/oracle/oracle-database/21/sqlrf/index.html)\n- [PostgreSQL](https://www.postgresql.org/) (aka Postgres)\n- [Redshift](https://docs.aws.amazon.com/redshift/index.html)\n- [Snowflake](https://www.snowflake.com/)\n- [SOQL](https://developer.salesforce.com/docs/atlas.en-us.soql_sosl.meta/soql_sosl/sforce_api_calls_soql.htm)\n- [SparkSQL](https://spark.apache.org/docs/latest/)\n- [SQLite](https://www.sqlite.org/)\n- [StarRocks](https://www.starrocks.io)\n- [Teradata](https://www.teradata.com/)\n- [Transact-SQL](https://docs.microsoft.com/en-us/sql/t-sql/language-reference) (aka T-SQL)\n- [Trino](https://trino.io/)\n- [Vertica](https://www.vertica.com/)\n\nWe aim to make it easy to expand on the support of these dialects and also\nadd other, currently unsupported, dialects. Please [raise issues](https://github.com/sqlfluff/sqlfluff/issues)\n(or upvote any existing issues) to let us know of demand for missing support.\n\nPull requests from those that know the missing syntax or dialects are especially\nwelcomed and are the question way for you to get support added. We are happy\nto work with any potential contributors on this to help them add this support.\nPlease raise an issue first for any large feature change to ensure it is a good\nfit for this project before spending time on this work.\n\n## Templates Supported\n\nSQL itself does not lend itself well to [modularity](https://docs.getdbt.com/docs/viewpoint#section-modularity),\nso to introduce some flexibility and reusability it is often [templated](https://en.wikipedia.org/wiki/Template_processor)\nas discussed more in [our modularity documentation](https://docs.sqlfluff.com/en/stable/perma/modularity.html).\n\n**SQLFluff** supports the following templates:\n\n- [Jinja](https://jinja.palletsprojects.com/) (aka Jinja2)\n- SQL placeholders (e.g. SQLAlchemy parameters)\n- [Python format strings](https://docs.python.org/3/library/string.html#format-string-syntax)\n- [dbt](https://www.getdbt.com/) (requires plugin)\n\nAgain, please raise issues if you wish to support more templating languages/syntaxes.\n\n## VS Code Extension\n\nWe also have a VS Code extension:\n\n- [Github Repository](https://github.com/sqlfluff/vscode-sqlfluff)\n- [Extension in VS Code marketplace](https://marketplace.visualstudio.com/items?itemName=dorzey.vscode-sqlfluff)\n\n# Getting Started\n\nTo get started, install the package and run `sqlfluff lint` or `sqlfluff fix`.\n\n```shell\n$ pip install sqlfluff\n$ echo \" SELECT a + b FROM tbl; \" > test.sql\n$ sqlfluff lint test.sql --dialect ansi\n== [test.sql] FAIL\nL: 1 | P: 1 | LT01 | Expected only single space before 'SELECT' keyword.\n | Found ' '. [layout.spacing]\nL: 1 | P: 1 | LT02 | First line should not be indented.\n | [layout.indent]\nL: 1 | P: 1 | LT13 | Files must not begin with newlines or whitespace.\n | [layout.start_of_file]\nL: 1 | P: 11 | LT01 | Expected only single space before binary operator '+'.\n | Found ' '. [layout.spacing]\nL: 1 | P: 14 | LT01 | Expected only single space before naked identifier.\n | Found ' '. [layout.spacing]\nL: 1 | P: 27 | LT01 | Unnecessary trailing whitespace at end of file.\n | [layout.spacing]\nL: 1 | P: 27 | LT12 | Files must end with a single trailing newline.\n | [layout.end_of_file]\nAll Finished \ud83d\udcdc \ud83c\udf89!\n```\n\nAlternatively, you can use the [**Official SQLFluff Docker Image**](https://hub.docker.com/r/sqlfluff/sqlfluff)\nor have a play using [**SQLFluff online**](https://online.sqlfluff.com/).\n\nFor full [CLI usage](https://docs.sqlfluff.com/en/stable/perma/cli.html) and\n[rules reference](https://docs.sqlfluff.com/en/stable/perma/rules.html), see\n[the SQLFluff docs](https://docs.sqlfluff.com/en/stable/).\n\n# Documentation\n\nFor full documentation visit [docs.sqlfluff.com](https://docs.sqlfluff.com/en/stable/).\nThis documentation is generated from this repository so please raise\n[issues](https://github.com/sqlfluff/sqlfluff/issues) or pull requests\nfor any additions, corrections, or clarifications.\n\n# Releases\n\n**SQLFluff** adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),\nso breaking changes should be restricted to major versions releases. Some\nelements (such as the python API) are in a less stable state and may see more\nsignificant changes more often. For details on breaking changes and how\nto migrate between versions, see our\n[release notes](https://docs.sqlfluff.com/en/latest/perma/releasenotes.html). See the\n[changelog](CHANGELOG.md) for more details. If you would like to join in, please\nconsider [contributing](CONTRIBUTING.md).\n\nNew releases are made monthly. For more information, visit\n[Releases](https://github.com/sqlfluff/sqlfluff/releases).\n\n# SQLFluff on Slack\n\nWe have a fast-growing community\n[on Slack](https://join.slack.com/t/sqlfluff/shared_invite/zt-2qtu36kdt-OS4iONPbQ3aCz2DIbYJdWg),\ncome and join us!\n\n# SQLFluff on Twitter\n\nFollow us [on Twitter @SQLFluff](https://twitter.com/SQLFluff) for announcements\nand other related posts.\n\n# Contributing\n\nWe are grateful to all our [contributors](https://github.com/sqlfluff/sqlfluff/graphs/contributors).\nThere is a lot to do in this project, and we are just getting started.\n\nIf you want to understand more about the architecture of **SQLFluff**, you can\nfind [more here](https://docs.sqlfluff.com/en/latest/perma/architecture.html).\n\nIf you would like to contribute, check out the\n[open issues on GitHub](https://github.com/sqlfluff/sqlfluff/issues). You can also see\nthe guide to [contributing](CONTRIBUTING.md).\n\n# Sponsors\n\n<img src=\"images/datacoves.png\" alt=\"Datacoves\" width=\"150\"/><br>\nThe turnkey analytics stack, find out more at [Datacoves.com](https://datacoves.com/).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Alan Cruickshank Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "The SQL Linter for Humans",
"version": "3.3.0",
"project_urls": {
"Changes": "https://github.com/sqlfluff/sqlfluff/blob/main/CHANGELOG.md",
"Chat": "https://github.com/sqlfluff/sqlfluff#sqlfluff-on-slack",
"Documentation": "https://docs.sqlfluff.com",
"Homepage": "https://www.sqlfluff.com",
"Issue Tracker": "https://github.com/sqlfluff/sqlfluff/issues",
"Source": "https://github.com/sqlfluff/sqlfluff",
"Twitter": "https://twitter.com/SQLFluff"
},
"split_keywords": [
"sqlfluff",
" sql",
" linter",
" formatter",
" athena",
" bigquery",
" clickhouse",
" databricks",
" db2",
" duckdb",
" exasol",
" greenplum",
" hive",
" impala",
" materialize",
" mariadb",
" mysql",
" postgres",
" redshift",
" snowflake",
" soql",
" sparksql",
" sqlite",
" starrocks",
" teradata",
" trino",
" tsql",
" vertica",
" dbt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be0d466f9d4fb3f204c5638d63693dafd2d0c014ac40b2cac15b7a99cf551f20",
"md5": "9caf887ade732e10b2a8463896da8824",
"sha256": "83c29db0e7773bb5075543e2049a919632f6ced8a2b475d6a69879da52b03097"
},
"downloads": -1,
"filename": "sqlfluff-3.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9caf887ade732e10b2a8463896da8824",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 867038,
"upload_time": "2024-12-10T12:23:53",
"upload_time_iso_8601": "2024-12-10T12:23:53.521098Z",
"url": "https://files.pythonhosted.org/packages/be/0d/466f9d4fb3f204c5638d63693dafd2d0c014ac40b2cac15b7a99cf551f20/sqlfluff-3.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d1fd4d5f97110a917e01c4f5c921852eb11a3b69d6c5decdbb6ddd5658ccdcd",
"md5": "2d2eeea579791b7e55d9ee6bf9bf51c5",
"sha256": "ea0b752c0b8f4602a56fa5b381eb5c806799e4941df8fc0aad0842c9d4283e03"
},
"downloads": -1,
"filename": "sqlfluff-3.3.0.tar.gz",
"has_sig": false,
"md5_digest": "2d2eeea579791b7e55d9ee6bf9bf51c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 858267,
"upload_time": "2024-12-10T12:23:56",
"upload_time_iso_8601": "2024-12-10T12:23:56.531899Z",
"url": "https://files.pythonhosted.org/packages/6d/1f/d4d5f97110a917e01c4f5c921852eb11a3b69d6c5decdbb6ddd5658ccdcd/sqlfluff-3.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 12:23:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sqlfluff",
"github_project": "sqlfluff",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sqlfluff"
}
