API удаления

DELETE /<index>/_doc/<_id>

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

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

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

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

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

Например:

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

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

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

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

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

Управление отображением изменений, внесённых данным запросом, для поиска. См. ?refresh.

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

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

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

DELETE /my-index-000001/_doc/1

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

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