BodyRequired

• aliasesobject

  Aliases for the index.

  Hide aliases attribute Show aliases attribute object

  • *object Additional properties
    Hide * attributes Show * attributes object

    • filterobject

      An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

      External documentation
    • index_routingstring
    • is_hiddenboolean

      If true, the alias is hidden. All indices for the alias must have the same is_hidden value.

    • is_write_indexboolean

      If true, the index is the write index for the alias.

    • routingstring
    • search_routingstring

• index_patternsstring | array[string]

  Array of wildcard expressions used to match the names of indices during creation.

  One of:

  string-1stringarray-2array[string]
• mappingsobject
  Hide mappings attributes Show mappings attributes object

  • all_fieldobject
    Hide all_field attributes Show all_field attributes object

    • analyzerstring Required
    • enabledboolean Required
    • omit_normsboolean Required
    • search_analyzerstring Required
    • similaritystring Required
    • storeboolean Required
    • store_term_vector_offsetsboolean Required
    • store_term_vector_payloadsboolean Required
    • store_term_vector_positionsboolean Required
    • store_term_vectorsboolean Required
  • date_detectionboolean
  • dynamicstring

    Values are strict, runtime, true, or false.

  • dynamic_date_formatsarray[string]
  • dynamic_templatesarray[object]
  • _field_namesobject
    Hide _field_names attribute Show _field_names attribute object

    • enabledboolean Required
  • index_fieldobject
    Hide index_field attribute Show index_field attribute object

    • enabledboolean Required
  • _metaobject
    Hide _meta attribute Show _meta attribute object

    • *object Additional properties
  • numeric_detectionboolean
  • propertiesobject
  • _routingobject
    Hide _routing attribute Show _routing attribute object

    • requiredboolean Required
  • _sizeobject
    Hide _size attribute Show _size attribute object

    • enabledboolean Required
  • _sourceobject
    Hide _source attributes Show _source attributes object

    • compressboolean
    • compress_thresholdstring
    • enabledboolean
    • excludesarray[string]
    • includesarray[string]
    • modestring

      Values are disabled, stored, or synthetic.

  • runtimeobject
    Hide runtime attribute Show runtime attribute object

    • *object Additional properties
      Hide * attributes Show * attributes object

      • fieldsobject

        For type composite

        Hide fields attribute Show fields attribute object

        • *object Additional properties
          Hide * attribute Show * attribute object

          • typestring Required

            Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

      • fetch_fieldsarray[object]

        For type lookup

        Hide fetch_fields attributes Show fetch_fields attributes object

        • fieldstring Required

          Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

        • formatstring
      • formatstring

        A custom format for date type runtime fields.

      • input_fieldstring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_fieldstring

        Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.

      • target_indexstring
      • scriptobject
        Hide script attributes Show script attributes object

        • sourcestring | object

          One of:

          ScriptSourcestringSearchRequestBodyobject

          Hide attributes Show attributes

          • aggregationsobject

            Defines the aggregations that are run as part of the search request.

          • collapseobject
          • explainboolean

            If true, the request returns detailed information about score computation as part of a hit.

          • extobject

            Configuration of search extensions defined by Elasticsearch plugins.

          • fromnumber

            The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after parameter.

          • highlight
          • track_total_hitsboolean | number

            Number of hits matching the query to count accurately. If true, the exact number of hits is returned at the cost of some performance. If false, the response does not include the total number of hits matching the query. Defaults to 10,000 hits.

          • indices_boostarray[object]

            Boost the _score of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than 1.0 increases the score. A boost value between 0 and 1.0 decreases the score.

          • docvalue_fieldsarray[object]

            An array of wildcard (*) field patterns. The request returns doc values for field names matching these patterns in the hits.fields property of the response.

          • knn
          • rankobject
          • min_scorenumber

            The minimum _score for matching documents. Documents with a lower _score are not included in search results or results collected by aggregations.

          • post_filterobject

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • profileboolean

            Set to true to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.

          • queryobject

            An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

          • rescore
          • retrieverobject
          • script_fieldsobject

            Retrieve a script evaluation (based on different fields) for each hit.

          • search_afterarray[number | string | boolean | null]

            A field value.

          • sizenumber

            The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the from and size parameters. To page through more hits, use the search_after property.

          • sliceobject
          • sort
          • _source
          • fieldsarray[object]

            An array of wildcard (*) field patterns. The request returns values for field names matching these patterns in the hits.fields property of the response.

          • suggestobject
          • terminate_afternumber

            The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting.

            IMPORTANT: Use with caution. Elasticsearch applies this property to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this property for requests that target data streams with backing indices across multiple data tiers.

            If set to 0 (default), the query does not terminate early.

          • timeoutstring

            The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout.

          • track_scoresboolean

            If true, calculate and return document scores, even if the scores are not used for sorting.

          • versionboolean

            If true, the request returns the document version as part of a hit.

          • seq_no_primary_termboolean

            If true, the request returns sequence number and primary term of the last modification of each hit.

          • stored_fieldsstring | array[string]
          • pitobject
          • runtime_mappingsobject
          • statsarray[string]

            The stats groups to associate with the search. Each group maintains a statistics aggregation for its associated searches. You can retrieve these stats using the indices stats API.

        • idstring
        • paramsobject

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object

          • *object Additional properties

        • langstring

          Any of:

          ScriptLanguagestringScriptLanguagestring

          Values are painless, expression, mustache, or java.
        • optionsobject
          Hide options attribute Show options attribute object

          • *string Additional properties
      • typestring Required

        Values are boolean, composite, date, double, geo_point, geo_shape, ip, keyword, long, or lookup.

  • enabledboolean
  • subobjectsstring

    Values are true or false.

  • _data_stream_timestampobject
    Hide _data_stream_timestamp attribute Show _data_stream_timestamp attribute object

    • enabledboolean Required
• ordernumber

  Order in which Elasticsearch applies this template if index matches multiple templates.

  Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values.

• settingsobject
  Hide settings attributes Show settings attributes object

  • indexobject
  • modestring

  • routing_pathstring | array[string]

    One of:

    string-1stringarray-2array[string]
  • soft_deletesobject
    Hide soft_deletes attributes Show soft_deletes attributes object

    • enabledboolean

      Indicates whether soft deletes are enabled on the index.

    • retention_leaseobject
      Hide retention_lease attribute Show retention_lease attribute object

      • periodstring Required

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • sortobject
    Hide sort attributes Show sort attributes object

    • fieldstring | array[string]

    • orderstring | array[string]

      Supported values include: asc (or ASC), desc (or DESC)

      One of:

      SegmentSortOrderstringarray-2array[string]

      Values are asc, ASC, desc, or DESC.

      Values are asc, ASC, desc, or DESC.

    • modestring | array[string]

      Supported values include: min (or MIN), max (or MAX)

      One of:

      SegmentSortModestringarray-2array[string]

      Values are min, MIN, max, or MAX.

      Values are min, MIN, max, or MAX.

    • missingstring | array[string]

      Supported values include: _last, _first

      One of:

      SegmentSortMissingstringarray-2array[string]

      Values are _last or _first.

      Values are _last or _first.

  • number_of_shardsnumber | string

    One of:

    number-1numberstring-2string

  • number_of_replicasnumber | string

    One of:

    number-1numberstring-2string
  • number_of_routing_shardsnumber
  • check_on_startupstring

    Values are true, false, or checksum.

  • codecstring

  • routing_partition_sizenumber | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    StringifiedintegernumberStringifiedintegerstring
  • load_fixed_bitset_filters_eagerlyboolean

  • hiddenboolean | string

    One of:

    boolean-1booleanstring-2string

  • auto_expand_replicasstring | null

    One of:

    string-1stringNullValuestring | null

    A null value that is to be interpreted as an actual value, unless other uses of null that are equivalent to a missing value. It is used for exemple in settings, where using the NullValue for a setting will reset it to its default value.

  • mergeobject
    Hide merge attribute Show merge attribute object

    • schedulerobject
      Hide scheduler attributes Show scheduler attributes object

      • max_thread_countnumber | string

        Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

        Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

        One of:

        StringifiedintegernumberStringifiedintegerstring

      • max_merge_countnumber | string

        Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

        Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

        One of:

        StringifiedintegernumberStringifiedintegerstring
  • searchobject
    Hide search attributes Show search attributes object

    • idleobject
      Hide idle attribute Show idle attribute object

      • afterstring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • slowlogobject
      Hide slowlog attributes Show slowlog attributes object

      • levelstring
      • sourcenumber
      • reformatboolean
      • thresholdobject
        Hide threshold attributes Show threshold attributes object

        • queryobject
          Hide query attributes Show query attributes object

          • warnstring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • infostring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • debugstring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • tracestring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • fetchobject
          Hide fetch attributes Show fetch attributes object

          • warnstring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • infostring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • debugstring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

          • tracestring

            A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • refresh_intervalstring

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • max_result_windownumber
  • max_inner_result_windownumber
  • max_rescore_windownumber
  • max_docvalue_fields_searchnumber
  • max_script_fieldsnumber
  • max_ngram_diffnumber
  • max_shingle_diffnumber
  • blocksobject
    Hide blocks attributes Show blocks attributes object

    • read_onlyboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring

    • read_only_allow_deleteboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring

    • readboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring

    • writeboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring

    • metadataboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring
  • max_refresh_listenersnumber
  • analyzeobject
    Hide analyze attribute Show analyze attribute object

    • max_token_countnumber | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedintegernumberStringifiedintegerstring
  • highlightobject
    Hide highlight attribute Show highlight attribute object

    • max_analyzed_offsetnumber
  • max_terms_countnumber
  • max_regex_lengthnumber
  • routingobject
    Hide routing attributes Show routing attributes object

    • allocationobject
      Hide allocation attributes Show allocation attributes object

      • enablestring

        Values are all, primaries, new_primaries, or none.

      • includeobject
        Hide include attributes Show include attributes object

        • _tier_preferencestring
        • _idstring
      • initial_recoveryobject
        Hide initial_recovery attribute Show initial_recovery attribute object

        • _idstring
      • diskobject
        Hide disk attribute Show disk attribute object

        • threshold_enabledboolean | string

          One of:

          boolean-1booleanstring-2string
    • rebalanceobject
      Hide rebalance attribute Show rebalance attribute object

      • enablestring Required

        Values are all, primaries, replicas, or none.

  • gc_deletesstring

    A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • default_pipelinestring
  • final_pipelinestring
  • lifecycleobject
    Hide lifecycle attributes Show lifecycle attributes object

    • namestring

    • indexing_completeboolean | string

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring
    • origination_datenumber

      If specified, this is the timestamp used to calculate the index age for its phase transitions. Use this setting if you create a new index that contains old data and want to use the original creation date to calculate the index age. Specified as a Unix epoch value in milliseconds.

    • parse_origination_dateboolean

      Set to true to parse the origination date from the index name. This origination date is used to calculate the index age for its phase transitions. The index name must match the pattern ^{.*-{date_format}-\d+,} where the date_format is yyyy.MM.dd and the trailing digits are optional. An index that was rolled over would normally match the full format, for example logs-2016.10.31-000002). If the index name doesn’t match the pattern, index creation fails.

    • stepobject
      Hide step attribute Show step attribute object

      • wait_time_thresholdstring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • rollover_aliasstring

      The index alias to update when the index rolls over. Specify when using a policy that contains a rollover action. When the index rolls over, the alias is updated to reflect that the index is no longer the write index. For more information about rolling indices, see Rollover.

    • prefer_ilmboolean | string

      Preference for the system that manages a data stream backing index (preferring ILM when both ILM and DLM are applicable for an index).

      One of:

      boolean-1booleanstring-2string
  • provided_namestring

  • creation_datenumber | string

    Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

    Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

    One of:

    UnitMillisnumberStringifiedEpochTimeUnitMillisstring

    Time unit for milliseconds

  • creation_date_stringstring | number

    A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

    One of:

    DateTimestringUnitMillisnumber

    Time unit for milliseconds

  • uuidstring
  • versionobject
    Hide version attributes Show version attributes object

    • createdstring
    • created_stringstring

  • verified_before_closeboolean | string

    One of:

    boolean-1booleanstring-2string

  • formatstring | number

    One of:

    string-1stringnumber-2number
  • max_slices_per_scrollnumber
  • translogobject
    Hide translog attributes Show translog attributes object

    • sync_intervalstring

      A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

    • durabilitystring

      Values are request, REQUEST, async, or ASYNC.

    • flush_threshold_sizenumber | string

      One of:

      ByteSizenumberByteSizestring
    • retentionobject
      Hide retention attributes Show retention attributes object

      • sizenumber | string

        One of:

        ByteSizenumberByteSizestring
      • agestring

        A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • query_stringobject
    Hide query_string attribute Show query_string attribute object

    • lenientboolean | string Required

      Some APIs will return values such as numbers also as a string (notably epoch timestamps). This behavior is used to capture this behavior while keeping the semantics of the field type.

      Depending on the target language, code generators can keep the union or remove it and leniently parse strings to the target type.

      One of:

      StringifiedbooleanbooleanStringifiedbooleanstring

  • prioritynumber | string

    One of:

    number-1numberstring-2string
  • top_metrics_max_sizenumber
  • analysisobject
    Hide analysis attributes Show analysis attributes object

    • analyzerobject
    • char_filterobject
    • filterobject
    • normalizerobject
    • tokenizerobject
  • settingsobject
  • time_seriesobject
    Hide time_series attributes Show time_series attributes object

    • end_timestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

    • start_timestring | number

      A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

      One of:

      DateTimestringUnitMillisnumber

      Time unit for milliseconds

  • queriesobject
    Hide queries attribute Show queries attribute object

    • cacheobject
      Hide cache attribute Show cache attribute object

      • enabledboolean Required
  • similarityobject

    Configure custom similarity settings to customize how search results are scored.

  • mappingobject
    Hide mapping attributes Show mapping attributes object

    • coerceboolean
    • total_fieldsobject
      Hide total_fields attributes Show total_fields attributes object

      • limitnumber | string

        The maximum number of fields in an index. Field and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources.

        One of:

        number-1numberstring-2string

      • ignore_dynamic_beyond_limitboolean | string

        This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. The fields that were not added to the mapping will be added to the _ignored field.

        One of:

        boolean-1booleanstring-2string
    • depthobject
      Hide depth attribute Show depth attribute object

      • limitnumber

        The maximum depth for a field, which is measured as the number of inner objects. For instance, if all fields are defined at the root object level, then the depth is 1. If there is one object mapping, then the depth is 2, etc.

    • nested_fieldsobject
      Hide nested_fields attribute Show nested_fields attribute object

      • limitnumber

        The maximum number of distinct nested mappings in an index. The nested type should only be used in special cases, when arrays of objects need to be queried independently of each other. To safeguard against poorly designed mappings, this setting limits the number of unique nested types per index.

    • nested_objectsobject
      Hide nested_objects attribute Show nested_objects attribute object

      • limitnumber

        The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects.

    • field_name_lengthobject
      Hide field_name_length attribute Show field_name_length attribute object

      • limitnumber

        Setting for the maximum length of a field name. This setting isn’t really something that addresses mappings explosion but might still be useful if you want to limit the field length. It usually shouldn’t be necessary to set this setting. The default is okay unless a user starts to add a huge number of fields with really long names. Default is Long.MAX_VALUE (no limit).

    • dimension_fieldsobject
      Hide dimension_fields attribute Show dimension_fields attribute object

      • limitnumber

        [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

    • sourceobject
      Hide source attribute Show source attribute object

      • modestring Required

        Values are disabled, stored, or synthetic.

    • ignore_malformedboolean | string

      One of:

      boolean-1booleanstring-2string
  • indexing.slowlogobject
    Hide indexing.slowlog attributes Show indexing.slowlog attributes object

    • levelstring
    • sourcenumber
    • reformatboolean
    • thresholdobject
      Hide threshold attribute Show threshold attribute object

      • indexobject
        Hide index attributes Show index attributes object

        • warnstring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • infostring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • debugstring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • tracestring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

  • indexing_pressureobject
    Hide indexing_pressure attribute Show indexing_pressure attribute object

    • memoryobject Required
      Hide memory attribute Show memory attribute object

      • limitnumber

        Number of outstanding bytes that may be consumed by indexing requests. When this limit is reached or exceeded, the node will reject new coordinating and primary operations. When replica operations consume 1.5x this limit, the node will reject new replica operations. Defaults to 10% of the heap.

  • storeobject
    Hide store attributes Show store attributes object

    • typestring Required

      Any of:

      StorageTypestringStorageTypestring

      Values are fs, niofs, mmapfs, or hybridfs.
    • allow_mmapboolean

      You can restrict the use of the mmapfs and the related hybridfs store type via the setting node.store.allow_mmap. This is a boolean setting indicating whether or not memory-mapping is allowed. The default is to allow it. This setting is useful, for example, if you are in an environment where you can not control the ability to create a lot of memory maps so you need disable the ability to use memory-mapping.

• versionnumber