Package org.apache.jackrabbit.oak.plugins.index

Interface IndexInfo

  • @ProviderType
public interface IndexInfo
    Captures information related to index

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable java.lang.String getAsyncLaneName()
      Returns name of the async index lane to which this index is bound to or null if its not an async index
      long getEstimatedEntryCount()
      An estimate of entry count in the index
      @Nullable java.lang.String getIndexDefinitionDiff()
      If the index definition has changed without doing any reindexing then this method can be used to determine the diff in the index definition
      long getIndexedUpToTime()
      Returns time in millis of the repository state up to which index is up-to-date.
      java.lang.String getIndexPath()
      Returns paths of index definition in the repository
      long getLastUpdatedTime()
      Time in millis at which index was last updated
      long getSizeInBytes()
      Index data storage size
      java.lang.String getType()
      Returns type of index definition like 'property' or 'lucene'
      boolean hasIndexDefinitionChangedWithoutReindexing()
      Determines if index definition has changed but no reindexing was done for that change.

    • Method Detail

      • getIndexPath

        java.lang.String getIndexPath()
        Returns paths of index definition in the repository

      • getType

        java.lang.String getType()
        Returns type of index definition like 'property' or 'lucene'

      • getAsyncLaneName

        @Nullable
@Nullable java.lang.String getAsyncLaneName()
        Returns name of the async index lane to which this index is bound to or null if its not an async index

      • getLastUpdatedTime

        long getLastUpdatedTime()
        Time in millis at which index was last updated
        Returns:
        time in millis or -1 if unknown, -2 if synchronous

      • getIndexedUpToTime

        long getIndexedUpToTime()
        Returns time in millis of the repository state up to which index is up-to-date. This may or may not be same as #getLastUpdatedTime. For e.g. consider an index at /oak:index/fooIndex bound to async lane "async". The index might have got updated 2 cycle ago when async indexer traversed content node which were indexed by this index and it was not updated in last index cycle. Then indexedUptoTime is the time of last complete cycle while lastUpdatedTime is the time of 2nd last cycle
        Returns:
        time in millis or -1 if unknown

      • getEstimatedEntryCount

        long getEstimatedEntryCount()
        An estimate of entry count in the index

      • getSizeInBytes

        long getSizeInBytes()
        Index data storage size
        Returns:
        storage size or -1 if unknown

      • hasIndexDefinitionChangedWithoutReindexing

        boolean hasIndexDefinitionChangedWithoutReindexing()
        Determines if index definition has changed but no reindexing was done for that change.

      • getIndexDefinitionDiff

        @Nullable
@Nullable java.lang.String getIndexDefinitionDiff()
        If the index definition has changed without doing any reindexing then this method can be used to determine the diff in the index definition
        Returns:
        diff if the definition change otherwise null