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

Interface IndexConstants

  • public interface IndexConstants
    TODO document

    • Field Detail

      • VALUE_PATTERN

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

      • VALUE_EXCLUDED_PREFIXES

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

      • 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:
        Constant Field Values

      • PROPERTY_NAMES

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

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • INDEX_NAME_OPTION

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

      • 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:
        Constant Field Values

      • SUPERSEDED_INDEX_PATHS

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

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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:
        Constant Field Values