org.apache.jackrabbit.oak.api.jmx

Interface QueryEngineSettingsMBean

public interface QueryEngineSettingsMBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Method Summary

Modifier and Type	Method and Description
boolean	getFailTraversal() Whether queries that don't use an index will fail (throw an exception).
long	getLimitInMemory() Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries.
long	getLimitReads() Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes).
boolean	isFastQuerySize() Whether the query result size should return an estimation for large queries.
void	setFailTraversal(boolean failTraversal) Set whether queries that don't use an index will fail (throw an exception).
void	setFastQuerySize(boolean fastQuerySize)
void	setLimitInMemory(long limitInMemory) Change the limit.
void	setLimitReads(long limitReads) Change the limit.

Field Detail

TYPE

static final java.lang.String TYPE

See Also:

Constant Field Values

Method Detail

getLimitInMemory

@Description(value="Get the limit on how many nodes a query may read at most into memory, for \"order by\" and \"distinct\" queries. If this limit is exceeded, the query throws an exception.")
long getLimitInMemory()

Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries. If this limit is exceeded, the query throws an exception.

Returns:

the limit

setLimitInMemory

void setLimitInMemory(long limitInMemory)

Change the limit.

Parameters:

limitInMemory - the new limit

getLimitReads

@Description(value="Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes). If this limit is exceeded, the query throws an exception.")
long getLimitReads()

Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes). If this limit is exceeded, the query throws an exception.

Returns:

the limit

setLimitReads

void setLimitReads(long limitReads)

Change the limit.

Parameters:

limitReads - the new limit

getFailTraversal

@Description(value="Whether queries that don\'t use an index will fail (throw an exception). The default is false.")
boolean getFailTraversal()

Whether queries that don't use an index will fail (throw an exception). The default is false.

Returns:

true if they fail

setFailTraversal

void setFailTraversal(boolean failTraversal)

Set whether queries that don't use an index will fail (throw an exception).

Parameters:

failTraversal - the new value for this setting

isFastQuerySize

@Description(value="Whether the query result size should return an estimation for large queries.")
boolean isFastQuerySize()

Whether the query result size should return an estimation for large queries.

Returns:

true if enabled

setFastQuerySize

void setFastQuerySize(boolean fastQuerySize)