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

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);
  /*
  {
    "nyc-open-data": {
      "mappings": {
        "yellow-taxi": {
          dynamic: 'false',
          _meta: {
            area: 'Panipokhari
          },
          properties: {
            license: { type: 'keyword' },
            driver: {
              properties: {
                name: { type: 'keyword' },
                curriculum: { type: 'text' }
              }
            }
          }
        }
      }
    }
  }
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}

Edit this page on Github