@java.lang.SuppressWarnings(value: rawtypes) @groovy.transform.CompileStatic @groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: ) class MongoCollection extends org.grails.datastore.mapping.document.config.Collection
Provides configuration options for mapping Mongo DBCollection instances
Modifiers | Name | Description |
---|---|---|
static class |
MongoCollection.Index |
Definition of an index |
Fields inherited from class | Fields |
---|---|
class org.grails.datastore.mapping.document.config.Collection |
__$stMC, ALL_DATA_SOURCES, DEFAULT_DATA_SOURCE, __$stMC |
Type | Name and description |
---|---|
java.lang.String |
database The database to use |
org.grails.datastore.mapping.query.Query$Order |
sort |
com.mongodb.WriteConcern |
writeConcern
|
Constructor and description |
---|
MongoCollection() |
Type Params | Return Type | Name and description |
---|---|---|
|
MongoCollection |
compoundIndex(java.util.Map compoundIndex) Sets a compound index definition |
|
java.util.List<java.util.Map> |
getCompoundIndices() Return all defined compound indices |
|
java.util.List<Index> |
getIndices() |
|
org.grails.datastore.mapping.query.Query$Order |
getSort() |
|
org.grails.datastore.mapping.config.Entity<org.grails.datastore.mapping.document.config.Attribute> |
id(groovy.lang.Closure identityConfig) |
|
void |
index(java.util.Map<java.lang.String, java.lang.Object> definition) Defines an index |
|
void |
index(java.util.Map<java.lang.String, java.lang.Object> definition, java.util.Map<java.lang.String, java.lang.Object> options) Defines an index |
|
protected MongoAttribute |
newProperty() |
|
org.grails.datastore.mapping.config.Entity |
property(java.lang.String name, groovy.lang.Closure propertyConfig) |
|
MongoAttribute |
property(groovy.lang.Closure propertyConfig) |
|
MongoAttribute |
property(java.util.Map propertyConfig) |
|
void |
setCompoundIndex(java.util.Map compoundIndex) Sets a compound index definition |
|
MongoCollection |
setSort(java.lang.Object s) Sets the default sorting |
|
MongoCollection |
sort(org.grails.datastore.mapping.query.Query$Order sort) Sets the default sorting |
|
MongoCollection |
sort(java.util.Map sort) Sets the default sorting |
|
org.grails.datastore.mapping.config.Entity |
version(groovy.lang.Closure versionConfig) |
Methods inherited from class | Name |
---|---|
class org.grails.datastore.mapping.document.config.Collection |
org.grails.datastore.mapping.document.config.Collection#getCollection(), org.grails.datastore.mapping.document.config.Collection#$getLookup(), org.grails.datastore.mapping.document.config.Collection#setCollection(java.lang.String), org.grails.datastore.mapping.document.config.Collection#collection(java.lang.String), org.grails.datastore.mapping.document.config.Collection#propertyMissing(java.lang.String, java.lang.Object), org.grails.datastore.mapping.document.config.Collection#methodMissing(java.lang.String, java.lang.Object), org.grails.datastore.mapping.document.config.Collection#setVersion(boolean), org.grails.datastore.mapping.document.config.Collection#isVersion(), org.grails.datastore.mapping.document.config.Collection#datasources(java.util.List), org.grails.datastore.mapping.document.config.Collection#autowire(boolean), org.grails.datastore.mapping.document.config.Collection#isVersioned(), org.grails.datastore.mapping.document.config.Collection#isStateless(), org.grails.datastore.mapping.document.config.Collection#setAutoTimestamp(boolean), org.grails.datastore.mapping.document.config.Collection#defaultSort(java.lang.Object), org.grails.datastore.mapping.document.config.Collection#getPropertyConfig(java.lang.String), org.grails.datastore.mapping.document.config.Collection#autoTimestamp(boolean), org.grails.datastore.mapping.document.config.Collection#tenantId(java.lang.String), org.grails.datastore.mapping.document.config.Collection#isAutoTimestamp(), org.grails.datastore.mapping.document.config.Collection#isAutowire(), org.grails.datastore.mapping.document.config.Collection#getPropertyConfigs(), org.grails.datastore.mapping.document.config.Collection#setSort(java.lang.Object), org.grails.datastore.mapping.document.config.Collection#datasource(java.lang.String), org.grails.datastore.mapping.document.config.Collection#configureExisting(org.grails.datastore.mapping.config.Entity, groovy.lang.Closure), org.grails.datastore.mapping.document.config.Collection#stateless(boolean), org.grails.datastore.mapping.document.config.Collection#getStateless(), org.grails.datastore.mapping.document.config.Collection#setStateless(boolean), org.grails.datastore.mapping.document.config.Collection#getAutoTimestamp(), org.grails.datastore.mapping.document.config.Collection#getAutowire(), org.grails.datastore.mapping.document.config.Collection#setAutowire(boolean), org.grails.datastore.mapping.document.config.Collection#getDefaultSort(), org.grails.datastore.mapping.document.config.Collection#setDefaultSort(java.lang.Object), org.grails.datastore.mapping.document.config.Collection#getDatasources(), org.grails.datastore.mapping.document.config.Collection#setDatasources(java.util.List), org.grails.datastore.mapping.document.config.Collection#version(groovy.lang.Closure), org.grails.datastore.mapping.document.config.Collection#version(java.util.Map), org.grails.datastore.mapping.document.config.Collection#version(boolean), org.grails.datastore.mapping.document.config.Collection#id(groovy.lang.Closure), org.grails.datastore.mapping.document.config.Collection#id(java.util.Map), org.grails.datastore.mapping.document.config.Collection#getSort(), org.grails.datastore.mapping.document.config.Collection#connection(java.lang.String), org.grails.datastore.mapping.document.config.Collection#property(java.util.Map), org.grails.datastore.mapping.document.config.Collection#property(groovy.lang.Closure), org.grails.datastore.mapping.document.config.Collection#property(java.lang.String, groovy.lang.Closure), org.grails.datastore.mapping.document.config.Collection#property(java.lang.String, java.util.Map), org.grails.datastore.mapping.document.config.Collection#getVersion(), org.grails.datastore.mapping.document.config.Collection#connections(java.util.List), org.grails.datastore.mapping.document.config.Collection#connections([Ljava.lang.String;), org.grails.datastore.mapping.document.config.Collection#getMetaClass(), org.grails.datastore.mapping.document.config.Collection#setMetaClass(groovy.lang.MetaClass), org.grails.datastore.mapping.document.config.Collection#wait(long, int), org.grails.datastore.mapping.document.config.Collection#wait(), org.grails.datastore.mapping.document.config.Collection#wait(long), org.grails.datastore.mapping.document.config.Collection#equals(java.lang.Object), org.grails.datastore.mapping.document.config.Collection#toString(), org.grails.datastore.mapping.document.config.Collection#hashCode(), org.grails.datastore.mapping.document.config.Collection#getClass(), org.grails.datastore.mapping.document.config.Collection#notify(), org.grails.datastore.mapping.document.config.Collection#notifyAll(), org.grails.datastore.mapping.document.config.Collection#getProperty(java.lang.String), org.grails.datastore.mapping.document.config.Collection#setProperty(java.lang.String, java.lang.Object), org.grails.datastore.mapping.document.config.Collection#invokeMethod(java.lang.String, java.lang.Object) |
The database to use
Sets a compound index definition
compoundIndex
- The compount indexReturn all defined compound indices
Defines an index
definition
- The index definitionDefines an index
definition
- The index definitionoptions
- The index optionsSets a compound index definition
compoundIndex
- The compount indexSets the default sorting
s
- The sort objectSets the default sorting
s
- The sort objectSets the default sorting
s
- The sort objectGroovy Documentation