Extends the Knox Node Amazon S3 client to support copying and listing buckets
CoffeeScript
Switch branches/tags
Clone or download
perplexes Merge pull request #5 from ptmt/master
add headers arg to copyFileTo()
Latest commit 2d11a80 Jun 2, 2017

README.md

knox-copy

Dependency Status

Extends the Knox Node Amazon S3 client to support copying and listing arbitrarily large buckets. Transparently streams keys and copies files from buckets that exceed Amazon's 1000 key page size limit.

Install

npm install knox-copy

Examples

Stream the keys of all the files in a bucket:

knoxCopy = require 'knox-copy'

client = knoxCopy.createClient
  key: '<api-key-here>'
  secret: '<secret-here>'
  bucket: 'mrbucket'

client.streamKeys(prefix: 'buckets/of/fun')
.on 'data', (key) -> console.log key

Backup a bucket full of uploads:

knoxCopy = require 'knox-copy'

client = knoxCopy.createClient
  key: '<api-key-here>'
  secret: '<secret-here>'
  bucket: 'backups'

client.copyBucket
  fromBucket: 'uploads'
  fromPrefix: '/nom-nom'
  toPrefix: "/upload_backups/#{new Date().toISOString()}"
  (err, count) ->
     console.log "Copied #{count} files"

Running Tests

Setup tests as with knox. You must first have an S3 account, and create a file named ./auth, which contains your credentials as json, for example:

{
  "key":"<api-key-here>",
  "secret":"<secret-here>",
  "bucket":"<your-bucket-name>"
}

Then install the dev dependencies and execute the test suite:

$ npm install
$ npm test