@npmcorp/seq-save
v2.0.1
Published
save a sequence # to a configurable backend (etcd, files, etc.)
Downloads
11
Readme
seq-save
Save CouchDB sequence #s to a configurable backend. This allows you to resume CouchDB replication from the point where you left off.
see also: changes-stream.
This is a replacement to seq-file
, adding
support for additional backends.
API
- SeqSave(
path
,opts
): wherepath
is the path on disk to save the file to or the key to use for an alternative backend, such as etcd. Returns a new sequence saving instance. <Promise>
save.save(sequence
): save thesequence
to the configured backend. Returns a Promise which will resolve once the value is saved.<Promise>
save.read(): Returns a Promise that will resolve with the current sequence #.
Backends
File (Default)
To save sequence files to the filesystem, simply provide the following configuration:
const SeqSave = require('seq-save')
const seq = new SeqSave('my-sequence.seq', {
type: 'file'
})
It's worth noting that file
is the default backend, so you can also
simply provide an empty configuration object..
etcd
To save sequence files to etcd, simply provide the following configuration:
NOTE: if you specify a path in the etcd backend that begins with a leading dot character .
, it will be removed.
const Save = require('seq-save')
const seq = new SeqSave('my-sequence.seq', {
type: 'etcd',
host: 'http://127.0.0.1:2379'
})