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

Interface IndexConstants

public interface IndexConstants
TODO document

  • Field Details

    • INDEX_DEFINITIONS_NODE_TYPE

      static final String INDEX_DEFINITIONS_NODE_TYPE
      See Also:

    • INDEX_DEFINITIONS_NAME

      static final String INDEX_DEFINITIONS_NAME
      See Also:

    • TYPE_PROPERTY_NAME

      static final String TYPE_PROPERTY_NAME
      See Also:

    • ORIGINAL_TYPE_PROPERTY_NAME

      static final String ORIGINAL_TYPE_PROPERTY_NAME
      Property to hold the value for original index implementation in case the index type is set to disabled.
      See Also:

    • TYPE_UNKNOWN

      static final String TYPE_UNKNOWN
      See Also:

    • REINDEX_PROPERTY_NAME

      static final String REINDEX_PROPERTY_NAME
      See Also:

    • REFRESH_PROPERTY_NAME

      static final String REFRESH_PROPERTY_NAME
      Boolean property which signals to refresh the stored index definition
      See Also:

    • REINDEX_COUNT

      static final String REINDEX_COUNT
      See Also:

    • REINDEX_ASYNC_PROPERTY_NAME

      static final String REINDEX_ASYNC_PROPERTY_NAME
      See Also:

    • INDEXING_MODE_SYNC

      static final String INDEXING_MODE_SYNC
      See Also:

    • INDEXING_MODE_NRT

      static final String INDEXING_MODE_NRT
      See Also:

    • ASYNC_PROPERTY_NAME

      static final String ASYNC_PROPERTY_NAME
      See Also:

    • ASYNC_REINDEX_VALUE

      static final String ASYNC_REINDEX_VALUE
      See Also:

    • ENTRY_COUNT_PROPERTY_NAME

      static final String ENTRY_COUNT_PROPERTY_NAME
      See Also:

    • KEY_COUNT_PROPERTY_NAME

      static final String KEY_COUNT_PROPERTY_NAME
      See Also:

    • VALUE_PATTERN

      static final String VALUE_PATTERN
      The regular expression pattern of the values to be indexes.
      See Also:

    • VALUE_EXCLUDED_PREFIXES

      static final String VALUE_EXCLUDED_PREFIXES
      A list of prefixes to be excluded from the index.
      See Also:

    • VALUE_INCLUDED_PREFIXES

      static final String VALUE_INCLUDED_PREFIXES
      A list of prefixes to be included from the index. Include has higher priority than exclude.
      See Also:

    • UNIQUE_PROPERTY_NAME

      static final String UNIQUE_PROPERTY_NAME
      Marks a unique property index.
      See Also:

    • PROPERTY_NAMES

      static final String PROPERTY_NAMES
      Defines the names of the properties that are covered by a specific property index definition.
      See Also:

    • DECLARING_NODE_TYPES

      static final String DECLARING_NODE_TYPES
      Defines the property name of the "declaringNodeTypes" property with allows to restrict a given index definition to specific node types.
      See Also:

    • INDEX_CONTENT_NODE_NAME

      static final String INDEX_CONTENT_NODE_NAME
      See Also:

    • QUERY_PATHS

      static final String QUERY_PATHS
      MVP to define the paths for which the index can be used to perform queries. Defaults to ['/'].
      See Also:

    • CORRUPT_PROPERTY_NAME

      static final String CORRUPT_PROPERTY_NAME
      Property name for indicating that given index is corrupt and should be excluded from further indexing. Its value is the date when this index was marked as corrupt
      See Also:

    • CHECKPOINT_CREATION_TIME

      static final String CHECKPOINT_CREATION_TIME
      CommitInfo attribute name which refers to the time at which async index checkpoint is created i.e. time upto which repository state is being indexed in given indexing cycle. The time is in string for as per Type.DATE
      See Also:

    • INDEX_TAG_OPTION

      static final String INDEX_TAG_OPTION
      The index tag hint (when using "option(index tagged x, y)", this is IN("x", "y"))
      See Also:

    • INDEX_TAGS

      static final String INDEX_TAGS
      The tags property in the index definition.
      See Also:

    • INDEX_SELECTION_POLICY

      static final String INDEX_SELECTION_POLICY
      The property to indicate the index selection policy.
      See Also:

    • INDEX_NAME_OPTION

      static final String INDEX_NAME_OPTION
      The index name hint (when using "option(index abc)", this is "abc")
      See Also:

    • REINDEX_RETAIN

      static final String REINDEX_RETAIN
      Boolean property on any index node indicating that such a node should not be removed during reindex
      See Also:

    • TYPE_DISABLED

      static final String TYPE_DISABLED
      Index type for disabled indexes
      See Also:

    • SUPERSEDED_INDEX_PATHS

      static final String SUPERSEDED_INDEX_PATHS
      Multi value property referring to index paths which current index supersedes
      See Also:

    • DISABLE_INDEXES_ON_NEXT_CYCLE

      static final String DISABLE_INDEXES_ON_NEXT_CYCLE
      Boolean flag indicating that old indexes need to be disabled
      See Also:

    • USE_IF_EXISTS

      static final String USE_IF_EXISTS
      Whether to use the index. If the given node or property exists, then the index is used for queries; otherwise, it is not used (returns infinite cost). The value is: nodes, the path. For properties, the path of the node, then '@' property.
      See Also:

    • INDEX_DEPRECATED

      static final String INDEX_DEPRECATED
      Whether the index is deprecated. If it is, and the index is used, a warning is logged.
      See Also:

    • DYNAMIC_BOOST_LITE_PROPERTY_NAME

      static final String DYNAMIC_BOOST_LITE_PROPERTY_NAME
      Property name for indicating that given index uses a lightweight version of dynamic boost
      See Also: