com.mapr.ojai.store.impl

Class OjaiQuery

java.lang.Object

com.mapr.ojai.store.impl.OjaiQuery

All Implemented Interfaces:

org.ojai.Buildable, org.ojai.store.Query

public class OjaiQuery
extends java.lang.Object
implements org.ojai.store.Query

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.base.Equivalence<OjaiQuery>	EQUIVALENCE
static long	LIMIT_NONE Special value that indicates no limit has been set.
static int	MAX_CLIENT_SORT_LIMIT
static long	OFFSET_NONE Special value that indicates no offset has been set.
static long	TIMEOUT_NONE Special value that indicates no timeout has been set.

Constructor Summary

Constructors

Constructor and Description
OjaiQuery(org.ojai.store.Query theQuery) Copy Constructor.

Method Summary

Modifier and Type	Method and Description
OjaiQuery	build()
java.lang.String	buildSqlString(java.lang.String engineName, java.lang.String tableName)
org.ojai.DocumentStream	createDrillStream(OjaiConnection ojaiConnection, SharedTable sharedTable, QueryContext queryContext)
org.ojai.DocumentStream	decorateStream(org.ojai.DocumentStream docStream, OjaiConnection ojaiConnection, boolean isIndexSorted, java.util.List<org.ojai.FieldPath> sortLimitExtras, SharedResource<com.mapr.db.impl.BaseJsonTable> sharedTable) Adds final post-processing steps to a DocumentStream based on query options such as limit and offset.
com.mapr.db.impl.ConditionImpl	getCondition() Get the query condition.
java.util.List<EligibleIndex>	getEligibleIndexes(com.mapr.db.Admin admin, org.apache.hadoop.fs.Path tablePath, SharedTable sharedPrimaryTable, OjaiConnection ojaiConnection)
com.mapr.db.index.IndexFieldDesc.Order	getFieldOrdering(org.ojai.FieldPath fieldPath) Get the Order for a sort key element.
boolean	getForceDirect()
boolean	getForceDrill()
boolean	getForceNonCoveringSort()
java.lang.String	getIndexHint() Get the index hint, if any.
long	getLimit() Returns the limit.
long	getOffset() Returns the offset.
java.lang.Object	getOption(java.lang.String optionName)
org.ojai.Document	getOptions() Allow other parts of the implementation to see the current options.
java.util.Set<org.ojai.FieldPath>	getOrderByFields()
java.util.Set<org.ojai.FieldPath>	getProjectedFieldSet()
double	getRowCpuIoRatio()
org.ojai.store.QueryCondition	getScanCondition(OjaiConnection ojaiConnection, EligibleIndex eligibleIndex)
org.ojai.FieldPath[]	getSelectListAsArray()
java.util.List<org.ojai.FieldPath>	getSortLimitExtras() Return the list of extra fields that would be required in order to perform a client-side sort for a sort limit case.
boolean	hasCondition() Indicate if the query has a condition or not.
boolean	hasOrderBy()
boolean	hasProjectionWithArrayIndex()
boolean	includeId() Indicates whether or not we should include the id field in the result.
boolean	isIdIn() Determines if the query is of the form "_id in (x, y, ...)"; also recognizes "_id = x or _id = y or ..." for any number of ids.
boolean	isPossiblyNeedProjection()
boolean	isSortLimit() Indicates that the query has both a sort and a limit, and that the limit is within the maximum allowed for a client-side sort.
boolean	isSortOnId() Returns true if the sort (orderBy) is on _id ascending.
boolean	isStarQuery()
OjaiQuery	limit(long limit)
OjaiQuery	offset(long offset)
OjaiQuery	orderBy(org.ojai.FieldPath... fieldPaths)
OjaiQuery	orderBy(org.ojai.FieldPath fieldPath, org.ojai.store.SortOrder sortOrder)
OjaiQuery	orderBy(java.lang.String... stringPaths)
OjaiQuery	orderBy(java.lang.String field, org.ojai.store.SortOrder order)
OjaiQuery	orderBy(java.lang.String field, java.lang.String order)
OjaiQuery	select(org.ojai.FieldPath... fieldPaths)
OjaiQuery	select(java.lang.String... fieldPaths)
OjaiQuery	setOption(java.lang.String optionName, java.lang.Object value)
OjaiQuery	setOptions(org.ojai.Document options)
OjaiQuery	setTimeout(long timeoutInMilliseconds)
boolean	structuralEquals(OjaiQuery otherQuery) Determines if two queries are structurally equal.
int	structuralHashCode() Computes the structural hashCode() for the query.
OjaiQuery	waitForTrackedWrites(java.lang.String writesContext)
OjaiQuery	where(org.ojai.store.QueryCondition queryCond)
OjaiQuery	where(java.lang.String conditionJson)

Methods inherited from class java.lang.Object

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

Field Detail

LIMIT_NONE

public static final long LIMIT_NONE

Special value that indicates no limit has been set.

See Also:

Constant Field Values

MAX_CLIENT_SORT_LIMIT

public static final int MAX_CLIENT_SORT_LIMIT

OFFSET_NONE

public static final long OFFSET_NONE

Special value that indicates no offset has been set.

See Also:

Constant Field Values

EQUIVALENCE

public static final com.google.common.base.Equivalence<OjaiQuery> EQUIVALENCE

TIMEOUT_NONE

public static final long TIMEOUT_NONE

Special value that indicates no timeout has been set.

See Also:

Constant Field Values

Constructor Detail

OjaiQuery

public OjaiQuery(org.ojai.store.Query theQuery)

Copy Constructor.

Parameters:

theQuery - original query

Method Detail

getLimit

public long getLimit()

Returns the limit. Limits must be >= 0, so we can use the special value LIMIT_NONE to indicate that no limit has been set.

Returns:

the limit

getOffset

public long getOffset()

Returns the offset. Offsets must be >= 0, so we can use the special value OFFSET_NONE to indicate that no offset has been set.

Returns:

the offset

hasCondition

public boolean hasCondition()

Indicate if the query has a condition or not.

Returns:

true if there is a condition (a "where clause"), false otherwise.

getCondition

public com.mapr.db.impl.ConditionImpl getCondition()

Get the query condition. Note that the condition may be empty, which can be determined by using hasCondition().

Returns:

the query condition

getSelectListAsArray

public org.ojai.FieldPath[] getSelectListAsArray()

setOption

public OjaiQuery setOption(java.lang.String optionName,
                           java.lang.Object value)
                    throws java.lang.IllegalArgumentException

Specified by:

setOption in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

getOption

public java.lang.Object getOption(java.lang.String optionName)

Specified by:

getOption in interface org.ojai.store.Query

setOptions

public OjaiQuery setOptions(org.ojai.Document options)
                     throws java.lang.IllegalArgumentException

Specified by:

setOptions in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

getOptions

public org.ojai.Document getOptions()

Allow other parts of the implementation to see the current options. The caller promises not to change the options document, it is not a copy.

Returns:

the options document, or null if there are none set

select

public OjaiQuery select(java.lang.String... fieldPaths)
                 throws java.lang.IllegalArgumentException

Specified by:

select in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

select

public OjaiQuery select(org.ojai.FieldPath... fieldPaths)
                 throws java.lang.IllegalArgumentException

Specified by:

select in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

where

public OjaiQuery where(java.lang.String conditionJson)
                throws org.ojai.exceptions.OjaiException,
                       java.lang.IllegalArgumentException

Specified by:

where in interface org.ojai.store.Query

Throws:

org.ojai.exceptions.OjaiException

java.lang.IllegalArgumentException

where

public OjaiQuery where(org.ojai.store.QueryCondition queryCond)
                throws org.ojai.exceptions.OjaiException,
                       java.lang.IllegalArgumentException

Specified by:

where in interface org.ojai.store.Query

Throws:

org.ojai.exceptions.OjaiException

java.lang.IllegalArgumentException

orderBy

public OjaiQuery orderBy(java.lang.String... stringPaths)
                  throws java.lang.IllegalArgumentException

Specified by:

orderBy in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

orderBy

public OjaiQuery orderBy(org.ojai.FieldPath... fieldPaths)
                  throws java.lang.IllegalArgumentException

Specified by:

orderBy in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

orderBy

public OjaiQuery orderBy(java.lang.String field,
                         java.lang.String order)
                  throws java.lang.IllegalArgumentException

Specified by:

orderBy in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

orderBy

public OjaiQuery orderBy(java.lang.String field,
                         org.ojai.store.SortOrder order)
                  throws java.lang.IllegalArgumentException

Specified by:

orderBy in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

orderBy

public OjaiQuery orderBy(org.ojai.FieldPath fieldPath,
                         org.ojai.store.SortOrder sortOrder)
                  throws java.lang.IllegalArgumentException

Specified by:

orderBy in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

offset

public OjaiQuery offset(long offset)
                 throws java.lang.IllegalArgumentException

Specified by:

offset in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

limit

public OjaiQuery limit(long limit)
                throws java.lang.IllegalArgumentException

Specified by:

limit in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

buildSqlString

public java.lang.String buildSqlString(java.lang.String engineName,
                                       java.lang.String tableName)

isIdIn

public boolean isIdIn()

Determines if the query is of the form "_id in (x, y, ...)"; also recognizes "_id = x or _id = y or ..." for any number of ids.

Returns:

true if this is an "_id in (...) query"

structuralEquals

public boolean structuralEquals(OjaiQuery otherQuery)

Determines if two queries are structurally equal. This is true when the two queries are the same except for any literals (usually the leaves in comparison operators).

Parameters:

otherQuery - the other query

Returns:

true if structurally equal, false otherwise

structuralHashCode

public int structuralHashCode()

Computes the structural hashCode() for the query.

Returns:

the hash code

See Also:

#isStructurallyEqual(OjaiQuery)

isSortOnId

public boolean isSortOnId()

Returns true if the sort (orderBy) is on _id ascending.

Returns:

true if the sort (orderBy) is on _id ascending, false otherwise

getSortLimitExtras

public java.util.List<org.ojai.FieldPath> getSortLimitExtras()

Return the list of extra fields that would be required in order to perform a client-side sort for a sort limit case.

Returns:

list of field paths

getEligibleIndexes

public java.util.List<EligibleIndex> getEligibleIndexes(com.mapr.db.Admin admin,
                                                        org.apache.hadoop.fs.Path tablePath,
                                                        SharedTable sharedPrimaryTable,
                                                        OjaiConnection ojaiConnection)
                                                 throws java.io.IOException

Throws:

java.io.IOException

getScanCondition

public org.ojai.store.QueryCondition getScanCondition(OjaiConnection ojaiConnection,
                                                      EligibleIndex eligibleIndex)

getProjectedFieldSet

public java.util.Set<org.ojai.FieldPath> getProjectedFieldSet()

isStarQuery

public boolean isStarQuery()

isPossiblyNeedProjection

public boolean isPossiblyNeedProjection()

waitForTrackedWrites

public OjaiQuery waitForTrackedWrites(java.lang.String writesContext)
                               throws java.lang.IllegalArgumentException

Specified by:

waitForTrackedWrites in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

decorateStream

public org.ojai.DocumentStream decorateStream(org.ojai.DocumentStream docStream,
                                              OjaiConnection ojaiConnection,
                                              boolean isIndexSorted,
                                              java.util.List<org.ojai.FieldPath> sortLimitExtras,
                                              SharedResource<com.mapr.db.impl.BaseJsonTable> sharedTable)

Adds final post-processing steps to a DocumentStream based on query options such as limit and offset. This will include waiting for sync, if requested.

Parameters:

docStream - the DocumentStream to decorate

ojaiConnection - the OjaiConnection

isIndexSorted - is the index being used usable for the sort, if any?

sortLimitExtras - any extra fields that were added to the select list if a sort limit is done

Returns:

the decorated document stream

createDrillStream

public org.ojai.DocumentStream createDrillStream(OjaiConnection ojaiConnection,
                                                 SharedTable sharedTable,
                                                 QueryContext queryContext)

getRowCpuIoRatio

public double getRowCpuIoRatio()

getIndexHint

public java.lang.String getIndexHint()

Get the index hint, if any.

Returns:

the value of ojai.mapr.query.use-index, if any

getForceNonCoveringSort

public boolean getForceNonCoveringSort()

getForceDrill

public boolean getForceDrill()

getForceDirect

public boolean getForceDirect()

setTimeout

public OjaiQuery setTimeout(long timeoutInMilliseconds)
                     throws java.lang.IllegalArgumentException

Specified by:

setTimeout in interface org.ojai.store.Query

Throws:

java.lang.IllegalArgumentException

isSortLimit

public boolean isSortLimit()

Indicates that the query has both a sort and a limit, and that the limit is within the maximum allowed for a client-side sort.

Returns:

true if the top-k sort can be used for this query

build

public OjaiQuery build()

Specified by:

build in interface org.ojai.Buildable

Specified by:

build in interface org.ojai.store.Query

includeId

public boolean includeId()

Indicates whether or not we should include the id field in the result.

Returns:

hasOrderBy

public boolean hasOrderBy()

getOrderByFields

public java.util.Set<org.ojai.FieldPath> getOrderByFields()

getFieldOrdering

public com.mapr.db.index.IndexFieldDesc.Order getFieldOrdering(org.ojai.FieldPath fieldPath)

Get the Order for a sort key element.

Parameters:

fieldPath - the sort key element

Returns:

the order (Asc, Desc, or None if it is not present)

hasProjectionWithArrayIndex

public boolean hasProjectionWithArrayIndex()