Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class CollectionOptions

java.lang.Object

org.springframework.data.mongodb.core.CollectionOptions

public class CollectionOptions
extends Object

Provides a simple wrapper to encapsulate the variety of settings you can use when creating a collection.

Author:

Thomas Risberg, Christoph Strobl, Mark Paluch, Andreas Zink, Ben Foster, Ross Lawley

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CollectionOptions.CollectionChangeStreamOptions	Encapsulation of options applied to define collections change stream behaviour.
static class	CollectionOptions.EncryptedFieldsOptions	Encapsulation of Encryption options for collections.
static class	CollectionOptions.TimeSeriesOptions	Options applicable to Time Series collections.
static class	CollectionOptions.ValidationOptions	Encapsulation of ValidationOptions options.

Method Summary

Modifier and Type	Method	Description
CollectionOptions	capped()	Create new CollectionOptions with already given settings and capped set to true.
CollectionOptions	changeStream(CollectionOptions.CollectionChangeStreamOptions changeStreamOptions)	Create new CollectionOptions with the given CollectionOptions.TimeSeriesOptions.
CollectionOptions	collation(Collation collation)	Create new CollectionOptions with already given settings and collation set to given value.
CollectionOptions	disableValidation()	Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.OFF.
static CollectionOptions	emitChangedRevisions()	Quick way to set up CollectionOptions for emitting (pre & post) change events.
static CollectionOptions	empty()	Create new empty CollectionOptions.
CollectionOptions	encrypted(CollectionOptions.EncryptedFieldsOptions encryptedFieldsOptions)	Set the CollectionOptions.EncryptedFieldsOptions for collections using queryable encryption.
static CollectionOptions	encryptedCollection(Function<CollectionOptions.EncryptedFieldsOptions,CollectionOptions.EncryptedFieldsOptions> optionsFunction)	Create new CollectionOptions building encryption options in a fluent style.
static CollectionOptions	encryptedCollection(CollectionOptions.EncryptedFieldsOptions encryptedFieldsOptions)	Create new CollectionOptions with the given encryptedFields.
static CollectionOptions	encryptedCollection(MongoJsonSchema schema)	Create new CollectionOptions reading encryption options from the given MongoJsonSchema.
boolean	equals(Object o)
CollectionOptions	failOnValidationError()	Create new CollectionOptions with already given settings and validationAction set to ValidationAction.ERROR.
Optional<Boolean>	getCapped()	Get if the collection should be capped.
Optional<CollectionOptions.CollectionChangeStreamOptions>	getChangeStreamOptions()	Get the CollectionOptions.CollectionChangeStreamOptions if available.
Optional<Collation>	getCollation()	Get the Collation settings.
Optional<CollectionOptions.EncryptedFieldsOptions>	getEncryptedFieldsOptions()	Get the encryptedFields if available.
Optional<Long>	getMaxDocuments()	Get the max number of documents the collection should be limited to.
Optional<Long>	getSize()	Get the size in bytes the collection should be limited to.
Optional<CollectionOptions.TimeSeriesOptions>	getTimeSeriesOptions()	Get the CollectionOptions.TimeSeriesOptions if available.
Optional<CollectionOptions.ValidationOptions>	getValidationOptions()	Get the MongoJsonSchema for the collection.
int	hashCode()
static CollectionOptions	just(Collation collation)	Create new CollectionOptions by just providing the Collation to use.
CollectionOptions	maxDocuments(long maxDocuments)	Create new CollectionOptions with already given settings and maxDocuments set to given value.
CollectionOptions	moderateValidation()	Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.MODERATE.
CollectionOptions	schema(MongoJsonSchema schema)	Create new CollectionOptions with already given settings and validationOptions set to given MongoJsonSchema.
CollectionOptions	schemaValidationAction(com.mongodb.client.model.ValidationAction validationAction)	Create new CollectionOptions with already given settings and validationAction set given ValidationAction.
CollectionOptions	schemaValidationLevel(com.mongodb.client.model.ValidationLevel validationLevel)	Create new CollectionOptions with already given settings and validationLevel set given ValidationLevel.
CollectionOptions	size(long size)	Create new CollectionOptions with already given settings and size set to given value.
CollectionOptions	strictValidation()	Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.STRICT.
static CollectionOptions	timeSeries(String timeField)	Quick way to set up CollectionOptions for a Time Series collection.
static CollectionOptions	timeSeries(String timeField, Function<CollectionOptions.TimeSeriesOptions,CollectionOptions.TimeSeriesOptions> options)	Set up CollectionOptions for a Time Series collection.
CollectionOptions	timeSeries(CollectionOptions.TimeSeriesOptions timeSeriesOptions)	Create new CollectionOptions with the given CollectionOptions.TimeSeriesOptions.
String	toString()
CollectionOptions	validation(CollectionOptions.ValidationOptions validationOptions)	Create new CollectionOptions with the given CollectionOptions.ValidationOptions.
CollectionOptions	validator(Validator validator)	Create new CollectionOptions with already given settings and validationOptions set to given Validator.
CollectionOptions	warnOnValidationError()	Create new CollectionOptions with already given settings and validationAction set to ValidationAction.WARN.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

just

public static CollectionOptions just(Collation collation)

Create new CollectionOptions by just providing the Collation to use.

Parameters:

collation - must not be null.

Returns:

new CollectionOptions.

Since:

2.0

empty

public static CollectionOptions empty()

Create new empty CollectionOptions.

Returns:

new CollectionOptions.

Since:

2.0

timeSeries

public static CollectionOptions timeSeries(String timeField)

Quick way to set up CollectionOptions for a Time Series collection. For more advanced settings use timeSeries(String, Function).

Parameters:

timeField - The name of the property which contains the date in each time series document. Must not be null.

Returns:

new instance of CollectionOptions.

Since:

3.3

See Also:

• timeSeries(TimeSeriesOptions)

timeSeries

public static CollectionOptions timeSeries(String timeField,
 Function<CollectionOptions.TimeSeriesOptions,CollectionOptions.TimeSeriesOptions> options)

Set up CollectionOptions for a Time Series collection.

Parameters:

timeField - the name of the field that contains the date in each time series document.

options - a function to apply additional settings to CollectionOptions.TimeSeriesOptions.

Returns:

new instance of CollectionOptions.

Since:

4.4

emitChangedRevisions

public static CollectionOptions emitChangedRevisions()

Quick way to set up CollectionOptions for emitting (pre & post) change events.

Returns:

new instance of CollectionOptions.

Since:

4.0

See Also:

• changeStream(CollectionChangeStreamOptions)
• CollectionOptions.CollectionChangeStreamOptions.preAndPostImages(boolean)

encryptedCollection

@Contract("_ -> new")
@CheckReturnValue
public static CollectionOptions encryptedCollection(@Nullable
 CollectionOptions.EncryptedFieldsOptions encryptedFieldsOptions)

Create new CollectionOptions with the given encryptedFields.

Parameters:

encryptedFieldsOptions - can be null

Returns:

new instance of CollectionOptions.

Since:

4.5.0

encryptedCollection

@Contract("_ -> new")
@CheckReturnValue
public static CollectionOptions encryptedCollection(MongoJsonSchema schema)

Create new CollectionOptions reading encryption options from the given MongoJsonSchema.

Parameters:

schema - must not be null.

Returns:

new instance of CollectionOptions.

Since:

4.5.0

encryptedCollection

@Contract("_ -> new")
@CheckReturnValue
public static CollectionOptions encryptedCollection(Function<CollectionOptions.EncryptedFieldsOptions,CollectionOptions.EncryptedFieldsOptions> optionsFunction)

Create new CollectionOptions building encryption options in a fluent style.

Parameters:

optionsFunction - must not be null.

Returns:

new instance of CollectionOptions.

Since:

4.5.0

capped

public CollectionOptions capped()

Create new CollectionOptions with already given settings and capped set to true.
NOTE: Using capped collections requires defining size(long).

Returns:

new CollectionOptions.

Since:

2.0

maxDocuments

public CollectionOptions maxDocuments(long maxDocuments)

Create new CollectionOptions with already given settings and maxDocuments set to given value.

Parameters:

maxDocuments - can be null.

Returns:

new CollectionOptions.

Since:

2.0

size

public CollectionOptions size(long size)

Create new CollectionOptions with already given settings and size set to given value.

Parameters:

size - can be null.

Returns:

new CollectionOptions.

Since:

2.0

collation

public CollectionOptions collation(@Nullable
 Collation collation)

Create new CollectionOptions with already given settings and collation set to given value.

Parameters:

collation - can be null.

Returns:

new CollectionOptions.

Since:

2.0

schema

public CollectionOptions schema(MongoJsonSchema schema)

Create new CollectionOptions with already given settings and validationOptions set to given MongoJsonSchema.

Parameters:

schema - must not be null.

Returns:

new CollectionOptions.

Since:

2.1

validator

public CollectionOptions validator(@Nullable
 Validator validator)

Create new CollectionOptions with already given settings and validationOptions set to given Validator.

Parameters:

validator - can be null.

Returns:

new CollectionOptions.

Since:

2.1

disableValidation

public CollectionOptions disableValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.OFF.

Returns:

new CollectionOptions.

Since:

2.1

strictValidation

public CollectionOptions strictValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.STRICT.

Returns:

new CollectionOptions.

Since:

2.1

moderateValidation

public CollectionOptions moderateValidation()

Create new CollectionOptions with already given settings and validationLevel set to ValidationLevel.MODERATE.

Returns:

new CollectionOptions.

Since:

2.1

warnOnValidationError

public CollectionOptions warnOnValidationError()

Create new CollectionOptions with already given settings and validationAction set to ValidationAction.WARN.

Returns:

new CollectionOptions.

Since:

2.1

failOnValidationError

public CollectionOptions failOnValidationError()

Create new CollectionOptions with already given settings and validationAction set to ValidationAction.ERROR.

Returns:

new CollectionOptions.

Since:

2.1

schemaValidationLevel

public CollectionOptions schemaValidationLevel(com.mongodb.client.model.ValidationLevel validationLevel)

Create new CollectionOptions with already given settings and validationLevel set given ValidationLevel.

Parameters:

validationLevel - must not be null.

Returns:

new CollectionOptions.

Since:

2.1

schemaValidationAction

public CollectionOptions schemaValidationAction(com.mongodb.client.model.ValidationAction validationAction)

Create new CollectionOptions with already given settings and validationAction set given ValidationAction.

Parameters:

validationAction - must not be null.

Returns:

new CollectionOptions.

Since:

2.1

validation

public CollectionOptions validation(CollectionOptions.ValidationOptions validationOptions)

Create new CollectionOptions with the given CollectionOptions.ValidationOptions.

Parameters:

validationOptions - must not be null. Use CollectionOptions.ValidationOptions.none() to remove validation.

Returns:

new CollectionOptions.

Since:

2.1

timeSeries

public CollectionOptions timeSeries(CollectionOptions.TimeSeriesOptions timeSeriesOptions)

Create new CollectionOptions with the given CollectionOptions.TimeSeriesOptions.

Parameters:

timeSeriesOptions - must not be null.

Returns:

new instance of CollectionOptions.

Since:

3.3

changeStream

public CollectionOptions changeStream(CollectionOptions.CollectionChangeStreamOptions changeStreamOptions)

Create new CollectionOptions with the given CollectionOptions.TimeSeriesOptions.

Parameters:

changeStreamOptions - must not be null.

Returns:

new instance of CollectionOptions.

Since:

3.3

encrypted

@Contract("_ -> new")
@CheckReturnValue
public CollectionOptions encrypted(CollectionOptions.EncryptedFieldsOptions encryptedFieldsOptions)

Set the CollectionOptions.EncryptedFieldsOptions for collections using queryable encryption.

Parameters:

encryptedFieldsOptions - must not be null.

Returns:

new instance of CollectionOptions.

Since:

4.5

getMaxDocuments

public Optional<Long> getMaxDocuments()

Get the max number of documents the collection should be limited to.

Returns:

Optional.empty() if not set.

getSize

public Optional<Long> getSize()

Get the size in bytes the collection should be limited to.

Returns:

Optional.empty() if not set.

getCapped

public Optional<Boolean> getCapped()

Get if the collection should be capped.

Returns:

Optional.empty() if not set.

Since:

2.0

getCollation

public Optional<Collation> getCollation()

Get the Collation settings.

Returns:

Optional.empty() if not set.

Since:

2.0

getValidationOptions

public Optional<CollectionOptions.ValidationOptions> getValidationOptions()

Get the MongoJsonSchema for the collection.

Returns:

Optional.empty() if not set.

Since:

2.1

getTimeSeriesOptions

public Optional<CollectionOptions.TimeSeriesOptions> getTimeSeriesOptions()

Get the CollectionOptions.TimeSeriesOptions if available.

Returns:

Optional.empty() if not specified.

Since:

3.3

getChangeStreamOptions

public Optional<CollectionOptions.CollectionChangeStreamOptions> getChangeStreamOptions()

Get the CollectionOptions.CollectionChangeStreamOptions if available.

Returns:

Optional.empty() if not specified.

Since:

4.0

getEncryptedFieldsOptions

public Optional<CollectionOptions.EncryptedFieldsOptions> getEncryptedFieldsOptions()

Get the encryptedFields if available.

Returns:

Optional.empty() if not specified.

Since:

4.5

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object