Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/channable/dbcritic
https://github.com/channable/dbcritic
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/channable/dbcritic
- Owner: channable
- License: bsd-3-clause
- Created: 2021-03-15T14:26:08.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T09:18:57.000Z (9 months ago)
- Last Synced: 2024-04-12T13:16:07.679Z (8 months ago)
- Language: Idris
- Size: 30.3 KB
- Stars: 169
- Watchers: 25
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# dbcritic
dbcritic finds problems in a database schema.
## Synopsis
To run dbcritic, set the environment variables expected by [libpq][libpqenv].
Then invoke dbcritic with no arguments.
For instance:
```console
$ export PGHOST=localhost
$ export PGPORT=5432
$ export PGUSER=myuser
$ export PGDATABASE=mydatabase
$ dbcritic
```
[libpqenv]: https://www.postgresql.org/docs/current/libpq-envars.html
## Building
dbcritic can be build with Nix or without Nix.
To build it with Nix, simply invoke nix-build:
```console
$ nix-build release.nix
```
This command will make a symlink `result` in the current directory.
dbcritic can then be called via `./result/bin/dbcritic`.
To build it without Nix, first make sure you have installed Idris and libpq.
Then invoke make:
```console
$ make
```
This command will create a binary `dbcritic-bin` in the current directory.
## Description
dbcritic connects to a PostgreSQL database using the specified parameters.
It then performs a series of checks and reports discovered issues.
Issues may result from the cluster configuration or from the database schema.
dbcritic implements the following checks:
| Check | Description |
| -------------------| ----------------------------------------------------------------------------- |
| index_fk_ref | Check that foreign key has an index on the referencing side. |
| primary_key | Check that each table has a primary key constraint. |
| primary_key_bigint | Check that integer primary keys are of type bigint. |
| timestamptz | Check that columns are of type ‘timestamptz’ rather than of type ‘timestamp’. |
| time_zone | Check that the ‘TimeZone’ parameter is set to a sensible value. |
## Configuration
dbcritic can be configured with a file _.dbcriticrc_ in the working directory.
dbcritic will ignore any empty lines and comment lines in the file.
Comment lines begin with a hash sign (#).
dbcritic can be configured to silence certain issues with _silence_ directives.
Any issue whose identifier begins with the given prefix will not be reported.
Here is an example of a silence directive:
```
silence index_fk_ref cache_log
```
This will silence any issues reported by the _index\_fk\_ref_ check
that pertain to the _cache\_log_ table.
## Exit status
If any issues were reported, dbcritic exits with status code 1.
If an unrecoverable error occurred, dbcritic exits with status code 2.
In any other case, dbcritic exits with status code 0.
## Bugs
The output is quite verbose and repetitive.
Experienced users may favor more compact output.
This is currently not implemented.
In the check _index\_fk\_ref_, the order of the columns in the suggested index
is not always correct.
There are many more opportunities for checks.