SDK
SDK Javascript v7.x
2

# getMapping

Returns the collection mapping.


Copied to clipboard!
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

# Resolves

Resolves to an object representing the collection mapping.

# Usage

Copied to clipboard!
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);
}