https://github.com/alanmcruickshank/sqlfluff
A SQL linter and auto-formatter for Humans
https://github.com/alanmcruickshank/sqlfluff
Last synced: 3 months ago
JSON representation
A SQL linter and auto-formatter for Humans
- Host: GitHub
- URL: https://github.com/alanmcruickshank/sqlfluff
- Owner: alanmcruickshank
- License: mit
- Fork: true (sqlfluff/sqlfluff)
- Created: 2022-10-09T16:55:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-26T22:46:13.000Z (almost 2 years ago)
- Last Synced: 2024-11-24T18:13:14.207Z (3 months ago)
- Homepage: https://www.sqlfluff.com
- Size: 18.7 MB
- Stars: 51
- Watchers: 0
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - alanmcruickshank/sqlfluff - A SQL linter and auto-formatter for Humans (Python)
README
# 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://codecov.io/gh/sqlfluff/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)
**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.
## 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: currently this is just an alias for the `sparksql` dialect).
- [Db2](https://www.ibm.com/analytics/db2)
- [Exasol](https://www.exasol.com/)
- [Hive](https://hive.apache.org/)
- [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/)
- [Teradata](https://www.teradata.com/)
- [Transact-SQL](https://docs.microsoft.com/en-us/sql/t-sql/language-reference) (aka T-SQL)
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/realworld.html#modularity).
**SQLFluff** supports the following templates:
- [Jinja](https://jinja.palletsprojects.com/) (aka Jinja2)
- [dbt](https://www.getdbt.com/)
Again, please raise issues if you wish to support more templating languages/syntaxes.
# 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 | L050 | Files must not begin with newlines or whitespace.
L: 1 | P: 3 | L003 | First line has unexpected indent
L: 1 | P: 11 | L039 | Unnecessary whitespace found.
L: 1 | P: 14 | L039 | Unnecessary whitespace found.
L: 1 | P: 27 | L001 | Unnecessary trailing whitespace.
```
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/cli.html) and [rules reference](https://docs.sqlfluff.com/en/stable/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. 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-o1f4x0e8-pZzarAIlQmKj_6ZwD16w0g), 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/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).