Проверка запросов и результатов вывода

Для проверки работоспособности, корректности синтаксиса запроса Query DSL и оценки результатов выводимых данных поставленным целям используется страница проверки запросов и результатов вывода.

На странице представлены две области: область текста запроса (слева) и область результатов его выполнения (справа).

image
Рисунок 1.

Введите текст запроса с область текста запроса и нажмите кнопку execute success в верхнем правом углу области. Результат выполнения запроса будет выведен в области результатов.

Если текст запроса содержит синтаксические или логические ошибки в области результатов будет выведен текст ошибки, например:

{
"error":
    {
    "reason": "Unexpected character (''' (code 39)): was expecting double-quote to start field name\n at [Source: org.opensearch.transport.netty4.ByteBufStreamInput@2ad7a491; line: 2, column: 10]",
    "root_cause":
        [
            {
            "reason": "Unexpected character (''' (code 39)): was expecting double-quote to start field name\n at [Source: org.opensearch.transport.netty4.ByteBufStreamInput@2ad7a491; line: 2, column: 10]",
            "type": "json_parse_exception"
            }
        ],
    "type": "json_parse_exception"
    },
"status": 500
}

В случае успешного выполнения будет выведен результат запроса и документы, удовлетворяющие запросу, например:

{
"_shards":
    {
    "failed": 0,
    "skipped": 0,
    "successful": 126,
    "total": 126
    },
"hits":
    {
    "hits":
        [
        ],
    "max_score": null,
    "total":
        {
        "relation": "eq",
        "value": 0
        }
    },
"timed_out": false,
"took": 37
}

Вывод содержит блоки информации:

  • took – длительность выполнения запроса в миллисекундах;

  • _shards – количество шардов, по которым был осуществлен поиск документов и выполнен запрос;

  • hits – количество найденных документов, удовлетворяющих условиям запроса;

  • hits.hits – содержимое полей документов, отбираемых в результате запроса.

Область текста запроса использует компактный формат синтаксиса схожий с cURL. Если вставить текст запроса в формате cURL, он будет автоматически транслирован в корректный синтаксис области текста запроса. Размер области текста запроса может быть изменен перемещением разделителя области запроса и области результатов.

Область текста запроса является интерактивной и в случае явных ошибок синтаксиса укажет на строки, в которых допущены ошибки.

Внешний вид страницы проверки запросов и результатов вывода может быть дополнительно настроен. Нажмите кнопку "Settings" в появившемся модальном окне.

Настройте необходимые параметры:

  • Font Size – используемый размер шрифта в обоих областях;

  • Wrap long lines – перенос строки в случае ее длины, превышающей размер области, для избегания горизонтальной полосы прокрутки;

  • Use triple quotes in output pane – использовать тройные кавычки в области результатов. Используется для возможности экранирования символов кавычек и сохранения их в строковых значениях;

  • Autocomplete – автодополнение вводимых имен в область текста запроса:

    • Fields – полей документов;

    • Indices & Aliases – индексов и алиасов;

    • Templates – шаблонов.

image
Рисунок 2.

Для сохранения настроек нажмите кнопку "Save". Для закрытия модального окна настроек без сохранения нажмите "Cancel" или кнопку cross grey.