com.mongodb.client.model.CreateCollectionOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation
Show all versions of mongodb-driver-core Show documentation
The Java operations layer for the MongoDB Java Driver. Third parties can ' +
'wrap this layer to provide custom higher-level APIs
/*
* Copyright 2008-present MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.client.model;
import com.mongodb.AutoEncryptionSettings;
import com.mongodb.annotations.Beta;
import com.mongodb.lang.Nullable;
import org.bson.conversions.Bson;
import java.util.concurrent.TimeUnit;
import static com.mongodb.assertions.Assertions.notNull;
/**
* Options for creating a collection
*
* @mongodb.driver.manual reference/command/create/ Create Collection
* @mongodb.driver.manual core/timeseries-collections/ Time-series collections
* @since 3.0
*/
public class CreateCollectionOptions {
private long maxDocuments;
private boolean capped;
private long sizeInBytes;
private Bson storageEngineOptions;
private IndexOptionDefaults indexOptionDefaults = new IndexOptionDefaults();
private ValidationOptions validationOptions = new ValidationOptions();
private Collation collation;
private long expireAfterSeconds;
private TimeSeriesOptions timeSeriesOptions;
private ChangeStreamPreAndPostImagesOptions changeStreamPreAndPostImagesOptions;
private ClusteredIndexOptions clusteredIndexOptions;
private Bson encryptedFields;
/**
* Construct a new instance
*/
public CreateCollectionOptions() {
}
/**
* A shallow copy constructor.
*
* @param options The options to copy.
*
* @since 4.9
*/
public CreateCollectionOptions(final CreateCollectionOptions options) {
notNull("options", options);
maxDocuments = options.maxDocuments;
capped = options.capped;
sizeInBytes = options.sizeInBytes;
storageEngineOptions = options.storageEngineOptions;
indexOptionDefaults = options.indexOptionDefaults;
validationOptions = options.validationOptions;
collation = options.collation;
expireAfterSeconds = options.expireAfterSeconds;
timeSeriesOptions = options.timeSeriesOptions;
changeStreamPreAndPostImagesOptions = options.changeStreamPreAndPostImagesOptions;
clusteredIndexOptions = options.clusteredIndexOptions;
encryptedFields = options.encryptedFields;
}
/**
* Gets the maximum number of documents allowed in a capped collection.
*
* @return max number of documents in a capped collection
*/
public long getMaxDocuments() {
return maxDocuments;
}
/**
* Sets the maximum number of documents allowed in a capped collection.
*
* @param maxDocuments the maximum number of documents allowed in capped collection
* @return this
*/
public CreateCollectionOptions maxDocuments(final long maxDocuments) {
this.maxDocuments = maxDocuments;
return this;
}
/**
* Gets whether the collection is capped.
*
* @return whether the collection is capped
*/
public boolean isCapped() {
return capped;
}
/**
* sets whether the collection is capped.
*
* @param capped whether the collection is capped
* @return this
*/
public CreateCollectionOptions capped(final boolean capped) {
this.capped = capped;
return this;
}
/**
* Gets the maximum size in bytes of a capped collection.
*
* @return the maximum size of a capped collection.
*/
public long getSizeInBytes() {
return sizeInBytes;
}
/**
* Gets the maximum size of in bytes of a capped collection.
*
* @param sizeInBytes the maximum size of a capped collection.
* @return this
*/
public CreateCollectionOptions sizeInBytes(final long sizeInBytes) {
this.sizeInBytes = sizeInBytes;
return this;
}
/**
* Gets the storage engine options document for the collection.
*
* @return the storage engine options
* @mongodb.server.release 3.0
*/
@Nullable
public Bson getStorageEngineOptions() {
return storageEngineOptions;
}
/**
* Sets the storage engine options document defaults for the collection
*
* @param storageEngineOptions the storage engine options
* @return this
* @mongodb.server.release 3.0
*/
public CreateCollectionOptions storageEngineOptions(@Nullable final Bson storageEngineOptions) {
this.storageEngineOptions = storageEngineOptions;
return this;
}
/**
* Gets the index option defaults for the collection.
*
* @return the index option defaults
* @since 3.2
* @mongodb.server.release 3.2
*/
public IndexOptionDefaults getIndexOptionDefaults() {
return indexOptionDefaults;
}
/**
* Sets the index option defaults for the collection.
*
* @param indexOptionDefaults the index option defaults
* @return this
* @since 3.2
* @mongodb.server.release 3.2
*/
public CreateCollectionOptions indexOptionDefaults(final IndexOptionDefaults indexOptionDefaults) {
this.indexOptionDefaults = notNull("indexOptionDefaults", indexOptionDefaults);
return this;
}
/**
* Gets the validation options for documents being inserted or updated in a collection
*
* @return the validation options
* @since 3.2
* @mongodb.server.release 3.2
*/
public ValidationOptions getValidationOptions() {
return validationOptions;
}
/**
* Sets the validation options for documents being inserted or updated in a collection
*
* @param validationOptions the validation options
* @return this
* @since 3.2
* @mongodb.server.release 3.2
*/
public CreateCollectionOptions validationOptions(final ValidationOptions validationOptions) {
this.validationOptions = notNull("validationOptions", validationOptions);
return this;
}
/**
* Returns the collation options
*
* @return the collation options
* @since 3.4
* @mongodb.server.release 3.4
*/
@Nullable
public Collation getCollation() {
return collation;
}
/**
* Sets the collation options
*
* A null value represents the server default.
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
public CreateCollectionOptions collation(@Nullable final Collation collation) {
this.collation = collation;
return this;
}
/**
* Returns the expire-after option. The default value is 0, which indicates no expiration.
*
* @param timeUnit the time unit
* @return the expire-after option, which may be null.
* @since 4.3
* @mongodb.driver.manual core/timeseries-collections/ Time-series collections
*/
public long getExpireAfter(final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
return timeUnit.convert(expireAfterSeconds, TimeUnit.SECONDS);
}
/**
* Sets the expire-after option.
*
*
* A duration indicating after how long old time-series data should be deleted. Partial seconds are ignored.
*
*
* Currently applies only to time-series collections, so if this value is set then so must the time-series options
*
* @param expireAfter the expire-after duration. After conversion to seconds using
* {@link TimeUnit#convert(long, java.util.concurrent.TimeUnit)}, the value must be >= 0. A value of 0 indicates no expiration.
* @param timeUnit the time unit
* @return this
* @since 4.3
* @see #timeSeriesOptions(TimeSeriesOptions)
* @mongodb.driver.manual core/timeseries-collections/ Time-series collections
*/
public CreateCollectionOptions expireAfter(final long expireAfter, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
long asSeconds = TimeUnit.SECONDS.convert(expireAfter, timeUnit);
if (asSeconds < 0) {
throw new IllegalArgumentException("expireAfter, after conversion to seconds, must be >= 0");
}
this.expireAfterSeconds = asSeconds;
return this;
}
/**
* Gets the time series collection options.
*
* @return the options for a time-series collection
* @since 4.3
* @mongodb.driver.manual core/timeseries-collections/ Time-series collections
*/
@Nullable
public TimeSeriesOptions getTimeSeriesOptions() {
return timeSeriesOptions;
}
/**
* Sets the time-series collection options.
*
* @param timeSeriesOptions the time-series options
* @return this
* @since 4.3
* @mongodb.driver.manual core/timeseries-collections/ Time-series collections
*/
public CreateCollectionOptions timeSeriesOptions(final TimeSeriesOptions timeSeriesOptions) {
this.timeSeriesOptions = timeSeriesOptions;
return this;
}
/**
* Gets the clustered index collection options.
*
* @return the options for a clustered index
* @since 4.7
*/
@Nullable
public ClusteredIndexOptions getClusteredIndexOptions() {
return clusteredIndexOptions;
}
/**
* Sets the clustered index collection options.
*
* @param clusteredIndexOptions the clustered index options
* @return this
* @since 4.7
*/
public CreateCollectionOptions clusteredIndexOptions(final ClusteredIndexOptions clusteredIndexOptions) {
this.clusteredIndexOptions = clusteredIndexOptions;
return this;
}
/**
* Gets change stream pre- and post- images options.
*
* @return the options for change stream pre- and post- images
* @since 4.7
*/
@Nullable
public ChangeStreamPreAndPostImagesOptions getChangeStreamPreAndPostImagesOptions() {
return changeStreamPreAndPostImagesOptions;
}
/**
* Sets the change stream pre- and post- images options.
*
* @param changeStreamPreAndPostImagesOptions the change stream pre- and post- images options
* @return this
* @since 4.7
*/
public CreateCollectionOptions changeStreamPreAndPostImagesOptions(
final ChangeStreamPreAndPostImagesOptions changeStreamPreAndPostImagesOptions) {
this.changeStreamPreAndPostImagesOptions = changeStreamPreAndPostImagesOptions;
return this;
}
/**
* Gets any explicitly set encrypted fields.
*
* Note: If not set the driver will lookup the namespace in {@link AutoEncryptionSettings#getEncryptedFieldsMap()}
* @return the encrypted fields document
* @since 4.7
* @mongodb.server.release 7.0
*/
@Beta(Beta.Reason.SERVER)
@Nullable
public Bson getEncryptedFields() {
return encryptedFields;
}
/**
* Sets the encrypted fields
*
* Explicitly set encrypted fields.
* Note: If not set the driver will lookup the namespace in {@link AutoEncryptionSettings#getEncryptedFieldsMap()}
* @param encryptedFields the encrypted fields document
* @return this
* @since 4.7
* @mongodb.driver.manual core/security-client-side-encryption/ In-use encryption
* @mongodb.server.release 7.0
*/
@Beta(Beta.Reason.SERVER)
public CreateCollectionOptions encryptedFields(@Nullable final Bson encryptedFields) {
this.encryptedFields = encryptedFields;
return this;
}
@Override
public String toString() {
return "CreateCollectionOptions{"
+ ", maxDocuments=" + maxDocuments
+ ", capped=" + capped
+ ", sizeInBytes=" + sizeInBytes
+ ", storageEngineOptions=" + storageEngineOptions
+ ", indexOptionDefaults=" + indexOptionDefaults
+ ", validationOptions=" + validationOptions
+ ", collation=" + collation
+ ", expireAfterSeconds=" + expireAfterSeconds
+ ", timeSeriesOptions=" + timeSeriesOptions
+ ", changeStreamPreAndPostImagesOptions=" + changeStreamPreAndPostImagesOptions
+ ", encryptedFields=" + encryptedFields
+ '}';
}
}