Class QueryEngineSettings

    • Field Detail

      • SQL2_OPTIMISATION_FLAG

        public static final java.lang.String SQL2_OPTIMISATION_FLAG
        the flag used to turn on/off the optimisations on top of the org.apache.jackrabbit.oak.query.Query object. -Doak.query.sql2optimisation
        See Also:
        Constant Field Values
      • SQL2_OPTIMISATION_FLAG_2

        public static final java.lang.String SQL2_OPTIMISATION_FLAG_2
        See Also:
        Constant Field Values
      • SQL2_OPTIMIZATION_2

        public static final boolean SQL2_OPTIMIZATION_2
      • OAK_QUERY_LIMIT_IN_MEMORY

        public static final java.lang.String OAK_QUERY_LIMIT_IN_MEMORY
        See Also:
        Constant Field Values
      • DEFAULT_QUERY_LIMIT_IN_MEMORY

        public static final long DEFAULT_QUERY_LIMIT_IN_MEMORY
      • OAK_QUERY_LIMIT_READS

        public static final java.lang.String OAK_QUERY_LIMIT_READS
        See Also:
        Constant Field Values
      • DEFAULT_QUERY_LIMIT_READS

        public static final long DEFAULT_QUERY_LIMIT_READS
      • OAK_QUERY_PREFETCH_COUNT

        public static final java.lang.String OAK_QUERY_PREFETCH_COUNT
        See Also:
        Constant Field Values
      • FT_NAME_PREFETCH_FOR_QUERIES

        public static final java.lang.String FT_NAME_PREFETCH_FOR_QUERIES
        See Also:
        Constant Field Values
      • DEFAULT_PREFETCH_COUNT

        public static final int DEFAULT_PREFETCH_COUNT
      • OAK_QUERY_FAIL_TRAVERSAL

        public static final java.lang.String OAK_QUERY_FAIL_TRAVERSAL
        See Also:
        Constant Field Values
      • DEFAULT_FAST_QUERY_SIZE

        public static final boolean DEFAULT_FAST_QUERY_SIZE
    • Constructor Detail

      • QueryEngineSettings

        public QueryEngineSettings()
      • QueryEngineSettings

        public QueryEngineSettings​(StatisticsProvider statisticsProvider)
    • Method Detail

      • getQueryLengthWarnLimit

        public long getQueryLengthWarnLimit()
      • getQueryLengthErrorLimit

        public long getQueryLengthErrorLimit()
      • setPrefetchFeature

        public void setPrefetchFeature​(@Nullable
                                       @Nullable Feature prefetch)
      • setFailTraversal

        public void setFailTraversal​(boolean failTraversal)
        Description copied from interface: QueryEngineSettingsMBean
        Set whether queries that don't use an index will fail (throw an exception).
        Specified by:
        setFailTraversal in interface QueryEngineSettingsMBean
        Parameters:
        failTraversal - the new value for this setting
      • setStrictPathRestriction

        public void setStrictPathRestriction​(java.lang.String strictPathRestriction)
        Description copied from interface: QueryEngineSettingsMBean
        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.
        Specified by:
        setStrictPathRestriction in interface QueryEngineSettingsMBean
        Parameters:
        strictPathRestriction - 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
      • setFullTextComparisonWithoutIndex

        public void setFullTextComparisonWithoutIndex​(boolean fullTextComparisonWithoutIndex)
      • isSql2Optimisation

        public boolean isSql2Optimisation()
      • setQueryValidatorPattern

        public void setQueryValidatorPattern​(java.lang.String key,
                                             java.lang.String pattern,
                                             java.lang.String comment,
                                             boolean failQuery)
        Description copied from interface: QueryEngineSettingsMBean
        Set or remove a query validator pattern.
        Specified by:
        setQueryValidatorPattern in interface QueryEngineSettingsMBean
        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)
      • setIgnoredClassNamesInCallTrace

        public void setIgnoredClassNamesInCallTrace​(@NotNull
                                                    @NotNull java.lang.String[] packageNames)
        Description copied from interface: QueryEngineSettingsMBean
        Set or remove java package/class names which are ignored from finding the invoking class for queries. It can be either Java package names or fully-qualified class names (package + class name).
        Specified by:
        setIgnoredClassNamesInCallTrace in interface QueryEngineSettingsMBean
        Parameters:
        packageNames - the class names to be ignored.
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object