Class Index

java.lang.Object

org.springframework.data.mongodb.core.index.Index

All Implemented Interfaces:

IndexDefinition

Direct Known Subclasses:

CompoundIndexDefinition, WildcardIndex

public class Index
extends Object
implements IndexDefinition

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Modifier	Constructor	Description
	Index()
	Index(String key, Sort.Direction direction)
<T,P>	Index(TypedPropertyPath<T,P> property, Sort.Direction direction)	Create a new Index definition for the given property and Sort.Direction

Method Summary

Modifier and Type	Method	Description
Index	background()	Deprecated, for removal: This API element is subject to removal in a future version. since 5.0 for removal without replacement.
Index	collation(@Nullable Collation collation)	Set the Collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. NOTE: Only queries using the same Collation as the Index actually make use of the index.
Index	expire(long value)	Specifies TTL in seconds.
Index	expire(long value, TimeUnit unit)	Specifies TTL with given TimeUnit.
Index	expire(Duration timeout)	Specifies the TTL.
org.bson.Document	getIndexKeys()	Get the Document containing properties covered by the index.
org.bson.Document	getIndexOptions()	Get the index properties such as unique,...
Index	hidden()	Hidden indexes are not visible to the query planner and cannot be used to support a query.
Index	named(String name)
Index	on(String key, Sort.Direction direction)
<T,P> Index	on(TypedPropertyPath<T,P> property, Sort.Direction direction)	Append the path to the target property to the index definition.
Index	partial(@Nullable IndexFilter filter)	Only index the documents in a collection that meet a specified filter expression.
Index	sparse()	Skip over any document that is missing the indexed field.
String	toString()
Index	unique()	Reject all documents that contain a duplicate value for the indexed field.

Methods inherited from class Object

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

Constructor Details

Index

public Index()

Index

public Index(String key,
 Sort.Direction direction)

Index

public <T,P> Index(TypedPropertyPath<T,P> property,
 Sort.Direction direction)

Create a new Index definition for the given property and Sort.Direction

Type Parameters:

T - Property owing root type

P - Target property reachable via path.

Parameters:

property - must not be null.

direction - index order

Since:

5.1

Method Details

on

@Contract("_, _ -> this")
public Index on(String key,
 Sort.Direction direction)

on

@Contract("_, _ -> this")
public <T,P> Index on(TypedPropertyPath<T,P> property,
 Sort.Direction direction)

Append the path to the target property to the index definition.

Type Parameters:

T - Property owing root type

P - Target property reachable via path.

Parameters:

property - the property to include.

direction - the direction to order values within the index.

Returns:

this.

Since:

5.1

named

@Contract("_ -> this")
public Index named(String name)

unique

@Contract("-> this")
public Index unique()

Reject all documents that contain a duplicate value for the indexed field.

Returns:

this.

See Also:

• https://docs.mongodb.org/manual/core/index-unique/

sparse

@Contract("-> this")
public Index sparse()

Skip over any document that is missing the indexed field.

Returns:

this.

See Also:

• https://docs.mongodb.org/manual/core/index-sparse/

background

@Deprecated(since="5.0",
            forRemoval=true)
@Contract("-> this")
public Index background()

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.0 for removal without replacement.

Build the index in background (non blocking).

NOTE: Since MongoDB 4.2 the background flag is ignored by the server if set.

Returns:

this.

Since:

1.5

hidden

@Contract("-> this")
public Index hidden()

Hidden indexes are not visible to the query planner and cannot be used to support a query.

Returns:

this.

Since:

4.1

See Also:

• https://www.mongodb.com/docs/manual/core/index-hidden/

expire

@Contract("_ -> this")
public Index expire(long value)

Specifies TTL in seconds.

Parameters:

value -

Returns:

this.

Since:

1.5

expire

@Contract("_ -> this")
public Index expire(Duration timeout)

Specifies the TTL.

Parameters:

timeout - must not be null.

Returns:

this.

Throws:

IllegalArgumentException - if given timeout is null.

Since:

2.2

expire

@Contract("_, _ -> this")
public Index expire(long value,
 TimeUnit unit)

Specifies TTL with given TimeUnit.

Parameters:

value -

unit - must not be null.

Returns:

this.

Since:

1.5

partial

@Contract("_ -> this")
public Index partial(@Nullable IndexFilter filter)

Only index the documents in a collection that meet a specified filter expression.

Parameters:

filter - can be null.

Returns:

this.

Since:

1.10

See Also:

• https://docs.mongodb.com/manual/core/index-partial/

collation

@Contract("_ -> this")
public Index collation(@Nullable Collation collation)

Set the Collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.
NOTE: Only queries using the same Collation as the Index actually make use of the index.

Parameters:

collation - can be null.

Returns:

this.

Since:

2.0

getIndexKeys

public org.bson.Document getIndexKeys()

Description copied from interface: IndexDefinition

Get the Document containing properties covered by the index.

Specified by:

getIndexKeys in interface IndexDefinition

Returns:

never null.

getIndexOptions

public org.bson.Document getIndexOptions()

Description copied from interface: IndexDefinition

Get the index properties such as unique,...

Specified by:

getIndexOptions in interface IndexDefinition

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object