Search-CouchDBFullText

NAME Search-CouchDBFullText



SYNOPSIS

Full text search.





SYNTAX

Search-CouchDBFullText [[-Server] <String>] [[-Port] <Int32>] [-Database] <String> [-Patterns] <Array>

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





DESCRIPTION

Full text search across entire database.

WARNING! This search is much slower than the Find-CouchdbDocuments cmdlet.





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



-Patterns <Array>

The pattern for full text search.



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-UseQueries [<SwitchParameter>]

Use an array patterns of query objects with fields for the parameters of each individual view query to be

executed.



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

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}/_all_docs/queries



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



PS C:\\>Search-CouchDBFullText -Database test -Patterns "space","planet"



This example search the word "space" and "planet" in each document of database test.









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



PS C:\\>Search-CouchDBFullText -Database test -Patterns "space","planet" -UseQueries



This example search the word "space" and "planet" in each document of database test, using queries mode.











RELATED LINKS

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