getMapping #

Returns the collection mapping.

getMapping(index, collection, [options]);

Arguments	Type	Description
`index`	string	Index name
`collection`	string	Collection name
`options`	object	Query options

options #

Additional query options

Property	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`includeKuzzleMeta`	boolean (`true`)	If `true`, the returned mappings will contain Kuzzle metadata
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Resolves to an object representing the collection mapping.

Usage #

try {
  const mapping = await kuzzle.collection.getMapping('nyc-open-data', 'yellow-taxi');
  console.log(mapping);
  /*
  {
    dynamic: 'true',
    _meta: {
      area: 'Panipokhari
    },
    properties: {
      license: { type: 'keyword' },
      driver: {
        properties: {
          name: { type: 'keyword' },
          curriculum: { type: 'text' }
        }
      }
    }
  }
  */
  console.log(mapping.dynamic); // true
} catch (error) {
  console.error(error.message);
}

Edit this page on Github