Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.
/ couchdb2s3 Public archive

Export CouchDB databases to line oriented json files on s3

License

Notifications You must be signed in to change notification settings

mapbox/couchdb2s3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 

CouchDB-2-s3

Export a CouchDB database as a line oriented JSON file, then upload that to S3. Then later on s32couchdb that same file to get it into CouchDB instance.

Install

npm install -g couchdb2s3

Usage

couchdb2s3 \
  --bucket my-bucket \
  --database http://localhost:5984/my-database
  [--gzip]                                      # Optionally gzip the export

and

s32couchdb \
  --bucket my-bucket \
  --database http://localhost:5984/my-database
  [--prefix `db/my-database`]                   # Optionally specify a s3 prefix,
                                                #   defaults to `db/[name of database]`.
  [--marker `db/my-database-2010-12-31`]        # Optionally specify a s3 marker,
                                                #   defaults to `db/[name of database]-[yyyy]-[mm]-[dd]`
                                                #   for yesterday's date.

Configuration

AWS credentials for uploading and retrieving exports can be provided by;

  1. IAM role assigned to an EC2
  2. Environment variables; AWS_ACCESS_KEY_ID & AWS_SECRET_ACCESS_KEY
  3. A dotenv configuration file

Caveats

  • s32couchdb will not create a new database for you, you'll have to do that on your own.
  • Attached documents are not currently supported.
  • As written these scripts expect to be used as part of a export system where only the most recent backups are meaningful.

About

Export CouchDB databases to line oriented json files on s3

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published