Method: Elasticsearch::API::Indices::Actions#put_mapping

Defined in:
lib/elasticsearch/api/actions/indices/put_mapping.rb

#put_mapping(arguments = {}) ⇒ Object

Updates the index mappings.

Parameters:

  • (defaults to: {})

    a customizable set of options

Options Hash (arguments):

  • :index (List) —

    A comma-separated list of index names the mapping should be added to (supports wildcards); use _all or omit to add the mapping on all indices.

  • :timeout (Time) —

    Explicit operation timeout

  • :master_timeout (Time) —

    Specify timeout for connection to master

  • :ignore_unavailable (Boolean) —

    Whether specified concrete indices should be ignored when unavailable (missing or closed)

  • :allow_no_indices (Boolean) —

    Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

  • :expand_wildcards (String) —

    Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)

  • :write_index_only (Boolean) —

    When true, applies mappings only to the write index of an alias or data stream

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The mapping definition (Required)

Raises:

See Also:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/elasticsearch/api/actions/indices/put_mapping.rb', line 39

def put_mapping(arguments = {})
  raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
  raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]

  arguments = arguments.clone
  headers = arguments.delete(:headers) || {}

  body   = arguments.delete(:body)

  _index = arguments.delete(:index)

  method = Elasticsearch::API::HTTP_PUT
  path   = "#{Utils.__listify(_index)}/_mapping"
  params = Utils.process_params(arguments)

  Elasticsearch::API::Response.new(
    perform_request(method, path, params, body, headers)
  )
end