org.apache.jackrabbit.oak.api.jmx

Interface QueryEngineSettingsMBean

@ProviderType
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).
java.lang.String	getQueryValidatorJson()
java.lang.String	getStrictPathRestriction() Whether Path restrictions are enabled while figuring out index plan
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.
void	setQueryValidatorPattern(java.lang.String key, java.lang.String pattern, java.lang.String comment, boolean failQuery) Set or remove a query validator pattern.
void	setStrictPathRestriction(java.lang.String pathRestriction) Whether path restrictions of indexes (excludedPaths / includedPaths) are taken into account during query execution, for Lucene indexes.

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)

getStrictPathRestriction

java.lang.String getStrictPathRestriction()

Whether Path restrictions are enabled while figuring out index plan

Returns:

true if enabled

setStrictPathRestriction

@Description(value="Set path restriction: Expected value is either of ENABLE/DISABLE/WARN.   ENABLE: enable path restriction- Index won\'t be used if index definition path restrictions are not compatible with query\'s path restriction.  DISABLE: path restrictions are not taken into account while querying.  WARN: path restrictions are not taken into account but a warning will be logged if query path restrictions are not compatible with index path restrictions.")
void setStrictPathRestriction(@Name(value="pathRestriction")
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                java.lang.String pathRestriction)

Whether path restrictions of indexes (excludedPaths / includedPaths) are taken into account during query execution, for Lucene indexes. When enabled, only indexes are considered if the index path restriction is compatible with the query path restrictions. When disabled, only the queryPaths of the index is taken into account.

Parameters:

pathRestriction - Set path restriction: Expected value is either of ENABLE/DISABLE/WARN ENABLE: enable path restriction- Index won't be used if index definition path restrictions are not compatible with query's path restriction DISABLE: path restrictions are not taken into account while querying WARN: path restrictions are not taken into account but a warning will be logged if query path restrictions are not compatible with index path restrictions

setQueryValidatorPattern

@Description(value="Set or remove a query validator pattern.")
void setQueryValidatorPattern(@Description(value="the key") @Name(value="key")
                                                                                             java.lang.String key,
                                                                                             @Description(value="the regular expression pattern (empty to remove the pattern)") @Name(value="pattern")
                                                                                             java.lang.String pattern,
                                                                                             @Description(value="a comment") @Name(value="comment")
                                                                                             java.lang.String comment,
                                                                                             @Description(value="whether matching queries should fail (true) or just log a warning (false)") @Name(value="failQuery")
                                                                                             boolean failQuery)

Set or remove a query validator pattern.

Parameters:

key - the key

pattern - the regular expression pattern (empty to remove the pattern)

comment - a comment

failQuery - whether matching queries should fail (true) or just log a warning (false)

getQueryValidatorJson

@Description(value="Get the query validator data as a JSON string.")
java.lang.String getQueryValidatorJson()