class LuceneQuery extends AbstractQuery (View source)

Properties

protected DesignDocument $doc from AbstractQuery
protected string $designDocumentName from AbstractQuery
protected string $viewName from AbstractQuery
protected string $databaseName from AbstractQuery
protected Client $client from AbstractQuery
protected array $params from AbstractQuery

Methods

__construct(Client $client, $databaseName, $handlerName, $designDocName, $viewName, DesignDocument $doc = null)

No description

mixed
getParameter(string $key)

No description

getHttpQuery()

No description

execute()

Query the view with the current params.

doExecute()

No description

createResult($response)

No description

void
createDesignDocument()

Create non existing view.

setAnalyzer($analyzer)

No description

getAnalyzer()

No description

setIncludeDocs(bool $flag)

Automatically fetch and include the document which emitted each view entry.

getIncludeDocs()

No description

setLimit($limit)

No description

getLimit()

No description

setQuery($query)

No description

getQuery()

No description

setSkip($skip)

No description

setSort($sort)

No description

setStale($bool)

No description

Details

__construct(Client $client, $databaseName, $handlerName, $designDocName, $viewName, DesignDocument $doc = null)

Parameters

Client $client
$databaseName
$handlerName
$designDocName
$viewName
DesignDocument $doc

mixed getParameter(string $key)

Parameters

string $key

Return Value

mixed

protected getHttpQuery()

Result execute()

Query the view with the current params.

Return Value

Result

protected doExecute()

protected Result createResult($response)

Parameters

$response

Return Value

Result

void createDesignDocument()

Create non existing view.

Return Value

void

Exceptions

JsonDecodeException
Exception

setAnalyzer($analyzer)

Parameters

$analyzer

getAnalyzer()

Query setIncludeDocs(bool $flag)

Automatically fetch and include the document which emitted each view entry.

Parameters

bool $flag

Return Value

Query

getIncludeDocs()

setLimit($limit)

Parameters

$limit

getLimit()

setQuery($query)

Parameters

$query

getQuery()

setSkip($skip)

Parameters

$skip

setSort($sort)

Parameters

$sort

setStale($bool)

Parameters

$bool