Skip to main content

A simple tool to reduce PostgreSQL dump size by nullifying large bytea/text columns.

Project description

pgslim 🐘

A simple Python CLI tool to reduce the size of a PostgreSQL dump by nullifying large bytea or text columns.

This is particularly useful when you've accidentally stored large files (like images, PDFs, or JSON responses) in your database and want to create a smaller dump for local development or staging.

Installation

You can install pgslim directly from PyPI (once uploaded):

pip install pgslim

Or from source:

git clone https://github.com/nguyenhuy158/pgslim
cd pgslim
pip install .

Usage

Provide the input SQL file, the table name, and the column you want to nullify.

pgslim dump_old.sql farmlink_disbursement_bank_transaction attachment

This will create a new file named dump_old_slim.sql.

Arguments

Positional Description
input Input SQL dump file (plain text format)
table Name of the table (e.g., users)
column Name of the column to nullify (e.g., attachment)
Optional Flag Description
-o, --output Output SQL dump file (defaults to <input>_slim.sql)

How it works

The tool parses the COPY blocks in a PostgreSQL plain-text dump. It identifies the target table and the index of the specified column. For every row in that COPY block, it replaces the column value with \N (PostgreSQL's representation of NULL).

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pgslim-0.1.2.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pgslim-0.1.2-py2.py3-none-any.whl (3.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pgslim-0.1.2.tar.gz.

File metadata

  • Download URL: pgslim-0.1.2.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for pgslim-0.1.2.tar.gz
Algorithm Hash digest
SHA256 28b3de7e2116ecce27437cbaa5fc6a3e6a9fc2743a0b057adb24de9e08d5f1e5
MD5 208575478386f87a254d0b40656d6fca
BLAKE2b-256 e0440397652eba9f8faf9cc086be73f7f2a5f0357392f4e5c0ba0c01e3068568

See more details on using hashes here.

File details

Details for the file pgslim-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: pgslim-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for pgslim-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7af1530c916b4ad41d1b5591a20390c94a43efda49a690424d8f8bcf3b64c509
MD5 82759c22b32b5c8dd9ba2192dd844d7a
BLAKE2b-256 76bf062ab9e86d3be9545db300dd201125ebbde8bf3be21406ae4d628d149346

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page