Skip to content

CLI tool for dumping various databases in multiple formats

License

Notifications You must be signed in to change notification settings

vrutik2809/dbdump

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

68 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

logo
CLI tool for dumping various databases in multiple formats.

issue_badge pr_badge workflow_badge

DBDump

CLI tool for dumping various databases like MongoDB, PostgreSQL, MySQL into multiple formats like json, tsv, csv

Installation Guide

Linux
wget https://github.com/vrutik2809/dbdump/releases/download/2.0.0/linux_amd64_dbdump

# make the binary executable
chmod +x linux_amd64_dbdump

# move the binary to the desired location (optional)
sudo mv linux_amd64_dbdump /usr/local/bin/dbdump
MacOS
curl https://github.com/vrutik2809/dbdump/releases/download/2.0.0/darwin_amd64_dbdump

# make the binary executable
chmod +x darwin_amd64_dbdump

# move the binary to the desired location (optional)
sudo mv darwin_amd64_dbdump /usr/local/bin/dbdump
Windows

Download the binary: by clicking here

Usage Examples

# dump all mongodb collections to json
dbdump mongodb -u admin --password admin123 --host localhost -p 27017 -d test

# dump specific mongodb collections to bson
dbdump mongodb -u admin --password admin123 --host localhost -p 27017 -d test -c "users,posts" -o bson

# dump all postgresql tables to csv
dbdump pg -u postgres --password 123456 --host localhost -p 5432 -d test -o csv

# dump all postgresql tables excluding specific tables to json
dbdump pg -u postgres --password 123456 --host localhost -p 5432 -d test -e users,photos -o json

# dump all mysql tables to tsv
dbdump mysql -u root --password root --host localhost -p 3306 -d test -o tsv

Output format

  • MongoDB - json, bson, gzip
  • PostgreSQL - json, csv, tsv
  • MySQL - json, csv, tsv

Commands

Command Description
mongodb command for dumping MongoDB database
pg command for dumping PostgreSQL database
mysql command for dumping MySQL database

Command Options

  • mongodb

    flag shorthand description default
    --username -u username of the database ''
    --password password of the database ''
    --host host of the database localhost
    --port -p port of the database 0
    --db-name -d database name
    --dir directory to store the dump dump
    --srv use SRV connection format false
    --collections -c name of the collections to dump []
    --exclude-collections -e name of the collections to exclude []
    --output -o output format of the dump (json,bson,gzip) json
    --test-mode run the command in test mode (not showing progress bar) false
    --help -h help for the command
  • common for pg and mysql

    flag shorthand description default
    --username -u username of the database postgres
    --password password of the database 123456
    --host host of the database localhost
    --port -p port of the database 5432
    --db-name -d database name
    --dir directory to store the dump dump
    --tables -t name of the tables to dump []
    --exclude-tables -e name of the tables to exclude []
    --output -o output format of the dump (json,csv,tsv) json
    --test-mode run the command in test mode (not showing progress bar) false
    --help -h help for the command

You can always pass the --help flag to get help for the command

About

CLI tool for dumping various databases in multiple formats

Resources

License

Stars

Watchers

Forks

Packages

No packages published