GetMapping

Returns the mapping for the given collection.

Arguments

Copied to clipboard!
GetMapping(index string, collection string, options types.QueryOptions) (json.RawMessage, error)
Arguments Type Description
index
string
Index name
collection
string
Collection name
options
types.QueryOptions
Query options

options

Additional query options

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

Return

Return a json representation of the mapping and an error is something was wrong.

Usage

Copied to clipboard!
mapping, err := kuzzle.Collection.GetMapping("nyc-open-data", "yellow-taxi", nil)
if err != nil {
  log.Fatal(err)
} else if mapping != nil {
  fmt.Println("Success")
}