Мы построили нашу базу данных как разработчики для разработчиков. Поэтому мы всегда хотим, чтобы у вас были надежные инструменты, необходимые для быстрой и удобной работы.
cURL-синтаксис
Мы используем HTTP-запросы для общения с ColdDB. HTTP-запрос состоит из нескольких компонентов, таких как URL-адрес для запроса, HTTP-глаголы (GET, POST и т. д.) и заголовки. Для краткого и последовательного описания HTTP-запросов в документации ColdDB используется синтаксис командной строки cURL. Это также стандартная практика описания запросов к ColdDB в сообществе пользователей.
Пример HTTP-запроса с использованием синтаксиса CURL выглядит следующим образом:
Простой поисковый запрос с использованием cURL.
curl -XPOST "https://localhost:8080/search" -d'
{
"query": {
"match_all": {}
}
}'
Приведенный выше фрагмент при выполнении в консоли запускает программу cURL
с тремя аргументами. Первый аргумент, -XPOST, означает, что запрос,
который делает cURL, должен использовать HTTP verb. POST. Второй аргумент — это
URL -адрес, по которому должен быть сделан запрос. Последний аргумент -d'{…}'
использует флаг -d, который указывает cURL отправлять то, что следует за флагом,
в качестве данных HTTP POST.
Первая запись "Hello, world!"
Во-первых, давайте добавим документ в хранилище простой документ:
Индексирование простого документа с помощью cURL.
curl -XPOST "https://localhost:8080/MY-DATASTORE/MESSAGE" -d'
{
"text": "Hello, world!"
}'
Теперь давайте посмотрим, сможем ли мы найти его, выполнив поиск "привет":
Поисковый запрос по слову "hello".
curl -XPOST "https://localhost:8080/search" -d'
{
"query": {
"query_string": {
"query": "hello"
}
}
}'
Ответ ColdDB на второй HTTP-запрос должен выглядеть так, как показано ниже,
и содержать одно обращение.
Пример ответа ColdDB на вышеуказанный запрос.
{
"hits": {
"total": 1,
"hits": [
{
"_type": "message",
"_id": " {626DF4EE-8A62-4689-9E64-B15FDB26F597}",
"_source": {
"text": "Hello, world!"
}
}
]
}
}