MongoCollection (GORM for MongoDB

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

@java.lang.SuppressWarnings(value: rawtypes)
@groovy.transform.CompileStatic
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
class MongoCollection
extends java.util.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

Field Summary

Fields
Modifiers	Name	Description
`private java.util.List<java.util.Map>`	`compoundIndices`
`private java.lang.String`	`database`	The database to use
`private java.util.List<Index>`	`indices`
`private com.mongodb.WriteConcern`	`writeConcern`	Returns: The com.mongodb.WriteConcern for the collection

Properties Summary

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

Constructor Summary

Constructors
Constructor and description
`MongoCollection ()`

Methods Summary

Methods
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()`
	`Order`	`getSort()`
	`Entity<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()`
	`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(Order sort)` Sets the default sorting
	`MongoCollection`	`sort(java.util.Map sort)` Sets the default sorting
	`Entity`	`version(groovy.lang.Closure versionConfig)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface java.util.Collection`	java.util.Collection#add(java.lang.Object), java.util.Collection#remove(java.lang.Object), java.util.Collection#equals(java.lang.Object), java.util.Collection#hashCode(), java.util.Collection#clear(), java.util.Collection#isEmpty(), java.util.Collection#contains(java.lang.Object), java.util.Collection#size(), java.util.Collection#toArray(java.util.function.IntFunction), java.util.Collection#toArray(), java.util.Collection#toArray([Ljava.lang.Object;), java.util.Collection#iterator(), java.util.Collection#spliterator(), java.util.Collection#addAll(java.util.Collection), java.util.Collection#stream(), java.util.Collection#containsAll(java.util.Collection), java.util.Collection#retainAll(java.util.Collection), java.util.Collection#removeAll(java.util.Collection), java.util.Collection#removeIf(java.util.function.Predicate), java.util.Collection#parallelStream(), java.util.Collection#forEach(java.util.function.Consumer)

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

Groovy Documentation

[Groovy] Class MongoCollection

Nested Class Summary

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

private java.util.List<java.util.Map> compoundIndices

private java.lang.String database

private java.util.List<Index> indices

private com.mongodb.WriteConcern writeConcern

Property Detail

java.lang.String database

Order sort

com.mongodb.WriteConcern writeConcern

Constructor Detail

MongoCollection()

Method Detail

MongoCollection compoundIndex(java.util.Map compoundIndex)

java.util.List<java.util.Map> getCompoundIndices()

java.util.List<Index> getIndices()

Order getSort()

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

void index(java.util.Map<java.lang.String, java.lang.Object> definition)

void index(java.util.Map<java.lang.String, java.lang.Object> definition, java.util.Map<java.lang.String, java.lang.Object> options)

@java.lang.Override protected MongoAttribute newProperty()

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

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

@java.lang.Override MongoAttribute property(java.util.Map propertyConfig)

void setCompoundIndex(java.util.Map compoundIndex)

MongoCollection setSort(java.lang.Object s)

MongoCollection sort(Order sort)

MongoCollection sort(java.util.Map sort)

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