Package com.google.gerrit.index

Class IndexConfig

java.lang.Object
com.google.gerrit.index.IndexConfig
public abstract class IndexConfig extends Object
Implementation-specific configuration for secondary indexes.

Contains configuration that is tied to a specific index implementation but is otherwise global, i.e. not tied to a specific Index and schema version.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    IndexConfig.Builder
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    IndexConfig()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static IndexConfig.Builder
    builder()
     
    static IndexConfig
    createDefault()
     
    abstract int
    defaultLimit()
    Returns default limit for index queries, if the user does not provide one.
    static IndexConfig.Builder
    fromConfig(org.eclipse.jgit.lib.Config cfg)
     
    abstract int
    maxLimit()
    Returns maximum limit supported by the underlying index, or limited for performance reasons.
    abstract int
    maxPages()
    Returns maximum number of pages (limit / start) supported by the underlying index, or limited for performance reasons.
    abstract int
    maxPageSize()
    Returns maximum allowed limit when repeating index queries to obtain the next set of results.
    abstract int
    maxTerms()
    Returns maximum number of total index query terms supported by the underlying index, or limited for performance reasons.
    abstract int
    pageSizeMultiplier()
    Returns multiplier to be used to determine the limit when queries are repeated to obtain the next set of results.
    abstract PaginationType
    paginationType()
    Returns pagination type to use when index queries are repeated to obtain the next set of results.
    abstract boolean
    separateChangeSubIndexes()
    Returns whether different subsets of changes may be stored in different physical sub-indexes.
    abstract String
    type()
    Returns index type.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • IndexConfig

      public IndexConfig()

  • Method Details

    • createDefault

      public static IndexConfig createDefault()

    • fromConfig

      public static IndexConfig.Builder fromConfig(org.eclipse.jgit.lib.Config cfg)

    • builder

      public static IndexConfig.Builder builder()

    • defaultLimit

      public abstract int defaultLimit()
      Returns default limit for index queries, if the user does not provide one. If this is not set, then the max permitted limit for each user is used, which might be much higher than intended.

    • maxLimit

      public abstract int maxLimit()
      Returns maximum limit supported by the underlying index, or limited for performance reasons.

    • maxPages

      public abstract int maxPages()
      Returns maximum number of pages (limit / start) supported by the underlying index, or limited for performance reasons.

    • maxTerms

      public abstract int maxTerms()
      Returns maximum number of total index query terms supported by the underlying index, or limited for performance reasons.

    • type

      public abstract String type()
      Returns index type.

    • separateChangeSubIndexes

      public abstract boolean separateChangeSubIndexes()
      Returns whether different subsets of changes may be stored in different physical sub-indexes.

    • paginationType

      public abstract PaginationType paginationType()
      Returns pagination type to use when index queries are repeated to obtain the next set of results.

    • pageSizeMultiplier

      public abstract int pageSizeMultiplier()
      Returns multiplier to be used to determine the limit when queries are repeated to obtain the next set of results.

    • maxPageSize

      public abstract int maxPageSize()
      Returns maximum allowed limit when repeating index queries to obtain the next set of results.