ejsIdsQuery

Filters documents that only have the provided ids. Note, this filter does not require the _id field to be indexed since it works using the _uid field.

Module

 IdsQuery

IdsQuery ( ids )
Matches documents with the specified id(s).

Parameters
ids <String | String[]> A single document id or a list of document ids.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectboost(boost)Sets the boost value for documents matching the Query.
StringtoJSON()Retrieves the internal query object. This is typically used by internal API functions so use with caution.
Objecttype(type)Sets the type as a single type or an array of types. If type is a string, it is added to the list of existing types. If type is an array, it is set as the types and overwrites an existing types. This parameter is optional.
Objectvalues(val)Sets the values array or adds a new value. if val is a string, it is added to the list of existing document ids. If val is an array it is set as the document values and replaces any existing values.

Method Detail

 _type

String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 boost

Object boost ( boost )
Sets the boost value for documents matching the Query.

Parameters
boost <Double> A positive double value.
Returns
returns this so that calls can be chained.

 toJSON

String toJSON ( )
Retrieves the internal query object. This is typically used by internal API functions so use with caution.

Returns
returns this object's internal query property.

 type

Object type ( type )
Sets the type as a single type or an array of types. If type is a string, it is added to the list of existing types. If type is an array, it is set as the types and overwrites an existing types. This parameter is optional.

Parameters
type <String | String[]> A type or a list of types
Returns
returns this so that calls can be chained.

 values

Object values ( val )
Sets the values array or adds a new value. if val is a string, it is added to the list of existing document ids. If val is an array it is set as the document values and replaces any existing values.

Parameters
val <String | String[]> An single document id or an array of document ids.
Returns
returns this so that calls can be chained.

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo