ejsLimitFilter

A limit filter limits the number of documents (per shard) to execute on.

Module

 LimitFilter

LimitFilter ( limit )
Limits the number of documents to execute on.

Parameters
limit <Integer> The number of documents to execute on.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectcache(trueFalse)Enable or disable caching of the filter
ObjectcacheKey(key)Sets the cache key.
Objectname(name)Sets the filter name.
ObjecttoJSON()Returns the filter object.
Objectvalue(val)Sets the limit value.

Method Detail

 _type

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

Returns
the type of object

 cache

Object cache ( trueFalse )
Enable or disable caching of the filter

Parameters
trueFalse <Boolean> True to cache the filter, false otherwise.
Returns
returns this so that calls can be chained.

 cacheKey

Object cacheKey ( key )
Sets the cache key.

Parameters
key <String> the cache key as a string.
Returns
returns this so that calls can be chained.

 name

Object name ( name )
Sets the filter name.

Parameters
name <String> A name for the filter.
Returns
returns this so that calls can be chained.

 toJSON

Object toJSON ( )
Returns the filter object.

Returns
filter object

 value

Object value ( val )
Sets the limit value.

Parameters
val <Integer> An The number of documents to execute on.
Returns
returns this so that calls can be chained.

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo