org.apache.jackrabbit.oak.plugins.index

Interface IndexConstants

public interface IndexConstants

TODO document

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASYNC_PROPERTY_NAME
static java.lang.String	ASYNC_REINDEX_VALUE
static java.lang.String	CHECKPOINT_CREATION_TIME CommitInfo attribute name which refers to the time at which async index checkpoint is created i.e.
static java.lang.String	CORRUPT_PROPERTY_NAME Property name for indicating that given index is corrupt and should be excluded from further indexing.
static java.lang.String	DECLARING_NODE_TYPES Defines the property name of the "declaringNodeTypes" property with allows to restrict a given index definition to specific node types.
static java.lang.String	DISABLE_INDEXES_ON_NEXT_CYCLE Boolean flag indicating that old indexes need to be disabled
static java.lang.String	DYNAMIC_BOOST_LITE_PROPERTY_NAME Property name for indicating that given index uses a lightweight version of dynamic boost
static java.lang.String	ENTRY_COUNT_PROPERTY_NAME
static java.lang.String	INDEX_CONTENT_NODE_NAME
static java.lang.String	INDEX_DEFINITIONS_NAME
static java.lang.String	INDEX_DEFINITIONS_NODE_TYPE
static java.lang.String	INDEX_DEPRECATED Whether the index is deprecated.
static java.lang.String	INDEX_NAME_OPTION The index name hint (when using "option(index abc)", this is "abc")
static java.lang.String	INDEX_SELECTION_POLICY The property to indicate the index selection policy.
static java.lang.String	INDEX_TAG_OPTION The index tag hint (when using "option(index tagged x, y)", this is IN("x", "y"))
static java.lang.String	INDEX_TAGS The tags property in the index definition.
static java.lang.String	INDEXING_MODE_NRT
static java.lang.String	INDEXING_MODE_SYNC
static java.lang.String	KEY_COUNT_PROPERTY_NAME
static java.lang.String	PROPERTY_NAMES Defines the names of the properties that are covered by a specific property index definition.
static java.lang.String	QUERY_PATHS MVP to define the paths for which the index can be used to perform queries.
static java.lang.String	REINDEX_ASYNC_PROPERTY_NAME
static java.lang.String	REINDEX_COUNT
static java.lang.String	REINDEX_PROPERTY_NAME
static java.lang.String	REINDEX_RETAIN Boolean property on any index node indicating that such a node should not be removed during reindex
static java.lang.String	SUPERSEDED_INDEX_PATHS Multi value property referring to index paths which current index supersedes
static java.lang.String	TYPE_DISABLED Index type for disabled indexes
static java.lang.String	TYPE_PROPERTY_NAME
static java.lang.String	TYPE_UNKNOWN
static java.lang.String	UNIQUE_PROPERTY_NAME Marks a unique property index.
static java.lang.String	USE_IF_EXISTS Whether to use the index.
static java.lang.String	VALUE_EXCLUDED_PREFIXES A list of prefixes to be excluded from the index.
static java.lang.String	VALUE_INCLUDED_PREFIXES A list of prefixes to be included from the index.
static java.lang.String	VALUE_PATTERN The regular expression pattern of the values to be indexes.

Field Detail

INDEX_DEFINITIONS_NODE_TYPE

static final java.lang.String INDEX_DEFINITIONS_NODE_TYPE

See Also:

Constant Field Values

INDEX_DEFINITIONS_NAME

static final java.lang.String INDEX_DEFINITIONS_NAME

See Also:

Constant Field Values

TYPE_PROPERTY_NAME

static final java.lang.String TYPE_PROPERTY_NAME

See Also:

Constant Field Values

TYPE_UNKNOWN

static final java.lang.String TYPE_UNKNOWN

See Also:

Constant Field Values

REINDEX_PROPERTY_NAME

static final java.lang.String REINDEX_PROPERTY_NAME

See Also:

Constant Field Values

REINDEX_COUNT

static final java.lang.String REINDEX_COUNT

See Also:

Constant Field Values

REINDEX_ASYNC_PROPERTY_NAME

static final java.lang.String REINDEX_ASYNC_PROPERTY_NAME

See Also:

Constant Field Values

INDEXING_MODE_SYNC

static final java.lang.String INDEXING_MODE_SYNC

See Also:

Constant Field Values

INDEXING_MODE_NRT

static final java.lang.String INDEXING_MODE_NRT

See Also:

Constant Field Values

ASYNC_PROPERTY_NAME

static final java.lang.String ASYNC_PROPERTY_NAME

See Also:

Constant Field Values

ASYNC_REINDEX_VALUE

static final java.lang.String ASYNC_REINDEX_VALUE

See Also:

Constant Field Values

ENTRY_COUNT_PROPERTY_NAME

static final java.lang.String ENTRY_COUNT_PROPERTY_NAME

See Also:

Constant Field Values

KEY_COUNT_PROPERTY_NAME

static final java.lang.String KEY_COUNT_PROPERTY_NAME

See Also:

Constant Field Values

VALUE_PATTERN

static final java.lang.String VALUE_PATTERN

The regular expression pattern of the values to be indexes.

See Also:

Constant Field Values

VALUE_EXCLUDED_PREFIXES

static final java.lang.String VALUE_EXCLUDED_PREFIXES

A list of prefixes to be excluded from the index.

See Also:

Constant Field Values

VALUE_INCLUDED_PREFIXES

static final java.lang.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

UNIQUE_PROPERTY_NAME

static final java.lang.String UNIQUE_PROPERTY_NAME

Marks a unique property index.

See Also:

Constant Field Values

PROPERTY_NAMES

static final java.lang.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 java.lang.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

INDEX_CONTENT_NODE_NAME

static final java.lang.String INDEX_CONTENT_NODE_NAME

See Also:

Constant Field Values

QUERY_PATHS

static final java.lang.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 java.lang.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 java.lang.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 java.lang.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_TAGS

static final java.lang.String INDEX_TAGS

The tags property in the index definition.

See Also:

Constant Field Values

INDEX_SELECTION_POLICY

static final java.lang.String INDEX_SELECTION_POLICY

The property to indicate the index selection policy.

See Also:

Constant Field Values

INDEX_NAME_OPTION

static final java.lang.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 java.lang.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

TYPE_DISABLED

static final java.lang.String TYPE_DISABLED

Index type for disabled indexes

See Also:

Constant Field Values

SUPERSEDED_INDEX_PATHS

static final java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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