Nouveau

Типы полей

В настоящее время Nouveau поддерживает четыре типа полей, каждый из которых отличается семантикой.

Текст

Текстовое поле — наиболее распространённый тип поля. Значение поля анализируется во время индексирования, что позволяет эффективно выполнять поиск по отдельным словам в нём (а также с помощью подстановочных знаков, регулярных выражений и т. д.). Этот тип поля не подходит для сортировки, запросов по диапазону и фасетного поиска.

Строка

В строковом поле значение индексируется как один токен без анализа (то есть без приведения регистра, удаления распространённых суффиксов и т. д.). Этот тип поля рекомендуется использовать для сортировки и фасетного поиска. Выполнять поиск по строковым полям можно, но в определении индекса для этого поля необходимо указать анализатор keyword, чтобы запросы не анализировались.

Число с плавающей точкой двойной точности

Для поля типа double требуется числовое значение. Оно подходит для сортировки, запросов по диапазону и фасетного поиска по диапазонам.

Хранимое

Хранимое поле сохраняет значение поля в индексе без анализа. Это значение возвращается в результатах поиска, но по хранимому полю нельзя выполнять поиск, сортировку, запросы по диапазону или фасетный поиск.

Функции индексирования

Попытка индексировать данные с помощью несуществующего поля приведёт к ошибке. Чтобы избежать этой проблемы, используйте соответствующее защитное условие.

Функция, содержащаяся в поле индекса, — это функция JavaScript, вызываемая для каждого документа в базе данных. Она принимает документ в качестве параметра, извлекает из него данные, а затем вызывает функцию, определённую в поле index, чтобы индексировать эти данные.

Функция index принимает четыре параметра, третий из которых необязателен.

1. Первый параметр — тип поля.

2. Второй параметр — имя поля, которое вы собираетесь использовать при запросах к индексу и указывать в синтаксисе Lucene в последующих запросах. Пример приведён в следующем запросе:

   q=color:red

   Имя поля Lucene color — это первый параметр функции index.

   Если при определении имени используется специальное значение "default", указывать имя поля во время выполнения запроса не требуется. Благодаря этому запрос можно упростить:

   q=red

3. Третий параметр — индексируемые данные. При индексировании данных учитывайте следующее:

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

   • Если во время выполнения функции возникнет ошибка по этой или другой причине, документ не будет добавлен в поисковый индекс.

4. Четвёртый, необязательный параметр — объект JavaScript со следующими полями:

   Функция индексирования (необязательный параметр)

   • store — если значение равно true, значение возвращается в результатах поиска; в противном случае оно не возвращается. Допустимые значения: true или false. Значение по умолчанию — false.

   Примечание

   Если не задать параметр store, результаты индексирования данных документа не будут возвращаться в ответ на запрос.

Пример функции поискового индексирования:

function(doc) {
    if (typeof(doc.min_length) == 'number') {
        index("double", "min_length", doc.min_length, {"store": true});
    }
    if (typeof(doc.diet) == 'string') {
        index("string", "diet", doc.diet, {"store": true});
    }
    if (typeof(doc.latin_name) == 'string') {
        index("string", "latin_name", doc.latin_name, {"store": true});
    }
    if (typeof(doc.class) == 'string') {
        index("string", "class", doc.class, {"store": true});
    }
}

index("double", "min_length", doc.min_length, {"store": true});

if (doc.foo.bar) {
    index("string", "bar", doc.foo.bar, {"store": true});
}

if (doc.foo && typeof(doc.foo) == 'object' && typeof(doc.foo.bar == 'string')) {
    index("string", "bar", doc.foo.bar, {"store": true});
}

if (doc.min_length) {
  index("double", "min_length", doc.min_length, {"store": true});
}

if (typeof(doc.min_length == 'number')) {
  index("double", "min_length", doc.min_length, {"store": true});
}

Анализаторы

Анализаторы преобразуют текстовый ввод в tokens, по которым можно выполнять поиск. Обычно анализаторы используют разные правила разбиения входных данных на токены: они могут переводить весь текст в нижний регистр, пропускать целые слова (обычно настолько распространённые, что вряд ли полезны для поиска) или пропускать части слов (например, удалять ing суффиксы в английском языке):

Мы предоставляем множество анализаторов Lucene, а один создали самостоятельно (simple_asciifolding);

• arabic

• armenian

• basque

• bulgarian

• catalan

• chinese

• cjk

• classic

• czech

• danish

• dutch

• email

• english

• finnish

• french

• galician

• german

• hindi

• hungarian

• indonesian

• irish

• italian

• japanese

• keyword

• latvian

• norwegian

• persian

• polish

• portugese

• romanian

• russian

• simple

• simple_asciifolding

• spanish

• standard

• swedish

• thai

• turkish

• whitespace

Пример документа анализатора:

{
    "_id": "_design/analyzer_example",
    "nouveau": {
        "INDEX_NAME": {
            "index": "function (doc) { ... }",
            "default_analyzer": "$ANALYZER_NAME"
        }
    }
}

{
    "_id": "_design/analyzer_example",
    "nouveau": {
        "INDEX_NAME": {
            "default_analyzer": "english",
            "field_analyzers": {
                "spanish": "spanish",
                "german": "german"
            },
            "index": "function (doc) { ... }"
        }
    }
}

POST /_nouveau_analyze HTTP/1.1
Content-Type: application/json
{"analyzer":"keyword", "text":"ablanks@renovations.com"}

curl 'https://$HOST:5984/_nouveau_analyze' -H 'Content-Type: application/json'
    -d '{"analyzer":"keyword", "text":"ablanks@renovations.com"}'

{
    "tokens": [
        "ablanks@renovations.com"
    ]
}

POST /_nouveau_analyze HTTP/1.1
Content-Type: application/json
{"analyzer":"standard", "text":"ablanks@renovations.com"}

curl 'https://$HOST:5984/_nouveau_analyze' -H 'Content-Type: application/json'
    -d '{"analyzer":"standard", "text":"ablanks@renovations.com"}'

{
    "tokens": [
        "ablanks",
        "renovations.com"
    ]
}

Запросы

После создания поискового индекса можно выполнять запросы к нему.

• Выполните запрос к разделу с помощью: GET /$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/_nouveau/$INDEX_NAME

• Выполните глобальный запрос с помощью: GET /$DATABASE/_design/$DDOC/_nouveau/$INDEX_NAME

Укажите поисковый запрос с помощью параметра q.

Пример запроса к секционированному индексу с помощью HTTP:

GET /$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/_nouveau/$INDEX_NAME?include_docs=true&q=*:*&limit=1 HTTP/1.1
Content-Type: application/json

Пример запроса к глобальному индексу с помощью HTTP:

GET /$DATABASE/_design/$DDOC/_nouveau/$INDEX_NAME?include_docs=true&q=*:*&limit=1 HTTP/1.1
Content-Type: application/json

Пример запроса к секционированному индексу из командной строки:

curl https://$HOST:5984/$DATABASE/_partition/$PARTITION_KEY/_design/$DDOC/
_nouveau/$INDEX_NAME?include_docs=true\&q=*:*\&limit=1 \

Пример запроса к глобальному индексу из командной строки:

curl https://$HOST:5984/$DATABASE/_design/$DDOC/_nouveau/$INDEX_NAME?
include_docs=true\&q=*:*\&limit=1 \

POST /db/_design/ddoc/_nouveau/searchname HTTP/1.1
Content-Type: application/json

curl 'https://$HOST:5984/db/_design/ddoc/_nouveau/searchname' -X POST -H 'Content-Type: application/json' -d @search.json

{
    "q": "index:my query",
    "sort": "foo",
    "limit": 3
}

Синтаксис запросов

Синтаксис поисковых запросов CouchDB основан на синтаксисе Lucene. Поисковые запросы имеют вид name:value; если имя не указано, используется поле по умолчанию, как показано в следующих примерах:

Примеры выражений поисковых запросов:

// Birds
class:bird

// Animals that begin with the letter "l"
l*

// Carnivorous birds
class:bird AND diet:carnivore

// Herbivores that start with letter "l"
l* AND diet:herbivore

// Medium-sized herbivores
min_length:[1 TO 3] AND diet:herbivore

// Herbivores that are 2m long or less
diet:herbivore AND min_length:[* TO 2]

// Mammals that are at least 1.5m long
class:mammal AND min_length:[1.5 TO *]

// Find "Meles meles"
latin_name:"Meles meles"

// Mammals who are herbivore or carnivore
diet:(herbivore OR omnivore) AND class:mammal

// Return all results
*:*

Запросы к нескольким полям можно логически объединять, а группы и поля можно дополнительно группировать. Доступны следующие логические операторы с учётом регистра: AND, +, OR, NOT и -. Запросы по диапазону можно выполнять для строк и чисел.

Для нечёткого поиска можно добавить к запросу ~, чтобы найти термины, похожие на поисковый термин. Например, look~ находит термины book и took.

Важность поискового термина можно изменить, добавив ^ и положительное число. Это изменение повышает или понижает релевантность совпадений, содержащих термин, пропорционально степени указанного коэффициента. Значение по умолчанию — 1, то есть сила совпадения не увеличивается и не уменьшается. Десятичное значение от 0 до 1 снижает важность и ослабляет совпадение. Значение больше единицы повышает важность и усиливает совпадение.

Поддерживается поиск с подстановочными знаками как для одного (?), так и для нескольких (*) символов. Например, dat? соответствует date и data, тогда как dat* соответствует date, data, database и dates. Подстановочные знаки должны стоять после поискового термина.

Используйте *:*, чтобы вернуть все результаты.

Для поиска по следующим символам их необходимо экранировать:

+ - && || ! ( ) { } [ ] ^ " ~ * ? : \ /

Чтобы экранировать один из этих символов, поставьте перед ним обратную косую черту (\).

Ответ на поисковый запрос содержит поле order для каждого результата. Поле order — это массив, первый элемент которого содержит поле или поля, указанные в параметре sort. См. параметр sort. Если параметр sort не указан в запросе, поле order содержит оценку релевантности Lucene.

function(doc) {
    index("string", "type", doc.type);
    index("double", "price", doc.price);
}

if (typeof doc.town == "string" && typeof doc.name == "string") {
    index("string", "town", doc.town);
    index("string", "name", doc.name);
   }

?q=*:*&counts=["type"]

{
    "total_rows":100000,
    "bookmark":"g...",
    "rows":[...],
    "counts":{
        "type":{
            "sofa": 10,
            "chair": 100,
            "lamp": 97
        }
    }
}

?q=*:*&ranges={"price":[{"label":"cheap","min":0,"max":"100","max_inclusive":false},{"label":"expensive","min":100}]}

{
    "total_rows":100000,
    "bookmark":"g...",
    "rows":[...],
    "ranges": {
        "price": {
            "expensive": 278682,
            "cheap": 257023
        }
    }
}