Set-CouchDBReplication

NAME Set-CouchDBReplication



SYNOPSIS

Modify database replication.





SYNTAX

Set-CouchDBReplication [[-Server] <String>] [[-Port] <Int32>] [-Document] <String> [-Revision] <String>

[-Continuous] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]





DESCRIPTION

The default replicator database is _replicator. Additional replicator databases can be created.

To be recognized as such by the system, their database names should end with /_replicator.





PARAMETERS

-Server <String>

The CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Port <Int32>

The CouchDB server port. Default is 5984.



Required? false

Position? 2

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Document <String>

The CouchDB document.



Required? true

Position? 3

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Revision <String>



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Continuous [<SwitchParameter>]

The Continuous mode of replication.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Authorization <String>

The CouchDB authorization form; user and password.

Authorization format like this: user:password

ATTENTION: if the password is not specified, it will be prompted.



Required? false

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Ssl [<SwitchParameter>]

Set ssl connection on CouchDB server.

This modify protocol to https and port to 6984.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





CouchDB API:

PUT /_replicator/{docid}



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-CouchDBReplication -Authorization "admin:password"



This example get all replica documents.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Set-CouchDBReplication -Document localhost-test_localhost-test_dump -Revision

"2-4705a219cdcca7c72aac4f623f5c46a8" -Continuous -Authorization "admin:password"



This example set replication document "localhost-test_localhost-test_dump" with Continuous replica mode.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... fy-replica