Interface SearchEngine

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ElasticsearchEngine, SqlSearchEngine

public interface SearchEngine
extends Closeable

A full-text search engine: documents in named indexes, found by text.

A document is a Map of strings, numbers, booleans, lists and nested maps; every string in it is searchable. Index names are lowercase letters, digits, - and _, the subset every engine accepts.

Method Summary

Modifier and Type	Method	Description
void	close()	Releases connections.
boolean	delete(String index, String id)	Removes a document; returns whether there was one.
void	deleteIndex(String index)	Removes an index and every document in it; a missing one is not an error.
Map	get(String index, String id)	The document stored under id, or null.
void	index(String index, String id, Map document)	Adds a document under id, replacing any already there.
void	refresh(String index)	Makes every write so far visible to search(String, SearchQuery).
SearchResult	search(String index, SearchQuery query)	Runs a query.

Method Details

index

void index(String index,
 String id,
 Map document)
    throws IOException

Adds a document under id, replacing any already there.

Throws:

IOException

delete

boolean delete(String index,
 String id)
        throws IOException

Removes a document; returns whether there was one.

Throws:

IOException

get

Map get(String index,
 String id)
 throws IOException

The document stored under id, or null.

Throws:

IOException

search

SearchResult search(String index,
 SearchQuery query)
             throws IOException

Runs a query.

Throws:

IOException

refresh

void refresh(String index)
      throws IOException

Makes every write so far visible to search(String, SearchQuery). Search clusters publish writes about once a second; tests and read-your-write flows call this.

Throws:

IOException

deleteIndex

void deleteIndex(String index)
          throws IOException

Removes an index and every document in it; a missing one is not an error.

Throws:

IOException

close

void close()

Releases connections. An engine from SearchEngines.current() is closed by the server and must not be closed by the caller.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable