rlx-repl(3) -- replication  commands
====================================

## SYNOPSIS

Commands for replicating databases.

The `repl` commands provide a mechanism for operating on the *replicator* database. These commands operate on the current server and always perform some preliminary requests to fetch the name of the replicator database from the server configuration and check the replicator database exists.

The *create_target* field is set to `true` by default, whilst the *continuous* field is set to `false`.

The *source* for replication is set to the currently selected server and database.

Note that when the server is running in admin party mode that *target* must be an absolute URL. Also, when the target server requires authentication the `username:password` must be specified in the target URL in order for replication to succeed.

You may use explicit alias references for the *target* in the format `@name`, see rlx-alias(3).

## COMMANDS

* `repl db`:

Print the name of the replication database.

* `repl ls`:

List documents in the replicator database.

* `repl add [id] [target] [template] [name=<value>...]`:

Create a replication document from a template and opens the document in the editor, if the document is saved then it is sent to the server.

* `repl filter [filter] [id] [target]`:

Create a replication document suitable for a filtered replication.

* `repl docs [id] [target] [document...]`:

Create a replication document suitable for replicating only specific *document* identifiers.

* `repl edit [id]`:

Edit a document in the replication database.

* `repl get [id]`:

Show a document in the replicator database.

* `repl rm [id]`:

Delete a document from the replicator database.

* `repl restart [id]`:

Restart a replication from an existing replication document, the document must already exist. This command forcefully (without confirmation) deletes the existing replication document and then saves the document back to the replication database to restart the replication process.

## BUGS

**rlx** is written in bash and depends upon `bash >= 4.2`.

## COPYRIGHT

**rlx** is copyright (c) 2013 muji <http://xpm.io>

## SEE ALSO

rlx(1), couchdb(3)