https://github.com/deeprave/dbscripts

https://github.com/deeprave/dbscripts

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/deeprave/dbscripts
• Owner: deeprave
• Created: 2022-11-28T08:22:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2025-04-25T01:20:10.000Z (about 1 year ago)
• Last Synced: 2025-04-25T02:35:06.752Z (about 1 year ago)
• Language: Python
• Size: 211 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# DbScripts

A collection of scripts for database management.

Designed for use with postgresql.

## dbutil

Formerly `dbcreate`, this script is used to create, remove and test for the existence of a database, and associated roles.

```shell

usage: dbutil [-h] [-c] [-r] [-t] [-e PREFIX] [-u URL] [-v VERBOSE] [-H HOST] [-P PORT] [-N NAME] [-R ROLE] [-U USER] [-p PSWD]

Create/remove/test for database for django using best practices.

options:

  -h, --help            show this help message and exit

  -c, --create          Create the database

  -r, --remove          Completely remove the database and associated users/roles

  -t, --test            Test to see if the database and roles exist

  -e, --prefix          Prefix environment variables, with fallback to non-prefixed

  -u URL, --url URL     Connection url: postgresql://host[:port]/database

  -v VERBOSE, --verbose VERBOSE  Verbose output

  -H HOST, --host HOST  override database hostname

  -P PORT, --port PORT  override database port

  -N NAME, --name NAME  override database name

  -R ROLE, --role ROLE  override database owner role

  -U USER, --user USER  override database username

  -p PSWD, --pswd PSWD  override database password

database details are initially sourced from .env which can be overridden by the

command line, either by specifying individual parts or the complete database url.

superuser account details are sourced from .env in current or parent directories only.

```

## dbready

This script is used to test for the readiness of a database, and optionally to test for a connection to a specific database.

```shell

usage: dbready [-h] [-w] [-t TIMEOUT] [-s SLEEP] [-e PREFIX] [-d] [-q] [-u [URL]] [-v] [-H [HOST]] [-P [PORT]] [-N [NAME]] [-U [USER]] [-p [PSWD]]

test for database ready and optionally connection

options:

  -h, --help                show this help message and exit

  -w, --wait                Wait until ready

  -t TIMEOUT, --timeout TIMEOUT  Wait timeout (0=infinite)

  -s SLEEP, --sleep SLEEP   Sleep time between retries

  -e, --prefix              Prefix environment variables, with fallback to non-prefixed

  -d, --database            Test to see if the database exists (not just connect)

  -q, --quiet               Do not report errors or progress

  -u [URL], --url [URL]     Connection url: postgresql://host[:port]/database

  -v, --verbose             Verbose output

  -H [HOST], --host [HOST]  override database hostname

  -P [PORT], --port [PORT]  override database port

  -N [NAME], --name [NAME]  override database name

  -U [USER], --user [USER]  override database username

  -p [PSWD], --pswd [PSWD]  override database password

database details are initially sourced from .env which can be overridden by the

command line, either by specifying individual parts or the complete database url.

superuser account details are sourced from .env in current or parent directories only.

```

## Rationale

Many web developers undertake many projects that require the use of a database, with a significant majority favouring PostgreSQL.

This toolkit provides a streamlined approach to database management, adhering to industry best practices.

It guarantees that:

- The user affiliated with an application is not a superuser.

- The user affiliated with an application is secured with a password.

- The user inherits access to the database from a nologin role, which actually owns the database

- Tables, sequences and other entities are not created in the superuser `postgres` database, to better support multi-tenancy with other applications.

- Database metadata including credentials is placed within a `.env` file, or since 1.4 also supports fetching secrets from hashicorp vault.

- The prefix option available with both commands allows setting a prefix (`_`) on environment variables, to allow multiple databases (with different users, roles, etc) to be managed in the same environment.

  If the prefixed variable is not set, the non-prefixed variable is used as a fallback.

  For convenience, setting the ENVPREFIX environment variable will set the default prefix for all commands.