DocIdSearchQuery
in package
implements
SearchQuery
A FTS query that matches on Couchbase document IDs. Useful to restrict the search space to a list of keys (by using this in a compound query).
Interfaces, Classes, Traits and Enums
- SearchQuery
- Common interface for all classes, which could be used as a body of SearchQuery
Table of Contents
- $boost : float|null
- $documentIds : array<string|int, mixed>
- $field : string|null
- __construct() : mixed
- boost() : DocIdSearchQuery
- Sets the boost for this query.
- build() : DocIdSearchQuery
- Static helper to keep code more readable
- docIds() : DocIdSearchQuery
- Sets the document ids to restrict the search to.
- field() : DocIdSearchQuery
- Sets the field for this query.
Properties
$boost
private
float|null
$boost
= null
$documentIds
private
array<string|int, mixed>
$documentIds
$field
private
string|null
$field
= null
Methods
__construct()
public
__construct() : mixed
Return values
mixed —boost()
Sets the boost for this query.
public
boost(float $boost) : DocIdSearchQuery
Parameters
- $boost : float
-
the boost value to use.
Tags
Return values
DocIdSearchQuery —build()
Static helper to keep code more readable
public
static build() : DocIdSearchQuery
Tags
Return values
DocIdSearchQuery —docIds()
Sets the document ids to restrict the search to.
public
docIds(string ...$documentIds) : DocIdSearchQuery
Parameters
- $documentIds : string
-
the document ids to restrict the search to.
Tags
Return values
DocIdSearchQuery —field()
Sets the field for this query.
public
field(string $field) : DocIdSearchQuery
Parameters
- $field : string
-
the field to use.