Add ordering to check_not_valid_constraints.sql (#37)

* Add command for Windows

* Add new checks to documentation

* Rewrite query to return schema-qualified table name

* Added CONTRIBUTING.md

Author: mfvanek

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Implementing a new check
+
+### Write a new SQL query
+
+Each database structure check starts with an SQL query to the pg_catalog.
+
+1. [SQLFluff](https://github.com/sqlfluff/sqlfluff) is used as a linter for all sql queries
+2. All queries should be schema-aware, i.e. we filter out database objects on schema basis:
+   ```sql
+   where
+       nsp.nspname = :schema_name_param::text
+   ```
+3. All tables and indexes names in the query results should be schema-qualified.
+   We use `::regclass` on `oid` for that.
+   ```sql
+   select
+       psui.relid::regclass::text as table_name,
+       psui.indexrelid::regclass::text as index_name,
+   ```

README.md

@@ -1,4 +1,5 @@
 # pg-index-health-sql
+
 **pg-index-health-sql** is a set of sql-queries for analyzing and maintaining indexes and tables health in Postgresql databases.
 
 [![Lint Code Base](https://github.com/mfvanek/pg-index-health-sql/actions/workflows/linter.yml/badge.svg)](https://github.com/mfvanek/pg-index-health-sql/actions/workflows/linter.yml)
@@ -8,18 +9,21 @@
 [![Files](https://tokei.rs/b1/github/mfvanek/pg-index-health-sql?category=files)](https://github.com/mfvanek/pg-index-health-sql)
 
 ## Supported PostgreSQL versions
+
 [![PostgreSQL 12](https://img.shields.io/badge/PostgreSQL-12-green.svg)](https://www.postgresql.org/about/news/1976/ "PostgreSQL 12")
 [![PostgreSQL 13](https://img.shields.io/badge/PostgreSQL-13-green.svg)](https://www.postgresql.org/about/news/postgresql-13-released-2077/ "PostgreSQL 13")
 [![PostgreSQL 14](https://img.shields.io/badge/PostgreSQL-14-green.svg)](https://www.postgresql.org/about/news/postgresql-14-released-2318/ "PostgreSQL 14")
 [![PostgreSQL 15](https://img.shields.io/badge/PostgreSQL-15-green.svg)](https://www.postgresql.org/about/news/postgresql-15-released-2526/ "PostgreSQL 15")
 [![PostgreSQL 16](https://img.shields.io/badge/PostgreSQL-16-green.svg)](https://www.postgresql.org/about/news/postgresql-16-released-2715/ "PostgreSQL 16")
 
 ### Support for previous versions of PostgreSQL
+
 Compatibility with PostgreSQL versions **9.6**, **10** and **11** is no longer guaranteed, but it is very likely.  
 We focus only on the currently maintained versions of PostgreSQL.  
 For more information please see [PostgreSQL Versioning Policy](https://www.postgresql.org/support/versioning/).
 
 ## Available checks
+
 **pg-index-health-sql** allows you to detect the following problems:
 1. Invalid (broken) indexes ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/invalid_indexes.sql)).
 2. Duplicated (completely identical) indexes ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/duplicated_indexes.sql)).
@@ -36,10 +40,18 @@ For more information please see [PostgreSQL Versioning Policy](https://www.postg
 13. Columns with [json](https://www.postgresql.org/docs/current/datatype-json.html) type ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/columns_with_json_type.sql)).
 14. Columns of [serial types](https://www.postgresql.org/docs/current/datatype-numeric.html#DATATYPE-SERIAL) that are not primary keys ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/non_primary_key_columns_with_serial_types.sql)).
 15. Functions without [description](https://www.postgresql.org/docs/current/sql-comment.html) ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/functions_without_description.sql)).
+16. Indexes [with boolean](https://habr.com/ru/companies/tensor/articles/488104/) ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/indexes_with_boolean.sql))
+17. Tables with [not valid constraints](https://habr.com/ru/articles/800121/) ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/check_not_valid_constraints.sql))
+18. B-tree indexes [on array columns](https://habr.com/ru/articles/800121/) ([sql](https://github.com/mfvanek/pg-index-health-sql/blob/master/sql/btree_indexes_on_array_columns.sql))
 
 ## Local development
+
 ### Linting
-To run super-linter locally
+
+#### macOS/Linux
+
+To run super-linter locally:
+
 ```shell
 docker run \
   -e RUN_LOCAL=true \
@@ -48,3 +60,16 @@ docker run \
   -v $(pwd):/tmp/lint \
   ghcr.io/super-linter/super-linter:slim-v6
 ```
+
+#### Windows
+
+Use `cmd` on Windows:
+
+```shell
+docker run ^
+  -e RUN_LOCAL=true ^
+  -e USE_FIND_ALGORITHM=true ^
+  -e VALIDATE_SQLFLUFF=true ^
+  -v "%cd%":/tmp/lint ^
+  ghcr.io/super-linter/super-linter:slim-v6
+```

sql/check_not_valid_constraints.sql

@@ -6,7 +6,7 @@
  */
 
 select
-    t.relname as table_name, -- Name of the table
+    c.conrelid::regclass as table_name, -- Name of the table
     c.conname as constraint_name, -- Name of the constraint
     c.contype as constraint_type  -- Type of the constraint
 from
@@ -16,4 +16,5 @@ from
 where
     not c.convalidated -- Constraints that have not yet been validated
     and c.contype in ('c', 'f') -- Focus on check and foreign key constraints
-    and n.nspname = :schema_name_param::text; -- Make the query schema-aware
+    and n.nspname = :schema_name_param::text -- Make the query schema-aware
+order by c.conrelid::regclass::text, c.conname;