API обновления

POST /<index>/_update/<_id>

Позволяет вам выполнить скриптовое обновление документов. Скрипт может обновлять, удалять или пропускать изменение документа. API обновления также поддерживает передачу частичного документа, который объединяется с существующим документом. Чтобы полностью заменить существующий документ, используйте index API.

Данная операция:

Документ по-прежнему должен быть повторно индексирован, но использование update уменьшает количество сетевых запросов и снижает вероятность конфликтов версий между операциями GET и индексирования.

Поле _source должно быть включено для использования update. В дополнение к _source, вы можете получить доступ к следующим переменным через карту ctx: _index, _type, _id, _version, _routing и _now (текущая метка времени).

Сначала давайте индексируем простой документ:

PUT test/_doc/1
{
  "counter" : 1,
  "tags" : ["red"]
}

Чтобы увеличить счётчик, можно отправить запрос на обновление со следующим скриптом:

POST test/_update/1
{
  "script" : {
    "source": "ctx._source.counter += params.count",
    "lang": "painless",
    "params" : {
      "count" : 4
    }
  }
}

Аналогично, вы можете использовать и обновлять скрипт для добавления тега в список тегов (это просто список, поэтому тег добавляется, даже если он уже существует):

POST test/_update/1
{
  "script": {
    "source": "ctx._source.tags.add(params.tag)",
    "lang": "painless",
    "params": {
      "tag": "blue"
    }
  }
}

Вы также можете удалить тег из списка тегов. Функция Painless для remove тега принимает индекс массива элемента, который вы хотите удалить. Для предотвращения возможной ошибки во время выполнения, сначала необходимо убедиться, что тег существует. Если список содержит дубликаты тега, этот скрипт удаляет только одно вхождение.

POST test/_update/1
{
  "script": {
    "source": "if (ctx._source.tags.contains(params.tag)) { ctx._source.tags.remove(ctx._source.tags.indexOf(params.tag)) }",
    "lang": "painless",
    "params": {
      "tag": "blue"
    }
  }
}

Вы также можете добавлять и удалять поля из документа. Например, этот скрипт добавляет поле new_field:

POST test/_update/1
{
  "script" : "ctx._source.new_field = 'value_of_new_field'"
}

Напротив, этот скрипт удаляет поле new_field:

POST test/_update/1
{
  "script" : "ctx._source.remove('new_field')"
}

Следующий скрипт удаляет подполе из поля объекта:

POST test/_update/1
{
  "script": "ctx._source['my-object'].remove('my-subfield')"
}

Вместо обновления документа, вы также можете изменить выполняемую операцию внутри скрипта. Например, этот запрос удаляет документ, если поле tags содержит green, иначе ничего не делает (noop):

POST test/_update/1
{
  "script": {
    "source": "if (ctx._source.tags.contains(params.tag)) { ctx.op = 'delete' } else { ctx.op = 'none' }",
    "lang": "painless",
    "params": {
      "tag": "green"
    }
  }
}

Следующее частичное обновление добавляет новое поле в существующий документ:

POST test/_update/1
{
  "doc": {
    "name": "new_name"
  }
}

Если оба doc и script указаны, то doc игнорируется. Если вы указываете скриптовое обновление, включите поля, которые нужно обновить, в скрипт.

По умолчанию обновления, которые ничего не изменяют, обнаруживают это и возвращают "result": "noop":

POST test/_update/1
{
  "doc": {
    "name": "new_name"
  }
}

Если значение name уже new_name, запрос на обновление игнорируется, и элемент result в ответе возвращает noop:

{
   "_shards": {
        "total": 0,
        "successful": 0,
        "failed": 0
   },
   "_index": "test",
   "_type": "_doc",
   "_id": "1",
   "_version": 2,
   "_primary_term": 1,
   "_seq_no": 1,
   "result": "noop"
}

Вы можете отключить это поведение, установив "detect_noop": false:

POST test/_update/1
{
  "doc": {
    "name": "new_name"
  },
  "detect_noop": false
}

Если документ ещё не существует, содержимое элемента upsert вставляется как новый документ. Если документ существует, выполняется script:

POST test/_update/1
{
  "script": {
    "source": "ctx._source.counter += params.count",
    "lang": "painless",
    "params": {
      "count": 4
    }
  },
  "upsert": {
    "counter": 1
  }
}

Чтобы запустить скрипт независимо от наличия документа, установите scripted_upsert в true:

POST test/_update/1
{
  "scripted_upsert": true,
  "script": {
    "source": """
      if ( ctx.op == 'create' ) {
        ctx._source.counter = params.count
      } else {
        ctx._source.counter += params.count
      }
    """,
    "params": {
      "count": 4
    }
  },
  "upsert": {}
}

Вместо отправки частичного doc плюс документа upsert, вы можете установить doc_as_upsert в true, чтобы использовать содержимое doc в качестве значения upsert:

POST test/_update/1
{
  "doc": {
    "name": "new_name"
  },
  "doc_as_upsert": true
}