New-CouchDBIndex

NAME New-CouchDBIndex



SYNOPSIS

Create a new index on database.





SYNTAX

New-CouchDBIndex [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Name] <String> [-Fields] <Array>

[[-Authorization] <String>] [-Ssl] [<CommonParameters>]





DESCRIPTION

Mango is a declarative JSON querying language for CouchDB databases.

Mango wraps several index types, starting with the Primary Index out-of-the-box.

Mango indexes, with index type json, are built using MapReduce Views.





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



-Name <String>

The name of index.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Fields <Array>

Array fields that are indexed.



Required? true

Position? 5

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

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 /{db}/_index



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



PS C:\\>New-CouchDBIndex -Database test -Name test-index -Fields name,surname -Authorization "admin:password"



This example create index document "test_index" with fields "name" and "surname" for database "test".











RELATED LINKS

https://pscouchdb.readthedocs.io/en/lat ... -new-index