couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "Replication" by JensAlfke
Date Sat, 19 May 2012 05:36:58 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "Replication" page has been changed by JensAlfke:
http://wiki.apache.org/couchdb/Replication?action=diff&rev1=42&rev2=43

Comment:
Specified which JSON fields are required.

  Replication is triggered by sending a POST request to the `_replicate` URL. The body is
JSON with the following allowed fields:
  
  ||'''Field Name''' ||'''Description''' ||
- ||''source'' || Identifies the database to copy revisions from. Can be a string containing
a local database name or a remote database URL, or an object whose `url` property contains
the database name or URL. ||
+ ||''source'' || ''Required.'' Identifies the database to copy revisions from. Can be a string
containing a local database name or a remote database URL, or an object whose `url` property
contains the database name or URL. ||
- ||''target'' || Identifies the database to copy revisions to. Same format and interpretation
as `source`. ||
+ ||''target'' || ''Required.'' Identifies the database to copy revisions to. Same format
and interpretation as `source`. ||
  ||''cancel'' || Include this property with a value of `true` to cancel an existing replication
between the specified `source` and `target`. ||
- ||''continuous'' || Include this property with a value of `true` to make the replication
''continuous''. Default value is `false`. ||
+ ||''continuous'' || A value of `true` makes the replication ''continuous'' (see below for
details.) ||
- ||''create_target'' || Include this property with a value of `true` to tell the replicator
to create the target database if it doesn't exist yet. ||
+ ||''create_target'' || A value of `true` tells the replicator to create the target database
if it doesn't exist yet. ||
- ||''doc_ids'' || Optional array of document IDs; if given, only these documents will be
replicated. ||
+ ||''doc_ids'' || Array of document IDs; if given, only these documents will be replicated.
||
  ||''filter'' || Name of a ''filter function'' that can choose which revisions get replicated.
||
- ||''proxy'' || Optional proxy server URL. ||
+ ||''proxy'' || Proxy server URL. ||
- ||''query_params'' || Optional object containing properties that are passed to the filter
function. ||
+ ||''query_params'' || Object containing properties that are passed to the filter function.
||
  
  
  The `source` and a `target` fields indicate the databases that documents will be copied
''from'' and ''to'', respectively. Use just the name for a local database, or the full URL
for a remote database. A local-to-remote replication is called a ''push'', and remote-to-local
is called a ''pull''. Local-to-local or even remote-to-remote are also allowed, but rarer.
For example:

Mime
View raw message