sqlfluff

El enlace SQL para humanos

SQLFLUFF es un enlace SQL flexible y configurable de dialecto. Diseñado con las aplicaciones ELT en mente, SQLFLUFF también funciona con Jinja Templating y DBT. SQLFLUFF fijará automáticamente la mayoría de los errores de pelusa, lo que le permitirá enfocar su tiempo en lo que importa.

Tabla de contenido

1. Dialectos compatibles
2. Plantillas compatibles
3. VS Extensión del código
4. Empezando
5. Documentación
6. Lanzamientos
7. SQLFLUFF en Slack
8. SQLFLUFF en Twitter
9. Que contribuye
10. Patrocinadores

Dialectos compatibles

Aunque SQL es razonablemente consistente en sus implementaciones, hay varios dialectos diferentes disponibles con variaciones de sintaxis y gramática. SQLFLUFF actualmente admite los siguientes dialectos SQL (aunque quizás no en su totalidad):

• ANSI SQL: esta es la versión base y, en ocasiones, puede no seguir estrictamente la definición ANSI/ISO SQL
• Atenea
• Bigores
• Clickhouse
• Databricks (nota: esto extiende el dialecto sparksql con sintaxis de catálogo de Unity).
• DB2
• Duckdb
• Exasol
• Grano verde
• Colmena
• Impala
• Materializar
• Mysql
• Oráculo
• PostgreSQL (también conocido como Postgres)
• Desplazamiento al rojo
• Copo de nieve
• SOQL
• Chispa
• Sqlite
• Párpado
• Teradata
• Transact-SQL (también conocido como T-SQL)
• Trino
• Vertica

Nuestro objetivo es facilitar la expansión del soporte de estos dialectos y también agregar otros dialectos, actualmente sin apoyo. Plantea problemas (o vota cualquier problema existente) para informarnos de la demanda de apoyo perdido.

Las solicitudes de aquellos que conocen la sintaxis o los dialectos faltantes son especialmente bienvenidos y son la forma de pregunta para que se le agregue soporte. Nos complace trabajar con cualquier posible contribuyente en esto para ayudarlos a agregar este soporte. Primero plantee un problema para cualquier cambio de características grande para asegurarse de que sea una buena opción para este proyecto antes de pasar tiempo en este trabajo.

Plantillas compatibles

SQL en sí no se presta bien a la modularidad, por lo que para introducir cierta flexibilidad y reutilización, a menudo se plantilla como se discute más en nuestra documentación de modularidad.

SQLFLUFF admite las siguientes plantillas:

• Jinja (también conocido como Jinja2)
• Marcadores de posición SQL (por ejemplo, parámetros de SQLalchemy)
• Cuerdas de formato de pitón
• DBT (requiere complemento)

Nuevamente, plantee problemas si desea admitir más lenguajes/sintaxis de plantilla.

VS Extensión del código

También tenemos una extensión de código VS:

• Repositorio de Github
• Extensión en VS Code Marketplace

Empezando

Para comenzar, instale el paquete y ejecute sqlfluff lint o sqlfluff fix .

$ 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  ? !

Alternativamente, puede usar la imagen oficial de SQLFLUFF Docker o tener una obra de teatro usando SQLFLUFF en línea .

Para el uso completo de CLI y la referencia de reglas, consulte los documentos SQLFLUFF.

Documentación

Para obtener documentación completa, visite docs.sqlfluff.com. Esta documentación se genera a partir de este repositorio, por lo que plantea problemas o extraiga las solicitudes de cualquier adición, corrección o aclaraciones.

Lanzamientos

SQLFLUFF se adhiere a la versiones semánticas, por lo que los cambios de ruptura deben restringirse a las versiones principales de versiones. Algunos elementos (como la API de Python) están en un estado menos estable y pueden ver cambios más significativos con más frecuencia. Para obtener detalles sobre los cambios de ruptura y cómo migrar entre versiones, consulte nuestras notas de versión. Vea el ChangeLog para más detalles. Si desea unirse, considere contribuir.

Los nuevos lanzamientos se realizan mensualmente. Para obtener más información, visite los comunicados.

SQLFLUFF en Slack

¡Tenemos una comunidad de rápido crecimiento en Slack, ven y únete a nosotros!

SQLFLUFF en Twitter

Síguenos en Twitter @SQLFLUFF para anuncios y otras publicaciones relacionadas.

Que contribuye

Agradecemos a todos nuestros contribuyentes. Hay mucho que hacer en este proyecto, y recién estamos comenzando.

Si desea comprender más sobre la arquitectura de SQLFLUFF , puede encontrar más aquí.

Si desea contribuir, consulte los problemas abiertos en GitHub. También puede ver la guía para contribuir.

Patrocinadores

La pila de Analytics de TurnKey, obtenga más información en Datacoves.com.