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 #
<?php
use \Kuzzle\Kuzzle;
use \Kuzzle\DataMapping;
$kuzzle = new Kuzzle('localhost');
$dataCollection = $kuzzle->collection('collection', 'index');
try {
$mapping = $dataCollection->getMapping();
// $mapping instanceof DataMapping
}
catch (ErrorException $e) {
}
Edit this page on Github(opens new window)