com.google.gerrit.server.index

Interface ChangeIndex

All Known Implementing Classes:

DummyIndex

public interface ChangeIndex

Secondary index implementation for change documents.

ChangeData objects are inserted into the index and are queried by converting special Predicate instances into index-aware predicates that use the index search results as a source.

Implementations must be thread-safe and should batch inserts/updates where appropriate.

Method Summary

Modifier and Type	Method and Description
void	close() Close this index.
void	delete(com.google.gerrit.reviewdb.client.Change.Id id) Delete a change document from the index by id.
void	deleteAll() Delete all change documents from the index.
Schema<ChangeData>	getSchema()
ChangeDataSource	getSource(Predicate<ChangeData> p, int start, int limit) Convert the given operator predicate into a source searching the index and returning only the documents matching that predicate.
void	markReady(boolean ready) Mark whether this index is up-to-date and ready to serve reads.
void	replace(ChangeData cd) Update a change document in the index.

Method Detail

getSchema

Schema<ChangeData> getSchema()

Returns:

the schema version used by this index.

close

void close()

Close this index.

replace

void replace(ChangeData cd)
      throws java.io.IOException

Update a change document in the index.

Semantically equivalent to deleting the document and reinserting it with new field values. A document that does not already exist is created. Results may not be immediately visible to searchers, but should be visible within a reasonable amount of time.

Parameters:

cd - change document

Throws:

java.io.IOException

delete

void delete(com.google.gerrit.reviewdb.client.Change.Id id)
     throws java.io.IOException

Delete a change document from the index by id.

Parameters:

id - change id

Throws:

java.io.IOException

deleteAll

void deleteAll()
        throws java.io.IOException

Delete all change documents from the index.

Throws:

java.io.IOException

getSource

ChangeDataSource getSource(Predicate<ChangeData> p,
                           int start,
                           int limit)
                    throws com.google.gerrit.server.query.QueryParseException

Convert the given operator predicate into a source searching the index and returning only the documents matching that predicate.

This method may be called multiple times for variations on the same predicate or multiple predicate subtrees in the course of processing a single query, so it should not have any side effects (e.g. starting a search in the background).

Parameters:

p - the predicate to match. Must be a tree containing only AND, OR, or NOT predicates as internal nodes, and IndexPredicates as leaves.

start - offset in results list at which to start returning results.

limit - maximum number of results to return.

Returns:

a source of documents matching the predicate. Documents must be returned in descending updated timestamp order.

Throws:

com.google.gerrit.server.query.QueryParseException - if the predicate could not be converted to an indexed data source.

markReady

void markReady(boolean ready)
        throws java.io.IOException

Mark whether this index is up-to-date and ready to serve reads.

Parameters:

ready - whether the index is ready

Throws:

java.io.IOException