/{db}/_design/{ddoc}/_nouveau/{index}

GET /{db}/_design/{ddoc}/_nouveau/{index}

Выполняет запрос nouveau к указанному индексу в указанном документе дизайна.

Параметры:

• db – Имя базы данных

• ddoc – Имя документа дизайна

• index – Имя индекса Nouveau

Заголовки запроса:

• Accept –

  • application/json

Параметры запроса:

• bookmark (string) – Закладка, полученная в результате предыдущего поиска. Этот параметр позволяет постранично просматривать результаты. Если после закладки результатов больше нет, в ответе будет пустой массив rows и та же закладка, подтверждающая, что список результатов закончился.

• counts (json) – Массив имен строковых полей, для которых требуется получить количество значений. Ответ содержит количество каждого уникального значения данного поля среди документов, соответствующих поисковому запросу.

• include_docs (boolean) – Включить в ответ полное содержимое документов.

• locale (string) – Локаль (Java), используемая для разбора чисел в запросах с диапазонами. Если параметр не указан, используется локаль JDK по умолчанию. Например: de , us, gb.

• limit (number) – Ограничить число возвращаемых документов указанным значением.

• q (string) – Обязательный параметр. Строка запроса Lucene.

• ranges (json) – Это поле задает диапазоны для числовых поисковых полей. Значение — объект JSON, в котором имена полей являются числовыми поисковыми полями, а значения полей — массивами объектов JSON. Объекты должны содержать значения label, min и max (соответственно строкового, числового и числового типа), а также необязательные свойства min_inclusive и max_inclusive (если они не указаны, используется значение true). Пример: {"bar":[{"label":"cheap","min":0,"max":100}]}

• sort (json) – Задает порядок сортировки результатов. По умолчанию результаты сортируются по релевантности. Строка JSON вида "fieldname" или "-fieldname" для сортировки по убыванию, где fieldname — имя строкового или double-поля. Для сортировки по одному полю можно указать строку, а для сортировки по нескольким полям — массив строк; поля будут отсортированы в порядке их следования в массиве. Например: "relevance", "bar", "-foo" и ["-foo", "bar"].

• top_n (number) – Ограничить число фасетов, возвращаемых группой. По умолчанию — 10, максимальное значение — 1000.

• update (boolean) – Установите значение false, чтобы разрешить использование устаревшего индекса.

Заголовки ответа:

• Content-Type –

  • application/json

• Transfer-Encoding – chunked

Объект JSON ответа:

• hits (array) – Массив результатов поиска. По умолчанию возвращаемые сведения содержат только идентификатор документа и ревизию.

• total_hits (number) – Число совпадений с запросом.

• total_hits_relation (string) – EQUAL_TO, если total_hits является точным. GREATER_THAN_OR_EQUAL_TO в противном случае.

• bookmark (string) – Непрозрачный идентификатор для постраничного просмотра результатов.

Коды состояния:

• 200 OK – Запрос успешно выполнен

• 400 Bad Request – Некорректный запрос

• 401 Unauthorized – Требуется разрешение на чтение

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 404 Not Found – Указанная база данных, документ дизайна или представление не найдены

/{db}/_design/{ddoc}/_nouveau_info/{index}

GET /{db}/_design/{ddoc}/_nouveau_info/{index}

Параметры:

• db – Имя базы данных

• ddoc – Имя документа дизайна

• index – Имя поискового индекса

Коды состояния:

• 200 OK – Запрос успешно выполнен

• 400 Bad Request – Тело запроса некорректно (имеет неверный формат или в нем отсутствует обязательное поле)

• 401 Unauthorized – Неавторизованный запрос к защищенному API

• 403 Forbidden – Недостаточно прав / Слишком много запросов с недействительными учетными данными

• 500 Internal Server Error – Произошла ошибка сервера (или ошибка другого типа)

Запрос:

GET /recipes/_design/cookbook/_nouveau_info/ingredients HTTP/1.1
Accept: application/json
Host: localhost:5984

Ответ:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "name": "_design/cookbook/ingredients",
    "search_index": {
        "num_docs": 1000,
        "update_seq": 5000,
        "disk_size": 1048576
    }
}