getMapping

Returns the mapping for the given collection.

Signature

Copied to clipboard!
std::string getMapping(const std::string& index, const std::string& collection);

std::string getMapping(
    const std::string& index,
    const std::string& collection,
    const kuzzleio::query_options& options);

Arguments

Arguments Type Description
index
const std::string&
Index name
collection
const std::string&
Collection name
options
kuzzleio::query_options*
Query options

options

Additional query options

Property Type
(default)
Description
queuable
bool

(true)
If true, queues the request during downtime, until connected to Kuzzle again

Return

A JSON string representing the collection data mapping.

Usage

Copied to clipboard!
try {
  std::string mapping = kuzzle->collection->getMapping("nyc-open-data", "yellow-taxi");

  std::cout << mapping << std::endl;
  // {"properties":{"license":{"type":"keyword"},"driver":{"properties":{"name":{"type":"keyword"},"curriculum":{"type":"text"}}}}}
} catch (kuzzleio::KuzzleException &e) {
  std::cerr << e.what() << std::endl;
}