SDK
SDK Javascript v5.x
1

getMapping #

Retrieves the current mapping of this collection as a CollectionMapping object.


getMapping([options], callback) #

Arguments Type Description
options JSON object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns a CollectionMapping object.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .collection('collection', 'index')
  .getMapping(function (error, result) {
    // result is a CollectionMapping object
  });
// Using promises (NodeJS)
kuzzle
  .collection('collection', 'index')
  .getMappingPromise()
  .then(result => {
    // result is a CollectionMapping object
  });