mirror of
https://github.com/kevin-DL/services.git
synced 2026-01-11 19:04:35 +00:00
76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
Indexing and full text search
|
|
|
|
# Search Service
|
|
|
|
Store and search JSON records. The Search API provides indexing and full text search.
|
|
Search for a word or phrase in a particular field of a record. Combine multiple with
|
|
either `AND` or `OR` boolean operators to create complex queries.
|
|
|
|
Powered by [OpenSearch](https://opensearch.org/).
|
|
|
|
## Query Language
|
|
|
|
The search API supports a simple query language to let you get to your data quickly without having to learn a complicated language.
|
|
|
|
The most basic query looks like this
|
|
|
|
```sql
|
|
key == 'value'
|
|
```
|
|
|
|
where you specify a key and a value to find. For example you might want to look for every customer with first name of John
|
|
|
|
```sql
|
|
first_name == 'John'
|
|
```
|
|
|
|
String values support single or double quotes.
|
|
|
|
Values can also be numbers
|
|
|
|
```sql
|
|
age == 37
|
|
```
|
|
|
|
or booleans
|
|
|
|
```sql
|
|
verified == true
|
|
```
|
|
|
|
You can search on fields that are nested in the record using dot (`.`) as a separator
|
|
|
|
```sql
|
|
address.city == 'London'
|
|
```
|
|
|
|
The API also supports wildcard `*` matching to enable scenarios like autocomplete.
|
|
|
|
```sql
|
|
first_name == 'Joh*'
|
|
```
|
|
|
|
In addition to equality `==` the API support greater than or equals `>=` and less than or equals `<=` operators
|
|
|
|
```sql
|
|
age >= 37
|
|
age <= 37
|
|
```
|
|
|
|
Simple queries can be combined with logical `and`
|
|
|
|
```sql
|
|
first_name == "John" AND age <= 37
|
|
```
|
|
|
|
or logical `or`
|
|
```sql
|
|
first_name == "John" OR first_name == "Jane"
|
|
```
|
|
|
|
If combining `and` and `or` operations you will need to use parentheses to explicitly define precedence
|
|
|
|
```sql
|
|
(first_name == "John" OR first_name == "Jane") AND age <= 37
|
|
```
|