Request-CouchDBReplication

NAME Request-CouchDBReplication



SYNOPSIS

Request a replication operation.





SYNTAX

Request-CouchDBReplication [[-SourceServer] <String>] [[-TargetServer] <String>] [[-SourcePort] <Int32>]

[[-TargetPort] <Int32>] [-SourceDatabase] <String> [-TargetDatabase] <String> [[-Proxy] <String>] [[-Documents]

<Array>] [[-Filter] <String>] [-Continuous] [-Cancel] [-CreateTargetDatabase] [[-Authorization] <String>] [-Ssl]

[<CommonParameters>]





DESCRIPTION

Request, configure, or stop, a replication operation.





PARAMETERS

-SourceServer <String>

The source CouchDB server name. Default is localhost.



Required? false

Position? 1

Default value localhost

Accept pipeline input? false

Accept wildcard characters? false



-TargetServer <String>

The destination CouchDB server name. Default is localhost.



Required? false

Position? 2

Default value localhost

Accept pipeline input? false

Accept wildcard characters? false



-SourcePort <Int32>

The source CouchDB server port. Default is 5984.



Required? false

Position? 3

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-TargetPort <Int32>

The destination CouchDB server port. Default is 5984.



Required? false

Position? 4

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-SourceDatabase <String>

The source CouchDB database.



Required? true

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TargetDatabase <String>

The destination CouchDB database.



Required? true

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Proxy <String>

The proxy server.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Documents <Array>



Required? false

Position? 8

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Filter <String>

The filter function.



Required? false

Position? 9

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Continuous [<SwitchParameter>]

The Continuous mode of replica.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Cancel [<SwitchParameter>]

Cancel replica request.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-CreateTargetDatabase [<SwitchParameter>]

Create a target database if not exists.



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? 10

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:

POST /_replicate



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



PS C:\\>Request-CouchDBReplication -SourceDatabase test -TargetDatabase test_dump -Documents

"Hitchhikers","Hitchhikers_Guide" -Authorization "admin:password"



This example request replication of documents "Hitchhikers","Hitchhikers_Guide" from database "test" to database

"test_dump".











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... on-request