io.toro.martini.database

Class CreateCollectionOptions

java.lang.Object

io.toro.martini.database.CreateCollectionOptions

All Implemented Interfaces:

Serializable

public abstract class CreateCollectionOptions
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCollectionOptions.Builder

Constructor Summary

Constructors

Constructor and Description
CreateCollectionOptions()

Method Summary

Modifier and Type	Method and Description
static CreateCollectionOptions.Builder	builder()
abstract boolean	capped() To create a capped collection, specify true.
abstract io.toro.martini.database.Collation	collation() Specifies the default collation for the collection.
abstract String	indexOptionDefaults() Allows users to specify a default configuration for indexes when creating a collection.
abstract long	maxDocuments() The maximum number of documents allowed in the capped collection.
abstract long	sizeInBytes() Specify a maximum size in bytes for a capped collection.
abstract String	storageEngineOptions() Available for the WiredTiger storage engine only.
CreateCollectionOptions.Builder	toBuilder()
abstract io.toro.martini.database.ValidationOptions	validationOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateCollectionOptions

public CreateCollectionOptions()

Method Detail

maxDocuments

public abstract long maxDocuments()

The maximum number of documents allowed in the capped collection. The size limit takes precedence over this limit. If a capped collection reaches the size limit before it reaches the maximum number of documents, MongoDB removes old documents. If you prefer to use the max limit, ensure that the size limit, which is required for a capped collection, is sufficient to contain the maximum number of documents.

capped

public abstract boolean capped()

To create a capped collection, specify true. If you specify true, you must also set a maximum size in the size field.

sizeInBytes

public abstract long sizeInBytes()

Specify a maximum size in bytes for a capped collection. Once a capped collection reaches its maximum size, MongoDB removes the older documents to make space for the new documents. The sizeInBytes field is required for capped collections and ignored for other collections.

storageEngineOptions

@Nullable
public abstract String storageEngineOptions()

Available for the WiredTiger storage engine only. Allows users to specify configuration to the storage engine on a per-collection basis when creating a collection. The value of the storageEngine option should take the following form: { <storage-engine-name>: <options> }

indexOptionDefaults

@Nullable
public abstract String indexOptionDefaults()

Allows users to specify a default configuration for indexes when creating a collection. The indexOptionDefaults option accepts a storageEngine document, which should take the following form: { <storage-engine-name>: <options> }

validationOptions

public abstract io.toro.martini.database.ValidationOptions validationOptions()

collation

public abstract io.toro.martini.database.Collation collation()

Specifies the default collation for the collection. Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.

toBuilder

public CreateCollectionOptions.Builder toBuilder()

builder

public static CreateCollectionOptions.Builder builder()