MongoCollection (Grace Data MongoDB

org.grails.datastore.mapping.mongo.config.MongoCollection

@SuppressWarnings(value: rawtypes)
@CompileStatic
@Builder(builderStrategy: SimpleStrategy, prefix: )
class MongoCollection
extends Collection

Provides configuration options for mapping Mongo DBCollection instances

Authors:: Graeme Rocher

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`MongoCollection.Index`	Definition of an index

Inherited fields
Fields inherited from class	Fields
`class Collection`	`__$stMC, __$stMC`

Properties Summary

Properties
Type	Name and description
`String`	`database` The database to use
`Query.Order`	`sort`
`WriteConcern`	`writeConcern` Returns: The WriteConcern for the collection

Constructor Summary

Constructors
Constructor and description
`MongoCollection()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`MongoCollection`	`compoundIndex(Map compoundIndex)` Sets a compound index definition
	`List<Map>`	`getCompoundIndices()` Return all defined compound indices
	`List<Index>`	`getIndices()`
	`Query.Order`	`getSort()`
	`Entity<Attribute>`	`id(Closure identityConfig)`
	`void`	`index(Map<String, Object> definition)` Defines an index
	`void`	`index(Map<String, Object> definition, Map<String, Object> options)` Defines an index
	`protected MongoAttribute`	`newProperty()`
	`Entity`	`property(String name, Closure propertyConfig)`
	`MongoAttribute`	`property(Closure propertyConfig)`
	`MongoAttribute`	`property(Map propertyConfig)`
	`void`	`setCompoundIndex(Map compoundIndex)` Sets a compound index definition
	`MongoCollection`	`setSort(Object s)` Sets the default sorting
	`MongoCollection`	`sort(Query.Order sort)` Sets the default sorting
	`MongoCollection`	`sort(Map sort)` Sets the default sorting
	`Entity`	`version(Closure versionConfig)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Collection`	$getLookup, autoTimestamp, autowire, clone, clone, clone, collection, configureExisting, connection, connections, connections, datasource, datasources, defaultSort, equals, getAutoTimestamp, getAutowire, getClass, getCollection, getDatasources, getDefaultSort, getMetaClass, getProperty, getPropertyConfig, getPropertyConfigs, getSort, getStateless, getVersion, hashCode, id, id, invokeMethod, isAutoTimestamp, isAutowire, isStateless, isVersion, isVersioned, methodMissing, notify, notifyAll, property, property, property, property, propertyMissing, setAutoTimestamp, setAutowire, setCollection, setDatasources, setDefaultSort, setMetaClass, setProperty, setSort, setStateless, setVersion, stateless, super$1$clone, tenantId, toString, version, version, version, wait, wait, wait

- Property Detail
  - String database
    
    The database to use
    Returns:
    The name of the database
  - Query.Order sort
  - WriteConcern writeConcern
    
    Returns:
    The WriteConcern for the collection
- Constructor Detail
  - MongoCollection()
- Method Detail
  - MongoCollection compoundIndex(Map compoundIndex)
    
    Sets a compound index definition
    Parameters:
    compoundIndex - The compount index
  - List<Map> getCompoundIndices()
    
    Return all defined compound indices
    Returns:
    The compound indices to return
  - List<Index> getIndices()
  - Query.Order getSort()
  - @Override
    Entity<Attribute> id(@DelegatesTo(value: MongoAttribute.class)
    Closure identityConfig)
  - void index(Map<String, Object> definition)
    
    Defines an index
    Parameters:
    definition - The index definition
  - void index(Map<String, Object> definition, Map<String, Object> options)
    
    Defines an index
    Parameters:
    definition - The index definition
    options - The index options
  - @Override
    protected MongoAttribute newProperty()
  - @Override
    Entity property(String name, @DelegatesTo(value: MongoAttribute.class)
    Closure propertyConfig)
  - @Override
    MongoAttribute property(@DelegatesTo(value: MongoAttribute.class)
    Closure propertyConfig)
  - @Override
    MongoAttribute property(Map propertyConfig)
  - void setCompoundIndex(Map compoundIndex)
    
    Sets a compound index definition
    Parameters:
    compoundIndex - The compount index
  - MongoCollection setSort(Object s)
    
    Sets the default sorting
    Parameters:
    s - The sort object
    Returns:
    This collection
  - MongoCollection sort(Query.Order sort)
    
    Sets the default sorting
    Parameters:
    s - The sort object
    Returns:
    This collection
  - MongoCollection sort(Map sort)
    
    Sets the default sorting
    Parameters:
    s - The sort object
    Returns:
    This collection
  - @Override
    Entity version(@DelegatesTo(value: MongoAttribute.class)
    Closure versionConfig)

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class MongoCollection

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String database

Query.Order sort

WriteConcern writeConcern

Constructor Detail

MongoCollection()

Method Detail

MongoCollection compoundIndex(Map compoundIndex)

List<Map> getCompoundIndices()

List<Index> getIndices()

Query.Order getSort()

@Override
Entity<Attribute> id(@DelegatesTo(value: MongoAttribute.class)
Closure identityConfig)

void index(Map<String, Object> definition)

void index(Map<String, Object> definition, Map<String, Object> options)

@Override
protected MongoAttribute newProperty()

@Override
Entity property(String name, @DelegatesTo(value: MongoAttribute.class)
Closure propertyConfig)

@Override
MongoAttribute property(@DelegatesTo(value: MongoAttribute.class)
Closure propertyConfig)

@Override
MongoAttribute property(Map propertyConfig)

void setCompoundIndex(Map compoundIndex)

MongoCollection setSort(Object s)

MongoCollection sort(Query.Order sort)

MongoCollection sort(Map sort)

@Override
Entity version(@DelegatesTo(value: MongoAttribute.class)
Closure versionConfig)

[Groovy] Class MongoCollection

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String database

Query.Order sort

WriteConcern writeConcern

Constructor Detail

MongoCollection()

Method Detail

MongoCollection compoundIndex(Map compoundIndex)

List<Map> getCompoundIndices()

List<Index> getIndices()

Query.Order getSort()

@OverrideEntity<Attribute> id(@DelegatesTo(value: MongoAttribute.class)Closure identityConfig)

void index(Map<String, Object> definition)

void index(Map<String, Object> definition, Map<String, Object> options)

@Overrideprotected MongoAttribute newProperty()

@OverrideEntity property(String name, @DelegatesTo(value: MongoAttribute.class)Closure propertyConfig)

@OverrideMongoAttribute property(@DelegatesTo(value: MongoAttribute.class)Closure propertyConfig)

@OverrideMongoAttribute property(Map propertyConfig)

void setCompoundIndex(Map compoundIndex)

MongoCollection setSort(Object s)

MongoCollection sort(Query.Order sort)

MongoCollection sort(Map sort)

@OverrideEntity version(@DelegatesTo(value: MongoAttribute.class)Closure versionConfig)

@Override
Entity<Attribute> id(@DelegatesTo(value: MongoAttribute.class)
Closure identityConfig)

@Override
protected MongoAttribute newProperty()

@Override
Entity property(String name, @DelegatesTo(value: MongoAttribute.class)
Closure propertyConfig)

@Override
MongoAttribute property(@DelegatesTo(value: MongoAttribute.class)
Closure propertyConfig)

@Override
MongoAttribute property(Map propertyConfig)

@Override
Entity version(@DelegatesTo(value: MongoAttribute.class)
Closure versionConfig)