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.

## 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 
```


Search.CreateIndex

Search.Delete

Search.DeleteIndex

Search.Index

Search.Search

Create an index

Delete a record

Delete an index

John Doe

Index a record

Search for a record

Search on multiple fields (AND)

Search on multiple fields (OR)

search

MicroAPIError

CreateIndexRequest

CreateIndexResponse

DeleteIndexRequest

DeleteIndexResponse

DeleteRequest

DeleteResponse

The name of the field. Use a `.` separator to define nested fields e.g. foo.bar

Field

Index a record i.e. insert a document to search for.

IndexRequest

The ID for this record. If blank, one will be generated

IndexResponse

Record

The query. See docs for query language examples

SearchRequest

SearchResponse

Search

Micro-Namespace

Search.CreateIndex(CreateIndexRequest)

SearchCreateIndexResponse

Error from the Micro API

Search.Delete(DeleteRequest)

SearchDeleteResponse

Search.DeleteIndex(DeleteIndexRequest)

SearchDeleteIndexResponse

Search.Index(IndexRequest)

{
  "record": {
    "data": {},
    "id": "et eli"
  }
}

SearchIndexResponse

Search.Search(SearchRequest)

SearchSearchResponse

search/Search

Search

Create Index

POST /v1/search/CreateIndex

Request

Response

Delete

POST /v1/search/Delete

Request

Response

Delete Index

POST /v1/search/DeleteIndex

Request

Response

Index

POST /v1/search/Index

Request

Response

Search

POST /v1/search/Search

Request

Response

Downloads

Postman JSON

OpenAPI JSON