search

command
v0.25.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 16, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

README

Indexing and full text search

Search Service

Store and search JSON documents. The Search API provides full indexing and text search.

Powered by OpenSearch.

Search for a given word or phrase in a particular field of a document. Combine multiple with either AND or OR boolean operators to create complex queries.

Usage

Documents are inserted using the /search/index endpoint. Document fields are automatically indexed with no need to define which fields to index ahead of time. Documents are logically grouped in to indexes so you may have an index for customers and one for products. Once documents are inserted you are ready to search, simple as that.

Search 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

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

first_name == 'John'

String values support single or double quotes.

Values can also be numbers

age == 37

or booleans

verified == true

You can search on fields that are nested in the document using dot (.) as a separator

address.city == 'London'

The API also supports wildcard * matching to enable scenarios like autocomplete.

first_name == 'Joh*'

In addition to equality == the API support greater than or equals >= and less than or equals <= operators

age >= 37
age <= 37

Simple queries can be combined with logical and

first_name == "John" AND age <= 37

or logical or

first_name == "John" OR first_name == "Jane"

If combining and and or operations you will need to use parentheses to explicitly define precedence

(first_name == "John" OR first_name == "Jane") AND age <= 37 

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL