updateMapping #

Update the collection mapping. Mapping allow you to exploit the full capabilities of our persistent data storage layer, ElasticSearch (opens new window) (check here the mapping capabilities of ElasticSearch (opens new window)).

Signature #

Copied to clipboard!

public void updateMapping(String index, String collection, String mapping) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;
public void updateMapping(String index, String collection, String mapping, io.kuzzle.sdk.QueryOptions options) throws io.kuzzle.sdk.BadRequestException, io.kuzzle.sdk.ForbiddenException, io.kuzzle.sdk.GatewayTimeoutException, io.kuzzle.sdk.InternalException, io.kuzzle.sdk.ServiceUnavailableException, io.kuzzle.sdk.NotFoundException;

Arguments #

Arguments	Type	Description	Required
index	String	Index name	yes
collection	String	Collection name	yes
mapping	String	Collection data mapping in JSON format	yes
options	io.kuzzle.sdk.QueryOptions	The query options	no

mapping #

An string containing the JSON representation of the collection data mapping.

The mapping must have a root field properties that contain the mapping definition:

Copied to clipboard!

{
  "properties": {
    "field1": { "type": "text" },
    "field2": {
      "properties": {
        "nestedField": { "type": "keyword" }
      }
    }
  }
}

More informations about database mappings here.

options #

Additional query options

Property	Type	Description	Default
queuable	boolean	Make this request queuable or not	true

Exceptions #

Throws a io.kuzzle.sdk.KuzzleException if there is an error. See how to handle error.

Usage #

Copied to clipboard!

try {
  String mapping = "{\"properties\": {\"plate\": {\"type\": \"keyword\"}}}";
  kuzzle.getCollection().updateMapping("nyc-open-data", "yellow-taxi", mapping);
  System.out.println("Success");
} catch (KuzzleException e) {
  System.err.println(e.getMessage());
}