Package org.apache.jackrabbit.oak.api.jmx

Interface QueryEngineSettingsMBean

@ProviderType public interface QueryEngineSettingsMBean

  • Field Details

  • Method Details

    • getLimitInMemory

      @Description("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("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

    • setPrefetchCount

      void setPrefetchCount(int prefetchCount)
      Change the prefetch count.
      Parameters:
      prefetchCount - the new count

    • getPrefetchCount

      @Description("Get the prefetch count. This is the number of entries pre-fetched from the node store at a time.") int getPrefetchCount()
      Get the prefetch count.
      Returns:
      the count

    • setAutoOptionsMappingJson

      void setAutoOptionsMappingJson(String json)
      Change the automatic query options mapping.
      Parameters:
      json - the new mapping, in Json format

    • getAutoOptionsMappingJson

      @Description("Get the automatic query options mapping, in Json format.") String getAutoOptionsMappingJson()
      Get the automatic query options mapping.
      Returns:
      the mapping, in Json format

    • getFailTraversal

      @Description("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("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

      String getStrictPathRestriction()
      Whether Path restrictions are enabled while figuring out index plan
      Returns:
      true if enabled

    • setStrictPathRestriction

      @Description("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("pathRestriction") 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("Set or remove a query validator pattern.") void setQueryValidatorPattern(@Description("the key") @Name("key") String key, @Description("the regular expression pattern (empty to remove the pattern)") @Name("pattern") String pattern, @Description("a comment") @Name("comment") String comment, @Description("whether matching queries should fail (true) or just log a warning (false)") @Name("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("Get the query validator data as a JSON string.") String getQueryValidatorJson()

    • setIgnoredClassNamesInCallTrace

      @Description("Set or remove Java package / fully qualified class names to ignore in Call Trace analysis") void setIgnoredClassNamesInCallTrace(@Description("package or fully qualified class names") @Name("class names") @NotNull @NotNull String[] classNames)
      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).
      Parameters:
      classNames - the class names to be ignored.

    • getIgnoredClassNamesInCallTrace

      @NotNull @NotNull String[] getIgnoredClassNamesInCallTrace()