This repository contains a collection of useful PostgreSQL queries for daily troubleshooting and analysis.
It is intended to have a programatic way to store queries and mark them depending the version on top of which they work (that is, in the future, we can execute a query version depending on the server).
- use
.sqlfor SQLs and Procedural Languages. - use
.mdwithin the same file name as the .sql if you want to include documentation of the query and its contents.
When you add a .sql, please add a line like the bellow at the top:
-- This query does THIS. 9.0
-- Optional comments explaining what this does and what it shouldn't
Version isn't mandatory, although we'll make sure that all sqls have a small comment like this. The more the comments, the better.
The hierarchical tree is compound by:
sql/<category>/file.[sql|md]
Rule 1:
Try to make backward compatible queries or even better, provide different queries per version. eg. Queries using advanced properties of CTE or recursive, LATERAL, FDW, etc can be used, but try to provide their version for older versions or at least add them in the TODO.md
Rule 2:
First comment line is mandatory. Minimal accepted documentation.
This is currently under development.
This repository includes and indexer tool (artifact_builder) that builds json artifacts to be easily imported into Postgres using NDJSON format.
It uses submodule, so be careful when testing around.
General advice, is to run
git submodule update --recursive --remotewhenever new changes are published in artifact_builder.
TODO
(We do have an easy way to spin up docker images from all available versions and trigger queries against them). Probably we can reuse postgresqlco.nf infrastructure for this.
Something like egres QA could work.