Доступ к полям документа с помощью API полей

Используйте API field для доступа к полям документов:

field('my_field').get(<default_value>)

Данный API фундаментально изменяет способ доступа к документам в Painless. Раньше вам нужно было получить доступ к отображению doc с именем поля, которое вы хотели получить:

doc['my_field'].value

Доступ к полям документов таким способом не обрабатывал отсутствующие значения или отсутствующие отображения, что означало, что для написания надёжных скриптов Painless необходимо было включать логику проверки существования как полей, так и значений.

Вместо этого используйте API field, который является предпочтительным подходом к доступу к документам в Painless. API field обрабатывает отсутствующие значения и будет развиваться, чтобы абстрагировать доступ к _source и doc_values.

API field возвращает объект Field, который итерируется по полям с несколькими значениями, предоставляя доступ к базовому значению через метод get(<default_value>), а также методы преобразования типов и вспомогательные методы.

API field возвращает заданное значение по умолчанию, независимо от того, существует ли поле или имеются ли для текущего документа значения этого поля. Это означает, что API field может обрабатывать отсутствующие значения без необходимости дополнительной логики. Для типа ссылки, такого как keyword, значение по умолчанию может быть null. Для примитивного типа, такого как boolean или long, значение по умолчанию должно быть соответствующего примитивного типа, например, false или 1.

Вместо явного вызова API field с методом get(), вы можете использовать сокращение $. Просто укажите символ $, имя поля и значение по умолчанию, на случай, если поле не имеет значения:

$(‘field’, <default_value>)

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

if (doc.containsKey('start') && doc.containsKey('end')) {
   if (doc['start'].size() > 0 && doc['end'].size() > 0) {
       ZonedDateTime start = doc['start'].value;
       ZonedDateTime end = doc['end'].value;
       return ChronoUnit.MILLIS.between(start, end);
   } else {
       return -1;
   }
} else {
   return -1;
}

Используя API field, вы можете написать этот же скрипт намного более лаконично, без необходимости дополнительной логики для определения существования полей перед их использованием:

ZonedDateTime start = field('start').get(null);
ZonedDateTime end = field('end').get(null);
return start == null || end == null ? -1 : ChronoUnit.MILLIS.between(start, end)

В следующей таблице указаны типы отображаемых полей, поддерживаемые API field. Для каждого поддерживаемого типа перечислены значения, возвращаемые API field (из методов get и as<Type>) и отображением doc (из методов getValue и get).