< Back
Get-CouchDBDatabaseDesignDocument
Post
NAME Get-CouchDBDatabaseDesignDocument
SYNOPSIS
Get all design document on a database.
SYNTAX
Get-CouchDBDatabaseDesignDocument [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Descending]
[[-EndKey] <String>] [[-EndKeyDocument] <String>] [-IncludeDocument] [[-InclusiveEnd] <Boolean>] [[-Key] <String>]
[[-Keys] <Array>] [-Conflict] [[-Limit] <Int32>] [[-Skip] <Int32>] [[-StartKey] <String>] [[-StartKeyDocument]
<String>] [-UpdateSequence] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
Returns a JSON structure of all of the design documents in a given database.
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
-Database <String>
The CouchDB database.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Descending [<SwitchParameter>]
Return the design documents in descending by key order. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EndKey <String>
Stop returning records when the specified key is reached.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EndKeyDocument <String>
Stop returning records when the specified design document ID is reached.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeDocument [<SwitchParameter>]
Include the full content of the design documents in the return. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InclusiveEnd <Boolean>
Specifies whether the specified end key should be included in the result. Default is true.
Required? false
Position? 6
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Key <String>
Return only design documents that match the specified key.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Keys <Array>
Return only design documents that match the specified keys.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Conflict [<SwitchParameter>]
Includes conflicts information in response. Ignored if include_docs isn??????????????????t true. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Limit <Int32>
Limit the number of the returned design documents to the specified number.
Required? false
Position? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
Skip this number of records before starting to return the results. Default is 0.
Required? false
Position? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StartKey <String>
Return records starting with the specified key.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StartKeyDocument <String>
Return records starting with the specified design document ID.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpdateSequence [<SwitchParameter>]
Response includes an update_seq value indicating which sequence id of the underlying database the view
reflects. Default is false.
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? 13
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}/_design_docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBDatabaseDesignDocument -Database test
This example get all design document on database "test".
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... n-document
SYNOPSIS
Get all design document on a database.
SYNTAX
Get-CouchDBDatabaseDesignDocument [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Descending]
[[-EndKey] <String>] [[-EndKeyDocument] <String>] [-IncludeDocument] [[-InclusiveEnd] <Boolean>] [[-Key] <String>]
[[-Keys] <Array>] [-Conflict] [[-Limit] <Int32>] [[-Skip] <Int32>] [[-StartKey] <String>] [[-StartKeyDocument]
<String>] [-UpdateSequence] [[-Authorization] <String>] [-Ssl] [<CommonParameters>]
DESCRIPTION
Returns a JSON structure of all of the design documents in a given database.
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
-Database <String>
The CouchDB database.
Required? true
Position? 3
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Descending [<SwitchParameter>]
Return the design documents in descending by key order. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-EndKey <String>
Stop returning records when the specified key is reached.
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EndKeyDocument <String>
Stop returning records when the specified design document ID is reached.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IncludeDocument [<SwitchParameter>]
Include the full content of the design documents in the return. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-InclusiveEnd <Boolean>
Specifies whether the specified end key should be included in the result. Default is true.
Required? false
Position? 6
Default value True
Accept pipeline input? false
Accept wildcard characters? false
-Key <String>
Return only design documents that match the specified key.
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Keys <Array>
Return only design documents that match the specified keys.
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Conflict [<SwitchParameter>]
Includes conflicts information in response. Ignored if include_docs isn??????????????????t true. Default is false.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Limit <Int32>
Limit the number of the returned design documents to the specified number.
Required? false
Position? 9
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Skip <Int32>
Skip this number of records before starting to return the results. Default is 0.
Required? false
Position? 10
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-StartKey <String>
Return records starting with the specified key.
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-StartKeyDocument <String>
Return records starting with the specified design document ID.
Required? false
Position? 12
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UpdateSequence [<SwitchParameter>]
Response includes an update_seq value indicating which sequence id of the underlying database the view
reflects. Default is false.
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? 13
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}/_design_docs
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-CouchDBDatabaseDesignDocument -Database test
This example get all design document on database "test".
RELATED LINKS
https://pscouchdb.readthedocs.io/en/lat ... n-document