API создания или обновления шаблона индекса

Вы можете использовать комментарии в блоках /* */ в стиле C в шаблонах индексов. Вы можете вставлять комментарии в любом месте тела запроса, кроме места перед открывающей фигурной скобкой.

См. Получение шаблона индекса (устаревшего).

Вы можете включить псевдонимы индексов в шаблон индекса.

resp = client.indices.put_template(
    name="template_1",
    index_patterns=[
        "te*"
    ],
    settings={
        "number_of_shards": 1
    },
    aliases={
        "alias1": {},
        "alias2": {
            "filter": {
                "term": {
                    "user.id": "kimchy"
                }
            },
            "routing": "shard-1"
        },
        "{index}-alias": {}
    },
)
print(resp)

const response = await client.indices.putTemplate({
  name: "template_1",
  index_patterns: ["te*"],
  settings: {
    number_of_shards: 1,
  },
  aliases: {
    alias1: {},
    alias2: {
      filter: {
        term: {
          "user.id": "kimchy",
        },
      },
      routing: "shard-1",
    },
    "{index}-alias": {},
  },
});
console.log(response);

PUT _template/template_1
{
  "index_patterns" : ["te*"],
  "settings" : {
    "number_of_shards" : 1
  },
  "aliases" : {
    "alias1" : {},
    "alias2" : {
      "filter" : {
        "term" : {"user.id" : "kimchy" }
      },
      "routing" : "shard-1"
    },
    "{index}-alias" : {} 
  }
}

Несколько шаблонов индексов могут потенциально соответствовать индексу, в этом случае и настройки, и отображения объединяются в окончательную конфигурацию индекса. Порядок слияния можно контролировать с помощью параметра order, где более низкий порядок применяется первым, а более высокий порядок переопределяет его. Например:

resp = client.indices.put_template(
    name="template_1",
    index_patterns=[
        "te*"
    ],
    order=0,
    settings={
        "number_of_shards": 1
    },
    mappings={
        "_source": {
            "enabled": False
        }
    },
)
print(resp)

resp1 = client.indices.put_template(
    name="template_2",
    index_patterns=[
        "tes*"
    ],
    order=1,
    settings={
        "number_of_shards": 1
    },
    mappings={
        "_source": {
            "enabled": True
        }
    },
)
print(resp1)

const response = await client.indices.putTemplate({
  name: "template_1",
  index_patterns: ["te*"],
  order: 0,
  settings: {
    number_of_shards: 1,
  },
  mappings: {
    _source: {
      enabled: false,
    },
  },
});
console.log(response);

const response1 = await client.indices.putTemplate({
  name: "template_2",
  index_patterns: ["tes*"],
  order: 1,
  settings: {
    number_of_shards: 1,
  },
  mappings: {
    _source: {
      enabled: true,
    },
  },
});
console.log(response1);

PUT /_template/template_1
{
  "index_patterns" : ["te*"],
  "order" : 0,
  "settings" : {
    "number_of_shards" : 1
  },
  "mappings" : {
    "_source" : { "enabled" : false }
  }
}

PUT /_template/template_2
{
  "index_patterns" : ["tes*"],
  "order" : 1,
  "settings" : {
    "number_of_shards" : 1
  },
  "mappings" : {
    "_source" : { "enabled" : true }
  }
}

Вышеприведённый пример отключит сохранение _source, но для индексов, начинающихся с tes*, _source всё ещё будет включено. Обратите внимание, что для отображений слияние является «глубоким», что означает, что определённые отображения, основанные на объектах/свойствах, могут легко быть добавлены/переопределены в шаблонах более высокого порядка, с шаблонами более низкого порядка, предоставляющими основу.

Вы можете использовать параметр version для добавления необязательного номера версии к шаблону индекса. Внешние системы могут использовать эти номера версий для упрощения управления шаблонами.

Параметр version полностью необязателен и не генерируется автоматически Elasticsearch.

Чтобы сбросить version, замените шаблон, не указывая его.

resp = client.indices.put_template(
    name="template_1",
    index_patterns=[
        "my-index-*"
    ],
    order=0,
    settings={
        "number_of_shards": 1
    },
    version=123,
)
print(resp)

response = client.indices.put_template(
  name: 'template_1',
  body: {
    index_patterns: [
      'my-index-*'
    ],
    order: 0,
    settings: {
      number_of_shards: 1
    },
    version: 123
  }
)
puts response

const response = await client.indices.putTemplate({
  name: "template_1",
  index_patterns: ["my-index-*"],
  order: 0,
  settings: {
    number_of_shards: 1,
  },
  version: 123,
});
console.log(response);

PUT /_template/template_1
{
  "index_patterns" : ["my-index-*"],
  "order" : 0,
  "settings" : {
    "number_of_shards" : 1
  },
  "version": 123
}

Для проверки version вы можете использовать API получения шаблона индекса с параметром запроса filter_path для возвращения только номера версии:

$params = [
    'name' => 'template_1',
];
$response = $client->indices()->getTemplate($params);

resp = client.indices.get_template(
    name="template_1",
    filter_path="*.version",
)
print(resp)

response = client.indices.get_template(
  name: 'template_1',
  filter_path: '*.version'
)
puts response

const response = await client.indices.getTemplate({
  name: "template_1",
  filter_path: "*.version",
});
console.log(response);

GET /_template/template_1?filter_path=*.version

API возвращает следующий ответ:

{
  "template_1" : {
    "version" : 123
  }
}