Get-CouchDBDatabase

NAME Get-CouchDBDatabase



SYNOPSIS

Get a database information.





SYNTAX

Get-CouchDBDatabase [[-Server] <String>] [[-Port] <Int32>] [[-Database] <String>] [-Descending] [[-EndKey]

<String>] [[-Limit] <Int32>] [[-Skip] <Int32>] [[-StartKey] <String>] [[-Authorization] <String>] [-Ssl]

[<CommonParameters>]





DESCRIPTION

Gets information about the specified database.

Without database argument, return a list of all databases.





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



-Database <String>

The CouchDB database. Default is _all_dbs.



Required? false

Position? 3

Default value _all_dbs

Accept pipeline input? false

Accept wildcard characters? false



-Descending [<SwitchParameter>]

Return the databases in descending order by key. Default is false. The database must be _all_dbs.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-EndKey <String>

Stop returning databases when the specified key is reached. The database must be _all_dbs.



Required? false

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <Int32>

Limit the number of the returned databases to the specified number. The database must be _all_dbs.



Required? false

Position? 5

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Skip <Int32>

Skip this number of databases before starting to return the results. Default is 0. The database must be

_all_dbs.



Required? false

Position? 6

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-StartKey <String>

Return databases starting with the specified key. The database must be _all_dbs.



Required? false

Position? 7

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

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}

GET /_all_dbs



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



PS C:\\>Get-CouchDBDatabase -Database test



This example get info of the database "test".









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



PS C:\\>Get-CouchDBDatabase



This example get info of all databases.











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... a-database