MongoDatastore (GORM for Mongodb 5.0.13)

org.grails.datastore.mapping.mongo.MongoDatastore

All Implemented Interfaces and Traits:

org.springframework.beans.factory.InitializingBean, org.grails.datastore.mapping.model.MappingContext$Listener, org.springframework.beans.factory.DisposableBean, StatelessDatastore
```
public class MongoDatastore
extends AbstractDatastore
```
A Datastore implementation for the Mongo document store.
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`CODEC_ENGINE`
`static java.lang.String`	`INDEX_ATTRIBUTES`
`static java.lang.String`	`SETTING_CONNECTION_STRING`
`static java.lang.String`	`SETTING_DATABASE_NAME`
`static java.lang.String`	`SETTING_DEFAULT_MAPPING`
`static java.lang.String`	`SETTING_ENGINE`
`static java.lang.String`	`SETTING_FAIL_ON_ERROR`
`static java.lang.String`	`SETTING_HOST`
`static java.lang.String`	`SETTING_OPTIONS`
`static java.lang.String`	`SETTING_PASSWORD`
`static java.lang.String`	`SETTING_PORT`
`static java.lang.String`	`SETTING_REPLICA_PAIR`
`static java.lang.String`	`SETTING_REPLICA_SET`
`static java.lang.String`	`SETTING_STATELESS`
`static java.lang.String`	`SETTING_URL`
`static java.lang.String`	`SETTING_USERNAME`
`protected boolean`	`codecEngine`
`protected org.bson.codecs.configuration.CodecRegistry`	`codecRegistry`
`protected java.lang.String`	`defaultDatabase`
`protected com.mongodb.MongoClient`	`mongo`
`protected java.util.Map<PersistentEntity, java.lang.String>`	`mongoCollections`
`protected java.util.Map<PersistentEntity, java.lang.String>`	`mongoDatabases`
`protected com.mongodb.MongoClientOptions`	`mongoOptions`
`protected boolean`	`stateless`

Constructor Summary

Constructors
Constructor and description
`MongoDatastore (MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)` Constructs a MongoDatastore using the given MappingContext and connection details map.
`MongoDatastore (MongoMappingContext mappingContext, org.springframework.core.env.PropertyResolver configuration, org.springframework.context.ConfigurableApplicationContext ctx)` Constructs a MongoDatastore using the given MappingContext and connection details map.
`MongoDatastore (MongoMappingContext mappingContext, org.springframework.context.ConfigurableApplicationContext ctx)` Constructs a MongoDatastore using the given MappingContext and connection details map.
`MongoDatastore ()` Constructs a MongoDatastore using the default database name of "test" and defaults for the host and port.
`MongoDatastore (MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, com.mongodb.MongoClientOptions mongoOptions, org.springframework.context.ConfigurableApplicationContext ctx)` Constructs a MongoDatastore using the given MappingContext and connection details map.
`MongoDatastore (MongoMappingContext mappingContext)`
`MongoDatastore (MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, org.springframework.context.ConfigurableApplicationContext ctx)` Constructor for creating a MongoDatastore using an existing Mongo instance
`MongoDatastore (MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)` Constructor for creating a MongoDatastore using an existing Mongo instance.
`MongoDatastore (MongoMappingContext mappingContext, com.mongodb.Mongo mongo, org.springframework.context.ConfigurableApplicationContext ctx)` Constructor for creating a MongoDatastore using an existing Mongo instance
`MongoDatastore (MongoMappingContext mappingContext, com.mongodb.Mongo mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)` Constructor for creating a MongoDatastore using an existing Mongo instance.

Methods Summary

Methods
Type	Name and description
`void`	`afterPropertiesSet()`
`protected Session`	`createSession(org.springframework.core.env.PropertyResolver connDetails)`
`protected Session`	`createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)`
`void`	`destroy()`
`org.bson.codecs.configuration.CodecRegistry`	`getCodecRegistry()`
`java.lang.String`	`getCollectionName(PersistentEntity entity)`
`java.lang.String`	`getDatabaseName(PersistentEntity entity)`
`java.lang.String`	`getDefaultDatabase()`
`DocumentMappingContext`	`getMappingContext()`
`com.mongodb.Mongo`	`getMongo()` @deprecated Use getMongoClient() instead
`com.mongodb.MongoClient`	`getMongoClient()`
`PersistentEntityCodec`	`getPersistentEntityCodec(PersistentEntity entity)`
`PersistentEntityCodec`	`getPersistentEntityCodec(java.lang.Class entityClass)`
`protected void`	`initializeIndices(PersistentEntity entity)` Indexes any properties that are mapped with index:true
`boolean`	`isSchemaless()`
`void`	`persistentEntityAdded(PersistentEntity entity)`
`void`	`setCodecProviders(java.util.List<org.bson.codecs.configuration.CodecProvider> codecProviders)`
`void`	`setCodecRegistries(java.util.List<org.bson.codecs.configuration.CodecRegistry> codecRegistries)`
`void`	`setCodecs(java.util.List<org.bson.codecs.Codec<?>> codecs)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractDatastore`	`getCurrentSession, getMappingContext, setApplicationContext, connectStateless, hasCurrentSession, retrieveSession, retrieveSession, getApplicationContext, getApplicationEventPublisher, isSchemaless, connect, connect, destroy, wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), 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()`

- Field Detail
  - public static final java.lang.String CODEC_ENGINE
  - public static final java.lang.String INDEX_ATTRIBUTES
  - public static final java.lang.String SETTING_CONNECTION_STRING
  - public static final java.lang.String SETTING_DATABASE_NAME
  - public static final java.lang.String SETTING_DEFAULT_MAPPING
  - public static final java.lang.String SETTING_ENGINE
  - public static final java.lang.String SETTING_FAIL_ON_ERROR
  - public static final java.lang.String SETTING_HOST
  - public static final java.lang.String SETTING_OPTIONS
  - public static final java.lang.String SETTING_PASSWORD
  - public static final java.lang.String SETTING_PORT
  - public static final java.lang.String SETTING_REPLICA_PAIR
  - public static final java.lang.String SETTING_REPLICA_SET
  - public static final java.lang.String SETTING_STATELESS
  - public static final java.lang.String SETTING_URL
  - public static final java.lang.String SETTING_USERNAME
  - protected boolean codecEngine
  - protected org.bson.codecs.configuration.CodecRegistry codecRegistry
  - protected final java.lang.String defaultDatabase
  - protected com.mongodb.MongoClient mongo
  - protected java.util.Map<PersistentEntity, java.lang.String> mongoCollections
  - protected java.util.Map<PersistentEntity, java.lang.String> mongoDatabases
  - protected com.mongodb.MongoClientOptions mongoOptions
  - protected boolean stateless
- Constructor Detail
  - public MongoDatastore(MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructs a MongoDatastore using the given MappingContext and connection details map.
    Parameters:
    mappingContext - The MongoMappingContext
    connectionDetails - The connection details containing the SETTING_HOST and SETTING_PORT settings
  - public MongoDatastore(MongoMappingContext mappingContext, org.springframework.core.env.PropertyResolver configuration, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructs a MongoDatastore using the given MappingContext and connection details map.
    Parameters:
    mappingContext - The MongoMappingContext
    configuration - The connection details containing the SETTING_HOST and SETTING_PORT settings
  - public MongoDatastore(MongoMappingContext mappingContext, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructs a MongoDatastore using the given MappingContext and connection details map.
    Parameters:
    mappingContext - The MongoMappingContext
  - public MongoDatastore()
    
    Constructs a MongoDatastore using the default database name of "test" and defaults for the host and port. Typically used during testing.
  - public MongoDatastore(MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, com.mongodb.MongoClientOptions mongoOptions, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructs a MongoDatastore using the given MappingContext and connection details map.
    Parameters:
    mappingContext - The MongoMappingContext
    connectionDetails - The connection details containing the SETTING_HOST and SETTING_PORT settings
  - public MongoDatastore(MongoMappingContext mappingContext)
  - public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructor for creating a MongoDatastore using an existing Mongo instance
    Parameters:
    mappingContext - The MappingContext
    mongo - The existing Mongo instance
  - public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructor for creating a MongoDatastore using an existing Mongo instance. In this case the connection details are only used to supply a USERNAME and PASSWORD
    Parameters:
    mappingContext - The MappingContext
    mongo - The existing Mongo instance
  - @java.lang.Deprecated public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.Mongo mongo, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructor for creating a MongoDatastore using an existing Mongo instance
    deprecated:
    The com.mongodb.Mongo class is deprecated
    
    Parameters:
    mappingContext - The MappingContext
    mongo - The existing Mongo instance
  - @java.lang.Deprecated public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.Mongo mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)
    
    Constructor for creating a MongoDatastore using an existing Mongo instance. In this case the connection details are only used to supply a USERNAME and PASSWORD
    deprecated:
    The com.mongodb.Mongo class is deprecated
    
    Parameters:
    mappingContext - The MappingContext
    mongo - The existing Mongo instance
- Method Detail
  - public void afterPropertiesSet()
  - @java.lang.Override protected Session createSession(org.springframework.core.env.PropertyResolver connDetails)
  - @java.lang.Override protected Session createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)
  - public void destroy()
  - public org.bson.codecs.configuration.CodecRegistry getCodecRegistry()
  - public java.lang.String getCollectionName(PersistentEntity entity)
  - public java.lang.String getDatabaseName(PersistentEntity entity)
  - public java.lang.String getDefaultDatabase()
  - @java.lang.Override public DocumentMappingContext getMappingContext()
  - @java.lang.Deprecated public com.mongodb.Mongo getMongo()
    
    deprecated:
    Use getMongoClient() instead
  - public com.mongodb.MongoClient getMongoClient()
  - public PersistentEntityCodec getPersistentEntityCodec(PersistentEntity entity)
  - public PersistentEntityCodec getPersistentEntityCodec(java.lang.Class entityClass)
  - protected void initializeIndices(PersistentEntity entity)
    
    Indexes any properties that are mapped with index:true
    Parameters:
    entity - The entity
  - @java.lang.Override public boolean isSchemaless()
  - public void persistentEntityAdded(PersistentEntity entity)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecProviders(java.util.List<org.bson.codecs.configuration.CodecProvider> codecProviders)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecRegistries(java.util.List<org.bson.codecs.configuration.CodecRegistry> codecRegistries)
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecs(java.util.List<org.bson.codecs.Codec<?>> codecs)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class MongoDatastore

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final java.lang.String CODEC_ENGINE

public static final java.lang.String INDEX_ATTRIBUTES

public static final java.lang.String SETTING_CONNECTION_STRING

public static final java.lang.String SETTING_DATABASE_NAME

public static final java.lang.String SETTING_DEFAULT_MAPPING

public static final java.lang.String SETTING_ENGINE

public static final java.lang.String SETTING_FAIL_ON_ERROR

public static final java.lang.String SETTING_HOST

public static final java.lang.String SETTING_OPTIONS

public static final java.lang.String SETTING_PASSWORD

public static final java.lang.String SETTING_PORT

public static final java.lang.String SETTING_REPLICA_PAIR

public static final java.lang.String SETTING_REPLICA_SET

public static final java.lang.String SETTING_STATELESS

public static final java.lang.String SETTING_URL

public static final java.lang.String SETTING_USERNAME

protected boolean codecEngine

protected org.bson.codecs.configuration.CodecRegistry codecRegistry

protected final java.lang.String defaultDatabase

protected com.mongodb.MongoClient mongo

protected java.util.Map<PersistentEntity, java.lang.String> mongoCollections

protected java.util.Map<PersistentEntity, java.lang.String> mongoDatabases

protected com.mongodb.MongoClientOptions mongoOptions

protected boolean stateless

Constructor Detail

public MongoDatastore(MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)

public MongoDatastore(MongoMappingContext mappingContext, org.springframework.core.env.PropertyResolver configuration, org.springframework.context.ConfigurableApplicationContext ctx)

public MongoDatastore(MongoMappingContext mappingContext, org.springframework.context.ConfigurableApplicationContext ctx)

public MongoDatastore()

public MongoDatastore(MongoMappingContext mappingContext, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, com.mongodb.MongoClientOptions mongoOptions, org.springframework.context.ConfigurableApplicationContext ctx)

public MongoDatastore(MongoMappingContext mappingContext)

public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, org.springframework.context.ConfigurableApplicationContext ctx)

public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.MongoClient mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)

@java.lang.Deprecated public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.Mongo mongo, org.springframework.context.ConfigurableApplicationContext ctx)

@java.lang.Deprecated public MongoDatastore(MongoMappingContext mappingContext, com.mongodb.Mongo mongo, java.util.Map<java.lang.String, java.lang.Object> connectionDetails, org.springframework.context.ConfigurableApplicationContext ctx)

Method Detail

public void afterPropertiesSet()

@java.lang.Override protected Session createSession(org.springframework.core.env.PropertyResolver connDetails)

@java.lang.Override protected Session createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)

public void destroy()

public org.bson.codecs.configuration.CodecRegistry getCodecRegistry()

public java.lang.String getCollectionName(PersistentEntity entity)

public java.lang.String getDatabaseName(PersistentEntity entity)

public java.lang.String getDefaultDatabase()

@java.lang.Override public DocumentMappingContext getMappingContext()

@java.lang.Deprecated public com.mongodb.Mongo getMongo()

public com.mongodb.MongoClient getMongoClient()

public PersistentEntityCodec getPersistentEntityCodec(PersistentEntity entity)

public PersistentEntityCodec getPersistentEntityCodec(java.lang.Class entityClass)

protected void initializeIndices(PersistentEntity entity)

@java.lang.Override public boolean isSchemaless()

public void persistentEntityAdded(PersistentEntity entity)

@org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecProviders(java.util.List<org.bson.codecs.configuration.CodecProvider> codecProviders)

@org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecRegistries(java.util.List<org.bson.codecs.configuration.CodecRegistry> codecRegistries)

@org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecs(java.util.List<org.bson.codecs.Codec<?>> codecs)