org.springframework.data.mongodb.core.index

Class Index

java.lang.Object

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

All Implemented Interfaces:

IndexDefinition

Direct Known Subclasses:

CompoundIndexDefinition

public class Index
extends Object
implements IndexDefinition

Author:

Oliver Gierke, Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.Duplicates Deprecated. since 2.1. No longer supported by MongoDB as of server version 3.0.

Constructor Summary

Constructors

Constructor and Description
Index()
Index(String key, Sort.Direction direction)

Method Summary

Modifier and Type	Method and Description
Index	background() Build the index in background (non blocking).
Index	collation(Collation collation) Set the Collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.
Index	expire(Duration timeout) Specifies the TTL.
Index	expire(long value) Specifies TTL in seconds.
Index	expire(long value, TimeUnit unit) Specifies TTL with given TimeUnit.
org.bson.Document	getIndexKeys()
org.bson.Document	getIndexOptions()
Index	named(String name)
Index	on(String key, Sort.Direction direction)
Index	partial(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 java.lang.Object

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

Constructor Detail

Index

public Index()

Index

public Index(String key,
             Sort.Direction direction)

Method Detail

on

public Index on(String key,
                Sort.Direction direction)

named

public Index named(String name)

unique

public Index unique()

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

Returns:

See Also:

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

sparse

public Index sparse()

Skip over any document that is missing the indexed field.

Returns:

See Also:

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

background

public Index background()

Build the index in background (non blocking).

Returns:

Since:

1.5

expire

public Index expire(long value)

Specifies TTL in seconds.

Parameters:

value -

Returns:

Since:

1.5

expire

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

public Index expire(long value,
                    TimeUnit unit)

Specifies TTL with given TimeUnit.

Parameters:

value -

unit -

Returns:

Since:

1.5

partial

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:

Since:

1.10

See Also:

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

collation

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:

Since:

2.0

getIndexKeys

public org.bson.Document getIndexKeys()

Specified by:

getIndexKeys in interface IndexDefinition

getIndexOptions

public org.bson.Document getIndexOptions()

Specified by:

getIndexOptions in interface IndexDefinition

toString

public String toString()

Overrides:

toString in class Object