CreateIndexOperation (mongo-java-driver 3.0.0-beta2 API)

java.lang.Object
- com.mongodb.operation.CreateIndexOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>
```
public class CreateIndexOperation
extends Object
implements AsyncWriteOperation<Void>, WriteOperation<Void>
```
An operation that creates an index.

Since:

3.0

MongoDB documentation

Index options

Constructor Summary

Constructors
Constructor and Description

CreateIndexOperation(MongoNamespace namespace, BsonDocument key)
Construct a new instance.

Constructors
Constructor and Description
`CreateIndexOperation(MongoNamespace namespace, BsonDocument key)` Construct a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateIndexOperation`	`background(boolean background)` s if the index should be created in the background
`CreateIndexOperation`	`bits(Integer bits)` Sets the number of precision of the stored geohash value of the location data in 2d indexes.
`CreateIndexOperation`	`bucketSize(Double bucketSize)` Sets the specified the number of units within which to group the location values for geoHaystack Indexes
`CreateIndexOperation`	`defaultLanguage(String defaultLanguage)` Sets the language for the text index.
`CreateIndexOperation`	`dropDups(boolean dropDups)` Sets the legacy dropDups setting
`Void`	`execute(WriteBinding binding)` General execute which can return anything of type T
`void`	`executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback)` General execute which can return anything of type T
`CreateIndexOperation`	`expireAfterSeconds(Integer expireAfterSeconds)` s the time to live for documents in the collection
`Integer`	`getBits()` Gets the number of precision of the stored geohash value of the location data in 2d indexes.
`Double`	`getBucketSize()` Gets the specified the number of units within which to group the location values for geoHaystack Indexes
`String`	`getDefaultLanguage()` Gets the language for a text index.
`boolean`	`getDropDups()` Returns the legacy dropDups setting
`Integer`	`getExpireAfterSeconds()` Gets the time to live for documents in the collection
`BsonDocument`	`getKey()` Gets the index key.
`String`	`getLanguageOverride()` Gets the name of the field that contains the language string.
`Double`	`getMax()` Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
`Double`	`getMin()` Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
`String`	`getName()` Gets the name of the index.
`BsonDocument`	`getStorageEngineOptions()` Gets the storage engine options document for this index.
`Integer`	`getTextIndexVersion()` The text index version number.
`Integer`	`getTwoDSphereIndexVersion()` Gets the 2dsphere index version number.
`Integer`	`getVersion()` Gets the index version number.
`BsonDocument`	`getWeights()` Gets the weighting document for use with a text index
`boolean`	`isBackground()` Create the index in the background
`boolean`	`isSparse()` If true, the index only references documents with the specified field
`boolean`	`isUnique()` Gets if the index should be unique.
`CreateIndexOperation`	`languageOverride(String languageOverride)` Sets the name of the field that contains the language string.
`CreateIndexOperation`	`max(Double max)` Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
`CreateIndexOperation`	`min(Double min)` Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
`CreateIndexOperation`	`name(String name)` Sets the name of the index.
`CreateIndexOperation`	`sparse(boolean sparse)` Should the index only references documents with the specified field
`CreateIndexOperation`	`storageEngineOptions(BsonDocument storageEngineOptions)` Sets the storage engine options document for this index.
`CreateIndexOperation`	`textIndexVersion(Integer textIndexVersion)` Set the text index version number.
`CreateIndexOperation`	`twoDSphereIndexVersion(Integer sphereIndexVersion)` Sets the 2dsphere index version number.
`CreateIndexOperation`	`unique(boolean unique)` s if the index should be unique.
`CreateIndexOperation`	`version(Integer version)` Sets the index version number.
`CreateIndexOperation`	`weights(BsonDocument weights)` Sets the weighting document for use with a text index.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CreateIndexOperation
```
public CreateIndexOperation(MongoNamespace namespace,
                            BsonDocument key)
```
    Construct a new instance.
    
    Parameters:
    
    namespace - the database and collection namespace for the operation.
    
    key - the index key.
- Method Detail
  - getKey
```
public BsonDocument getKey()
```
    Gets the index key.
    
    Returns:
    
    the index key.
  - isBackground
```
public boolean isBackground()
```
    Create the index in the background
    
    Returns:
    
    true if should create the index in the background
  - background
```
public CreateIndexOperation background(boolean background)
```
    s if the index should be created in the background
    
    Parameters:
    
    background - true if should create the index in the background
    
    Returns:
    
    this
  - isUnique
```
public boolean isUnique()
```
    Gets if the index should be unique.
    
    Returns:
    
    true if the index should be unique
  - unique
```
public CreateIndexOperation unique(boolean unique)
```
    s if the index should be unique.
    
    Parameters:
    
    unique - if the index should be unique
    
    Returns:
    
    this
  - getName
```
public String getName()
```
    Gets the name of the index.
    
    Returns:
    
    the name of the index
  - name
```
public CreateIndexOperation name(String name)
```
    Sets the name of the index.
    
    Parameters:
    
    name - of the index
    
    Returns:
    
    this
  - isSparse
```
public boolean isSparse()
```
    If true, the index only references documents with the specified field
    
    Returns:
    
    if the index should only reference documents with the specified field
  - sparse
```
public CreateIndexOperation sparse(boolean sparse)
```
    Should the index only references documents with the specified field
    
    Parameters:
    
    sparse - if true, the index only references documents with the specified field
    
    Returns:
    
    this
  - getExpireAfterSeconds
```
public Integer getExpireAfterSeconds()
```
    Gets the time to live for documents in the collection
    
    Returns:
    
    the time to live for documents in the collection
    
    MongoDB documentation
    
    TTL
  - expireAfterSeconds
```
public CreateIndexOperation expireAfterSeconds(Integer expireAfterSeconds)
```
    s the time to live for documents in the collection
    
    Parameters:
    
    expireAfterSeconds - the time to live for documents in the collection
    
    Returns:
    
    this
    
    MongoDB documentation
    
    TTL
  - getVersion
```
public Integer getVersion()
```
    Gets the index version number.
    
    Returns:
    
    the index version number
  - version
```
public CreateIndexOperation version(Integer version)
```
    Sets the index version number.
    
    Parameters:
    
    version - the index version number
    
    Returns:
    
    this
  - getWeights
```
public BsonDocument getWeights()
```
    Gets the weighting document for use with a text index
    A document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score.
    
    Returns:
    
    the weighting document
    
    MongoDB documentation
    
    Control Search Results with Weights
  - weights
```
public CreateIndexOperation weights(BsonDocument weights)
```
    Sets the weighting document for use with a text index.
    A document that represents field and weight pairs. The weight is an integer ranging from 1 to 99,999 and denotes the significance of the field relative to the other indexed fields in terms of the score.
    
    Parameters:
    
    weights - the weighting document
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Control Search Results with Weights
  - getDefaultLanguage
```
public String getDefaultLanguage()
```
    Gets the language for a text index.
    The language that determines the list of stop words and the rules for the stemmer and tokenizer.
    
    Returns:
    
    the language for a text index.
    
    MongoDB documentation
    
    Text Search languages
  - defaultLanguage
```
public CreateIndexOperation defaultLanguage(String defaultLanguage)
```
    Sets the language for the text index.
    The language that determines the list of stop words and the rules for the stemmer and tokenizer.
    
    Parameters:
    
    defaultLanguage - the language for the text index.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Text Search languages
  - getLanguageOverride
```
public String getLanguageOverride()
```
    Gets the name of the field that contains the language string.
    For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.
    
    Returns:
    
    the name of the field that contains the language string.
    
    MongoDB documentation
    
    Language override
  - languageOverride
```
public CreateIndexOperation languageOverride(String languageOverride)
```
    Sets the name of the field that contains the language string.
    For text indexes, the name of the field, in the collection's documents, that contains the override language for the document.
    
    Parameters:
    
    languageOverride - the name of the field that contains the language string.
    
    Returns:
    
    this
    
    MongoDB documentation
    
    Language override
  - getTextIndexVersion
```
public Integer getTextIndexVersion()
```
    The text index version number.
    
    Returns:
    
    the text index version number.
  - textIndexVersion
```
public CreateIndexOperation textIndexVersion(Integer textIndexVersion)
```
    Set the text index version number.
    
    Parameters:
    
    textIndexVersion - the text index version number.
    
    Returns:
    
    this
  - getTwoDSphereIndexVersion
```
public Integer getTwoDSphereIndexVersion()
```
    Gets the 2dsphere index version number.
    
    Returns:
    
    the 2dsphere index version number
  - twoDSphereIndexVersion
```
public CreateIndexOperation twoDSphereIndexVersion(Integer sphereIndexVersion)
```
    Sets the 2dsphere index version number.
    
    Parameters:
    
    sphereIndexVersion - the 2dsphere index version number.
    
    Returns:
    
    this
  - getBits
```
public Integer getBits()
```
    Gets the number of precision of the stored geohash value of the location data in 2d indexes.
    
    Returns:
    
    the number of precision of the stored geohash value
  - bits
```
public CreateIndexOperation bits(Integer bits)
```
    Sets the number of precision of the stored geohash value of the location data in 2d indexes.
    
    Parameters:
    
    bits - the number of precision of the stored geohash value
    
    Returns:
    
    this
  - getMin
```
public Double getMin()
```
    Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
    
    Returns:
    
    the lower inclusive boundary for the longitude and latitude values.
  - min
```
public CreateIndexOperation min(Double min)
```
    Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
    
    Parameters:
    
    min - the lower inclusive boundary for the longitude and latitude values
    
    Returns:
    
    this
  - getMax
```
public Double getMax()
```
    Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
    
    Returns:
    
    the upper inclusive boundary for the longitude and latitude values.
  - max
```
public CreateIndexOperation max(Double max)
```
    Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
    
    Parameters:
    
    max - the upper inclusive boundary for the longitude and latitude values
    
    Returns:
    
    this
  - getBucketSize
```
public Double getBucketSize()
```
    Gets the specified the number of units within which to group the location values for geoHaystack Indexes
    
    Returns:
    
    the specified the number of units within which to group the location values for geoHaystack Indexes
    
    MongoDB documentation
    
    geoHaystack Indexes
  - bucketSize
```
public CreateIndexOperation bucketSize(Double bucketSize)
```
    Sets the specified the number of units within which to group the location values for geoHaystack Indexes
    
    Parameters:
    
    bucketSize - the specified the number of units within which to group the location values for geoHaystack Indexes
    
    Returns:
    
    this
    
    MongoDB documentation
    
    geoHaystack Indexes
  - getDropDups
```
public boolean getDropDups()
```
    Returns the legacy dropDups setting
    Prior to MongoDB 3.0 dropDups could be used with unique indexes allowing documents with duplicate values to be dropped when building the index. Later versions of MongoDB will silently ignore this setting.
    
    Returns:
    
    the legacy dropDups setting
    
    MongoDB documentation
    
    duplicate dropping
  - dropDups
```
public CreateIndexOperation dropDups(boolean dropDups)
```
    Sets the legacy dropDups setting
    Prior to MongoDB 3.0 dropDups could be used with unique indexes allowing documents with duplicate values to be dropped when building the index. Later versions of MongoDB will silently ignore this setting.
    
    Parameters:
    
    dropDups - the legacy dropDups setting
    
    Returns:
    
    this
    
    MongoDB documentation
    
    duplicate dropping
  - getStorageEngineOptions
```
public BsonDocument getStorageEngineOptions()
```
    Gets the storage engine options document for this index.
    
    Returns:
    
    the storage engine options
    
    Since server release
    
    3.0
  - storageEngineOptions
```
public CreateIndexOperation storageEngineOptions(BsonDocument storageEngineOptions)
```
    Sets the storage engine options document for this index.
    
    Parameters:
    
    storageEngineOptions - the storate engine options
    
    Returns:
    
    this
    
    Since server release
    
    3.0
  - execute
```
public Void execute(WriteBinding binding)
```
    Description copied from interface: WriteOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    execute in interface WriteOperation<Void>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    Returns:
    
    T, the result of the execution
  - executeAsync
```
public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<Void> callback)
```
    Description copied from interface: AsyncWriteOperation
    
    General execute which can return anything of type T
    
    Specified by:
    
    executeAsync in interface AsyncWriteOperation<Void>
    
    Parameters:
    
    binding - the binding to execute in the context of
    
    callback - the callback to be called when the operation has been executed

Class CreateIndexOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateIndexOperation

Method Detail

getKey

isBackground

background

isUnique

unique

getName

name

isSparse

sparse

getExpireAfterSeconds

expireAfterSeconds

getVersion

version

getWeights

weights

getDefaultLanguage

defaultLanguage

getLanguageOverride

languageOverride

getTextIndexVersion

textIndexVersion

getTwoDSphereIndexVersion

twoDSphereIndexVersion

getBits

bits

getMin

min

getMax

max

getBucketSize

bucketSize

getDropDups

dropDups

getStorageEngineOptions

storageEngineOptions

execute

executeAsync