magista-dsl/README.md
2018-11-20 16:25:50 +03:00

26 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# magista-dsl
Для формирования запросов к данным библиотека предоставляет DSL в JSON формате, который основан на Elasticsearch [Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/_introducing_the_query_language.html).
Общий формат запроса выглядит следующим образом:
```json
{
"query": {
"<query_type>": {
"<param>": "<val>"
},
"<query_param>": "<val>"
}
}
```
`<query_type>` - тип запроса, который требуется выполнить. `<query_param>` зависит от типа запроса.
`<query_param>` - параметр запроса, может включать:
1. Для запросов на выборку по моделям:
1. `from` (__deprecated__) - (0-based) определяет, с какой записи результирующей выборки следует начать. Вместо этого поля необходимо использовать continuationToken, на основании которого оно будет вычисляться.
2. `size` - определяет, сколько максимум записей следует вернуть, начиная с `from`.