/*
* Copyright 2010 gauti.
*
* 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.
* under the License.
*/
package org.mongodb.morphia.annotations;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
Defines the options to be used when declaring an index.
/**
* Defines the options to be used when declaring an index.
*/
@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface IndexOptions {
Create the index in the background
/**
* Create the index in the background
*/
boolean background() default false;
disables validation for the field name
/**
* disables validation for the field name
*/
boolean disableValidation() default false;
Tells the unique index to drop duplicates silently when creating; only the first will be kept
Deprecated: Support for this has been removed from the server. This value is ignored.
/**
* Tells the unique index to drop duplicates silently when creating; only the first will be kept
*
* @deprecated Support for this has been removed from the server. This value is ignored.
*/
@Deprecated
boolean dropDups() default false;
defines the time to live for documents in the collection
/**
* defines the time to live for documents in the collection
*/
int expireAfterSeconds() default -1;
Default language for the index.
/**
* Default language for the index.
*/
String language() default "";
The field to use to override the default language.
/**
* The field to use to override the default language.
*/
String languageOverride() default "";
The name of the index to create; default is to let the mongodb create a name (in the form of key1_1/-1_key2_1/-1...)
/**
* The name of the index to create; default is to let the mongodb create a name (in the form of key1_1/-1_key2_1/-1...)
*/
String name() default "";
Create the index with the sparse option
/**
* Create the index with the sparse option
*/
boolean sparse() default false;
Creates the index as a unique value index; inserting duplicates values in this field will cause errors
/**
* Creates the index as a unique value index; inserting duplicates values in this field will cause errors
*/
boolean unique() default false;
Defines the collation to be used for this index
Since: 1.3
/**
* Defines the collation to be used for this index
* @since 1.3
*/
String partialFilter() default "";
Defines the collation to be used for this index
Since: 1.3
/**
* Defines the collation to be used for this index
* @since 1.3
*/
Collation collation() default @Collation(locale = "");
}