searchSpecifications #

Retrieves every specifications across indexes/collections according to the given filters.

searchSpecifications(filters, [options], callback) #

Arguments	Type	Description
`filters`	JSON object	Search request body, using ElasticSearch Query DSL format. If given an empty object, matches all specifications across index/collections
`options`	JSON object	Optional parameters
`callback`	function	Callback handling the response

Options #

Option	Type	Description	Default
`from`	number	Provide the starting offset of the request (used to paginate results)	`0`
`queuable`	boolean	Make this request queuable or not	`true`
`scroll`	string	Start a scroll session, with a time to live equals to this parameter's value following the Elastisearch time format	`undefined`
`size`	number	Provide the maximum number of results of the request (used to paginate results)	`10`

Usage #

const
  filters = {
    match_all: {
      boost: 1
    }
  },
  options= {
    from: 0,
    size: 20
  };
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .searchSpecifications(filters, options, function (err, res) {
    res.hits.forEach(function (specification) {
      console.log(specification);
    });
    res.total // Total specifications count
  });
// Using promises (NodeJS only)
kuzzle
  .collection('collection', 'index')
  .searchSpecificationsPromise(filters, options)
  .then(res => {
    res.hits.forEach(specification => {
      console.log(specification);
    });
    res.total // Total specifications count
  });

Callback response

{
  "hits": [{ "first": "specification" }, { "second": "specification" }],
  "total": 2,
  "scrollId": "foobar"
}

Edit this page on Github