API удаления

DELETE /<index>/_doc/<_id>

Для удаления документа из индекса используется метод DELETE. Вам необходимо указать имя индекса и идентификатор документа.

Операции удаления могут быть условными и выполняться только в том случае, если последнее изменение документа было присвоено порядковый номер и первичный термин, указанные параметрами if_seq_no и if_primary_term. Если обнаружено несоответствие, операция приведет к VersionConflictException и статусному коду 409. Подробнее см. Оптимистический контроль конкурентности.

Каждый индексированный документ версионируется. При удалении документа можно указать version, чтобы убедиться, что соответствующий документ, который мы пытаемся удалить, действительно удаляется, и он не изменился в то же время. Каждая операция записи, выполненная над документом, включая удаление, приводит к увеличению его версии. Номер версии удаленного документа остается доступным в течение короткого времени после удаления, чтобы обеспечить контроль конкурирующих операций. Длительность, в течение которой версия удаленного документа остается доступной, определяется настройкой индекса index.gc_deletes и по умолчанию составляет 60 секунд.

Если при индексировании используется маршрутизация, значение маршрутизации также необходимо указать для удаления документа.

Если отображение _routing настроено на required и значение маршрутизации не указано, API удаления выведет RoutingMissingException и отклонит запрос.

Например:

resp = client.delete(
    index="my-index-000001",
    id="1",
    routing="shard-1",
)
print(resp)

response = client.delete(
  index: 'my-index-000001',
  id: 1,
  routing: 'shard-1'
)
puts response

const response = await client.delete({
  index: "my-index-000001",
  id: 1,
  routing: "shard-1",
});
console.log(response);

DELETE /my-index-000001/_doc/1?routing=shard-1

Этот запрос удаляет документ с идентификатором 1, но маршрутизируется на основе пользователя. Документ не удаляется, если не указана правильная маршрутизация.

Если используется вариант внешнего версионирования, операция удаления автоматически создает указанный индекс, если он не существует. Сведения об ручном создании индексов см. в API создания индекса.

Операция удаления получает хэшированный идентификатор фрагмента. Затем он перенаправляется в первичный фрагмент в этой группе идентификаторов и реплицируется (при необходимости) в репликах фрагментов в этой группе идентификаторов.

При выполнении запросов на удаление вы можете установить параметр wait_for_active_shards, чтобы потребовать минимальное количество активных копий фрагментов перед началом обработки запроса на удаление. См. здесь для получения дополнительных сведений и примера использования.

Управление временем, когда изменения, внесенные этим запросом, станут видимыми для поиска. См. ?refresh.

Первичный фрагмент, назначенный для выполнения операции удаления, может быть недоступен при выполнении операции удаления. Это может быть связано с тем, что первичный фрагмент в настоящее время восстанавливается из хранилища или выполняет перемещение. По умолчанию операция удаления будет ожидать, пока первичный фрагмент станет доступным в течение 1 минуты перед ошибкой и ответом с ошибкой. Параметр timeout может использоваться для явного указания времени ожидания. Вот пример установки его на 5 минут:

resp = client.delete(
    index="my-index-000001",
    id="1",
    timeout="5m",
)
print(resp)

response = client.delete(
  index: 'my-index-000001',
  id: 1,
  timeout: '5m'
)
puts response

const response = await client.delete({
  index: "my-index-000001",
  id: 1,
  timeout: "5m",
});
console.log(response);

DELETE /my-index-000001/_doc/1?timeout=5m

Удалить JSON-документ 1 из индекса my-index-000001:

resp = client.delete(
    index="my-index-000001",
    id="1",
)
print(resp)

response = client.delete(
  index: 'my-index-000001',
  id: 1
)
puts response

const response = await client.delete({
  index: "my-index-000001",
  id: 1,
});
console.log(response);

DELETE /my-index-000001/_doc/1

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

{
  "_shards": {
    "total": 2,
    "failed": 0,
    "successful": 2
  },
  "_index": "my-index-000001",
  "_id": "1",
  "_version": 2,
  "_primary_term": 1,
  "_seq_no": 5,
  "result": "deleted"
}