Metadata-Version: 2.1
Name: sqlfluff_common_conventions
Version: 0.4.0
Summary: An SQLFluff plugin for rules that enforce common SQL naming conventions.
Author-email: Valerie Tan <valerietanhx@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Valerie Tan
        
        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,bigquery,databricks,postgres,postgresql
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: SQL
Classifier: Topic :: Utilities
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: sqlfluff >=0.4.0

# sqlfluff-common-conventions

An SQLFluff plugin for rules that enforce common SQL naming conventions.

As of 12 June 2024, all rules are compatible with the following dialects:

- [Google BigQuery](https://cloud.google.com/bigquery/)
- [Databricks](https://www.databricks.com/)
- [PostgreSQL](https://www.postgresql.org/)

All rules are also compatible with the following naming cases:

- snake_case
- dromedaryCase (also known as lowerCamelCase or simply camelCase)
- PascalCase (also known as upperCamelCase or simply CamelCase)

## Rules

- CC01: Start boolean columns with `is` or `has`.
- CC02: End datetime, time, and timestamp columns with `at`.
- CC03: End date columns with `date`.
- CC04: Only allow a list of configurable strings to be used in identifiers.
- CC05: Block a list of configurable strings from being used in identifiers.
- CC06: Ensure column and table names match a given regex.
