SDK
SDK PHP v3.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

getMapping #

Retrieves the current mapping of this collection as a CollectionMapping object.


getMapping([options], callback) #

ArgumentsTypeDescription
optionsJSON objectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

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) {
}