Method: OpenSearch::API::Actions#index

Defined in:
lib/opensearch/api/actions/index.rb

#index(arguments = {}) ⇒ Object

Creates or updates a document in an index.

*Deprecation notice*: Specifying types in urls has been deprecated Deprecated since version 7.0.0

Parameters:

  • arguments (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (arguments):

  • :id (String) —

    Document ID

  • :index (String) —

    The name of the index

  • :wait_for_active_shards (String) —

    Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to ‘all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)

  • :op_type (String) —

    Explicit operation type. Defaults to ‘index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)

  • :refresh (String) —

    If ‘true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for)

  • :routing (String) —

    Specific routing value

  • :timeout (Time) —

    Explicit operation timeout

  • :version (Number) —

    Explicit version number for concurrency control

  • :version_type (String) —

    Specific version type (options: internal, external, external_gte)

  • :if_seq_no (Number) —

    only perform the index operation if the last operation that has changed the document has the specified sequence number

  • :if_primary_term (Number) —

    only perform the index operation if the last operation that has changed the document has the specified primary term

  • :pipeline (String) —

    The pipeline id to preprocess incoming documents with

  • :require_alias (Boolean) —

    When true, requires destination to be an alias. Default is false

  • :headers (Hash) —

    Custom HTTP headers

  • :body (Hash) —

    The document (Required)

Raises:

  • (ArgumentError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/opensearch/api/actions/index.rb', line 54

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

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

  arguments = arguments.clone

  _id = arguments.delete(:id)

  _index = arguments.delete(:index)

  method = _id ? OpenSearch::API::HTTP_PUT : OpenSearch::API::HTTP_POST
  path   = if _index && _id
             "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}"
           else
             "#{Utils.__listify(_index)}/_doc"
           end
  params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)

  body = arguments[:body]
  perform_request(method, path, params, body, headers).body
end