com.apple.foundationdb.record.query

Class RecordQuery

java.lang.Object

com.apple.foundationdb.record.query.RecordQuery

@API(value=STABLE)
public class RecordQuery
extends Object

The logical form of a query. A query mainly consists of:

• The names of the record type(s) to query.
• A QueryComponent filter.
• A sort key.

Executing a query means returning records of the given type(s) that match the filter in the indicated order.

See Also:

RecordQueryPlanner.plan(com.apple.foundationdb.record.query.RecordQuery)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordQuery.Builder A builder for RecordQuery.

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	ALL_TYPES

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAllowedIndexes()
QueryComponent	getFilter()
Collection<String>	getRecordTypes()
List<KeyExpression>	getRequiredResults()
KeyExpression	getSort()
boolean	hasAllowedIndexes()
boolean	isSortReverse()
static RecordQuery.Builder	newBuilder()
boolean	removesDuplicates()
RecordQuery.Builder	toBuilder()
String	toString()
void	validate(RecordMetaData metaData) Validates that this record query is valid with the provided metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL_TYPES

public static final Collection<String> ALL_TYPES

Method Detail

getRecordTypes

@Nonnull
public Collection<String> getRecordTypes()

hasAllowedIndexes

public boolean hasAllowedIndexes()

getAllowedIndexes

@Nullable
public Collection<String> getAllowedIndexes()

getFilter

@Nullable
public QueryComponent getFilter()

getSort

@Nullable
public KeyExpression getSort()

isSortReverse

public boolean isSortReverse()

removesDuplicates

public boolean removesDuplicates()

getRequiredResults

@Nullable
public List<KeyExpression> getRequiredResults()

validate

public void validate(@Nonnull
                     RecordMetaData metaData)

Validates that this record query is valid with the provided metadata.

Parameters:

metaData - the metadata that you want to use with this query

toString

public String toString()

Overrides:

toString in class Object

newBuilder

public static RecordQuery.Builder newBuilder()

toBuilder

public RecordQuery.Builder toBuilder()