Index modules

The number of primary shards that an index should have. Defaults to 1. This setting can only be set at index creation time. It cannot be changed on a closed index.

The index.mode setting is used to control settings applied in specific domains like ingestion of time series data or logs. Different mutually exclusive modes exist, which are used to apply settings or default values controlling indexing of documents, sorting and other parameters whose value affects indexing or query performance.

resp = client.indices.create(
    index="my-index-000001",
    settings={
        "index": {
            "mode": "standard"
        }
    },
)
print(resp)

const response = await client.indices.create({
  index: "my-index-000001",
  settings: {
    index: {
      mode: "standard",
    },
  },
});
console.log(response);

PUT my-index-000001
{
  "settings": {
    "index":{
      "mode":"standard" 
    }
  }
}

Index mode supports the following values:

The number of replicas each primary shard has. Defaults to 1.

WARNING: Configuring it to 0 may lead to temporary availability loss
during node restarts or permanent data loss in case of data corruption.

Auto-expand the number of replicas based on the number of data nodes in the cluster. Set to a dash delimited lower and upper bound (e.g. 0-5) or use all for the upper bound (e.g. 0-all). Defaults to false (i.e. disabled). Note that the auto-expanded number of replicas only takes allocation filtering rules into account, but ignores other allocation rules such as total shards per node, and this can lead to the cluster health becoming YELLOW if the applicable rules prevent all the replicas from being allocated.

If the upper bound is all then shard allocation awareness and cluster.routing.allocation.same_shard.host are ignored for this index.

(string or array of strings) Wildcard (*) patterns matching one or more fields. The following query types search these matching fields by default:

Defaults to *, which matches all fields eligible for term-level queries, excluding metadata fields.

Controls shard allocation for this index. It can be set to:

Enables shard rebalancing for this index. It can be set to:

Final ingest pipeline for the index. Indexing requests will fail if the final pipeline is set and the pipeline does not exist. The final pipeline always runs after the request pipeline (if specified) and the default pipeline (if it exists). The special pipeline name _none indicates no final ingest pipeline will run.