MongoEntity (GORM for MongoDB

grails.mongodb.MongoEntity

All Implemented Interfaces and Traits:

DynamicAttributes, GormEntity<D>
```
@groovy.transform.Trait
@groovy.transform.CompileStatic
trait MongoEntity<D>
extends java.lang.Object
implements DynamicAttributes, GormEntity<D>
```
Enhances the default GormEntity class with MongoDB specific methods
Authors:
Graeme Rocher
Since:
5.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.util.List<D>`	`aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate)` Execute a MongoDB aggregation pipeline.
	`static java.util.List<D>`	`aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate, com.mongodb.ReadPreference readPreference)` Execute a MongoDB aggregation pipeline.
	`static java.lang.Number`	`count(org.bson.conversions.Bson filter)` Counts the number of the entities in the collection.
	`static int`	`countHits(java.lang.String query)` Counts the number of hits
	`static MongoCriteriaBuilder`	`createCriteria()` Returns: Custom MongoDB criteria builder
	`private static MongoStaticApi`	`currentMongoStaticApi()`
	`static com.mongodb.client.FindIterable<D>`	`find(org.bson.conversions.Bson filter)` Finds all of the entities in the collection.
	`static D`	`findOneAndDelete(org.bson.conversions.Bson filter)` Atomically find a document and remove it.
	`static D`	`findOneAndDelete(org.bson.conversions.Bson filter, com.mongodb.client.model.FindOneAndDeleteOptions options)` Atomically find a document and remove it.
	`static com.mongodb.client.MongoCollection<org.bson.Document>`	`getCollection()` The actual collection that this entity maps to.
	`static java.lang.String`	`getCollectionName()` Returns: The name of the Mongo collection that entity maps to
	`static com.mongodb.client.MongoDatabase`	`getDB()` Returns: The database for this domain class
	`org.bson.Document`	`getDbo()` Return the DBObject instance for the entity
	`java.lang.Object`	`propertyMissing(java.lang.String name)` Allows accessing to dynamic properties with the dot operator
	`java.lang.Object`	`propertyMissing(java.lang.String name, java.lang.Object val)` Allows setting a dynamic property via the dot operator
	`static java.util.List<D>`	`search(java.lang.String query, java.util.Map options)` Search for entities using the given query
	`static java.util.List<D>`	`searchTop(java.lang.String query, int limit, java.util.Map options)` Searches for the top results ordered by the MongoDB score
	`static java.lang.String`	`useCollection(java.lang.String collectionName)` Use the given collection for this entity for the scope of the session
	`static java.lang.String`	`useDatabase(java.lang.String databaseName)` Use the given database for this entity for the scope of the session
`<T>`	`static T`	`withCollection(java.lang.String collectionName, groovy.lang.Closure<T> callable)` Use the given collection for this entity for the scope of the closure call
`<T>`	`static T`	`withConnection(java.lang.String connectionName, groovy.lang.Closure callable)` Perform an operation with the given connection
`<T>`	`static T`	`withDatabase(java.lang.String databaseName, groovy.lang.Closure<T> callable)` Use the given database for this entity for the scope of the closure call

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Method Detail
  - static java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate)
    
    Execute a MongoDB aggregation pipeline. Note that the pipeline should return documents that represent this domain class as each return document will be converted to a domain instance in the result set
    Parameters:
    pipeline - The pipeline
    doWithAggregate - The function to transform the aggregate iterable (optional)
    Returns:
    A mongodb result list
  - static java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate, com.mongodb.ReadPreference readPreference)
    
    Execute a MongoDB aggregation pipeline. Note that the pipeline should return documents that represent this domain class as each return document will be converted to a domain instance in the result set
    Parameters:
    pipeline - The pipeline
    doWithAggregate - The function to transform the aggregate iterable (optional)
    Returns:
    A mongodb result list
  - static java.lang.Number count(org.bson.conversions.Bson filter)
    
    Counts the number of the entities in the collection.
    Parameters:
    filter - the query filter
    Returns:
    the find iterable interface
  - static int countHits(java.lang.String query)
    
    Counts the number of hits
    Parameters:
    query - The query
    Returns:
    The hit count
  - static MongoCriteriaBuilder createCriteria()
    
    Returns:
    Custom MongoDB criteria builder
  - private static MongoStaticApi currentMongoStaticApi()
  - static com.mongodb.client.FindIterable<D> find(org.bson.conversions.Bson filter)
    
    Finds all of the entities in the collection.
    Parameters:
    filter - the query filter
    Returns:
    the find iterable interface
  - static D findOneAndDelete(org.bson.conversions.Bson filter)
    
    Atomically find a document and remove it.
    Parameters:
    filter - the query filter to find the document with
    Returns:
    the document that was removed. If no documents matched the query filter, then null will be returned
  - static D findOneAndDelete(org.bson.conversions.Bson filter, com.mongodb.client.model.FindOneAndDeleteOptions options)
    
    Atomically find a document and remove it.
    Parameters:
    filter - the query filter to find the document with
    Returns:
    the document that was removed. If no documents matched the query filter, then null will be returned
  - static com.mongodb.client.MongoCollection<org.bson.Document> getCollection()
    
    The actual collection that this entity maps to.
    Returns:
    The actual collection
  - static java.lang.String getCollectionName()
    
    Returns:
    The name of the Mongo collection that entity maps to
  - static com.mongodb.client.MongoDatabase getDB()
    
    Returns:
    The database for this domain class
  - @java.lang.Deprecated org.bson.Document getDbo()
    
    Return the DBObject instance for the entity
    deprecated:
    use dynamic properties instead
    
    Parameters:
    instance - The instance
    Returns:
    The DBObject instance
  - @java.lang.Override java.lang.Object propertyMissing(java.lang.String name)
    
    Allows accessing to dynamic properties with the dot operator
    Parameters:
    instance - The instance
    name - The property name
    Returns:
    The property value
  - java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)
    
    Allows setting a dynamic property via the dot operator
    Parameters:
    instance - The instance
    name - The property name
    val - The value
  - static java.util.List<D> search(java.lang.String query, java.util.Map options)
    
    Search for entities using the given query
    Parameters:
    query - The query
    Returns:
    The results
  - static java.util.List<D> searchTop(java.lang.String query, int limit, java.util.Map options)
    
    Searches for the top results ordered by the MongoDB score
    Parameters:
    query - The query
    limit - The maximum number of results. Defaults to 5.
    Returns:
    The results
  - static java.lang.String useCollection(java.lang.String collectionName)
    
    Use the given collection for this entity for the scope of the session
    Parameters:
    collectionName - The collection name
    Returns:
    The previous collection name
  - static java.lang.String useDatabase(java.lang.String databaseName)
    
    Use the given database for this entity for the scope of the session
    Parameters:
    databaseName - The collection name
    Returns:
    The previous database name
  - <T> static T withCollection(java.lang.String collectionName, groovy.lang.Closure<T> callable)
    
    Use the given collection for this entity for the scope of the closure call
    Parameters:
    collectionName - The collection name
    callable - The callable
    Returns:
    The result of the closure
  - <T> static T withConnection(java.lang.String connectionName, @groovy.lang.DelegatesTo(value: MongoAllOperations) groovy.lang.Closure callable)
    
    Perform an operation with the given connection
    Parameters:
    connectionName - The name of the connection
    callable - The operation
    Returns:
    The return value of the closure
  - <T> static T withDatabase(java.lang.String databaseName, groovy.lang.Closure<T> callable)
    
    Use the given database for this entity for the scope of the closure call
    Parameters:
    databaseName - The collection name
    callable - The callable
    Returns:
    The result of the closure

Summary:
Method

| Detail:
Method

Groovy Documentation

[Groovy] Trait MongoEntity<D>

Methods Summary

Inherited Methods Summary

Method Detail

static java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate)

static java.util.List<D> aggregate(java.util.List pipeline, java.util.function.Function<com.mongodb.client.AggregateIterable, com.mongodb.client.AggregateIterable> doWithAggregate, com.mongodb.ReadPreference readPreference)

static java.lang.Number count(org.bson.conversions.Bson filter)

static int countHits(java.lang.String query)

static MongoCriteriaBuilder createCriteria()

private static MongoStaticApi currentMongoStaticApi()

static com.mongodb.client.FindIterable<D> find(org.bson.conversions.Bson filter)

static D findOneAndDelete(org.bson.conversions.Bson filter)

static D findOneAndDelete(org.bson.conversions.Bson filter, com.mongodb.client.model.FindOneAndDeleteOptions options)

static com.mongodb.client.MongoCollection<org.bson.Document> getCollection()

static java.lang.String getCollectionName()

static com.mongodb.client.MongoDatabase getDB()

@java.lang.Deprecated org.bson.Document getDbo()

@java.lang.Override java.lang.Object propertyMissing(java.lang.String name)

java.lang.Object propertyMissing(java.lang.String name, java.lang.Object val)

static java.util.List<D> search(java.lang.String query, java.util.Map options)

static java.util.List<D> searchTop(java.lang.String query, int limit, java.util.Map options)

static java.lang.String useCollection(java.lang.String collectionName)

static java.lang.String useDatabase(java.lang.String databaseName)

<T> static T withCollection(java.lang.String collectionName, groovy.lang.Closure<T> callable)

<T> static T withConnection(java.lang.String connectionName, @groovy.lang.DelegatesTo(value: MongoAllOperations) groovy.lang.Closure callable)

<T> static T withDatabase(java.lang.String databaseName, groovy.lang.Closure<T> callable)