Skip to content

README.md

Latest commit

 

History

History
60 lines (45 loc) · 1.86 KB

README.md

File metadata and controls

60 lines (45 loc) · 1.86 KB

DB Dump

db-dump.sh is a simple Bash script for creating PostgreSQL database dumps. It automatically reads connection details from your .env file — no manual input required.

Features

  • Auto Configuration: Reads DATABASE_URL from .env.
  • Safe .env Parsing: Correctly handles inline comments and quoted values.
  • Flexible ENV Path: Accepts a custom path to .env file via -e / --env argument.
  • Timestamped Output: Each dump file is named with the current date and time to avoid overwrites.
  • Organized Storage: Saves all dumps to dumps/db/ directory.
  • Docker Support: Automatically detects Docker environment and replaces localhost with the postgres service name.
  • Prisma Compatibility: Strips Prisma-specific query parameters (e.g. ?schema=public) unsupported by pg_dump.
  • Improved Portability: Uses --no-owner and --no-privileges flags to ensure dumps can be easily restored by different users.
  • Error Handling: Removes the output file if pg_dump fails.
  • Named Arguments: Supports short (-e) and long (--env) flags.

Usage

Ensure the script is executable:

chmod +x scripts/db-dump.sh

Run with default .env

bash scripts/db-dump.sh

Run with a custom .env path

bash scripts/db-dump.sh -e apps/api/.env

Run inside Docker (via runner container)

bash scripts/db-dump.sh -e apps/api/.env.docker

Output: dumps/db/backup-2026-04-09_14-30-00.sql

.env configuration

The following variable must be present in your .env file:

DATABASE_URL=postgresql://postgres:your_password@localhost:5432/your_db?schema=public

Requirements

  • bash
  • pg_dump (comes with PostgreSQL)

.gitignore recommendation

Add the following to your .gitignore to avoid committing dump files:

# Dumps (e.g. database dumps, codebase dumps, etc.)
dumps/