< Back
Get-CouchDBDatabaseUpdates
Post
NAME Get-CouchDBDatabaseUpdates
SYNOPSIS
Get database events.
SYNTAX
Get-CouchDBDatabaseUpdates [[-Server] <String>] [[-Port] <Int32>] [[-Feed] <String>] [[-Timeout] <Int32>]
[[-Heartbeat] <Int32>] [[-Since] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
Returns a list of all database events in the CouchDB instance.
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
-Feed <String>
normal: Returns all historical DB changes, then closes the connection. Default.
longpoll: Closes the connection after the first event.
continuous: Send a line of JSON per event. Keeps the socket open until timeout.
eventsource: Like, continuous, but sends the events in EventSource format.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
Number of seconds until CouchDB closes the connection. Default is 60.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Heartbeat <Int32>
Period in milliseconds after which an empty line is sent in the results.
Only applicable for longpoll, continuous, and eventsource feeds.
Overrides any timeout to keep the feed alive indefinitely. Default is 60000.
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Since <String>
Return only updates since the specified sequence ID. May be the string "now" to begin showing only new updates.
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 /_db_updates
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBDatabaseUpdates -Authorization admin:password
This example get list of all database events in the CouchDB instance.
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... -operation
SYNOPSIS
Get database events.
SYNTAX
Get-CouchDBDatabaseUpdates [[-Server] <String>] [[-Port] <Int32>] [[-Feed] <String>] [[-Timeout] <Int32>]
[[-Heartbeat] <Int32>] [[-Since] <String>] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
Returns a list of all database events in the CouchDB instance.
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
-Feed <String>
normal: Returns all historical DB changes, then closes the connection. Default.
longpoll: Closes the connection after the first event.
continuous: Send a line of JSON per event. Keeps the socket open until timeout.
eventsource: Like, continuous, but sends the events in EventSource format.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Timeout <Int32>
Number of seconds until CouchDB closes the connection. Default is 60.
Required? false
Position? 4
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Heartbeat <Int32>
Period in milliseconds after which an empty line is sent in the results.
Only applicable for longpoll, continuous, and eventsource feeds.
Overrides any timeout to keep the feed alive indefinitely. Default is 60000.
Required? false
Position? 5
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Since <String>
Return only updates since the specified sequence ID. May be the string "now" to begin showing only new updates.
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 /_db_updates
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBDatabaseUpdates -Authorization admin:password
This example get list of all database events in the CouchDB instance.
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... -operation