< Back
Get-CouchDBReplicationDocument
Post
NAME Get-CouchDBReplicationDocument
SYNOPSIS
List of replication document states.
SYNTAX
Get-CouchDBReplicationDocument [[-Server] <String>] [[-Port] <Int32>] [[-Limit] <Int32>] [[-Skip] <Int32>]
[[-ReplicatorDatabase] <String>] [[-ReplicatorDocuments] <String>] [[-Authorization] <String>] [-Ssl]
[<CommonParameters>]
DESCRIPTION
List of replication document states. Includes information about all the documents, even in completed and failed
states.
PARAMETERS
-Server <String>
The CouchDB server name. Default is localhost.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
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
-Limit <Int32>
How many results to return.
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
How many result to skip starting at the beginning, ordered by replication ID.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ReplicatorDatabase <String>
Get information about replication documents from a replicator database.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicatorDocuments <String>
Get information about replication document from a replicator database. -ReplicatorDatabase parameter is
required.
Required? false
Position? 6
Default value
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? 7
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:
GET /_scheduler/docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBReplicationDocument -Authorization "admin:password"
This example get the documents of replicas.
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... et-replica
SYNOPSIS
List of replication document states.
SYNTAX
Get-CouchDBReplicationDocument [[-Server] <String>] [[-Port] <Int32>] [[-Limit] <Int32>] [[-Skip] <Int32>]
[[-ReplicatorDatabase] <String>] [[-ReplicatorDocuments] <String>] [[-Authorization] <String>] [-Ssl]
[<CommonParameters>]
DESCRIPTION
List of replication document states. Includes information about all the documents, even in completed and failed
states.
PARAMETERS
-Server <String>
The CouchDB server name. Default is localhost.
Required? false
Position? 1
Default value
Accept pipeline input? true (ByValue)
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
-Limit <Int32>
How many results to return.
Required? false
Position? 3
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
How many result to skip starting at the beginning, ordered by replication ID.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-ReplicatorDatabase <String>
Get information about replication documents from a replicator database.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ReplicatorDocuments <String>
Get information about replication document from a replicator database. -ReplicatorDatabase parameter is
required.
Required? false
Position? 6
Default value
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? 7
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:
GET /_scheduler/docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBReplicationDocument -Authorization "admin:password"
This example get the documents of replicas.
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... et-replica