MongoDatastore (GORM for MongoDB

org.grails.datastore.mapping.mongo.MongoDatastore

All Implemented Interfaces and Traits:

MappingContextListener, java.io.Closeable, MultiTenantCapableDatastore, MultipleConnectionSourceCapableDatastore, StatelessDatastore, TransactionCapableDatastore
```
public class MongoDatastore
extends AbstractDatastore
implements MappingContextListener, java.io.Closeable, MultiTenantCapableDatastore, MultipleConnectionSourceCapableDatastore, StatelessDatastore, TransactionCapableDatastore
```
A Datastore implementation for the Mongo document store.
Authors:
Graeme Rocher
Since:
1.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`MongoDatastore.PersistentEntityCodeRegistry`

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_HOST`
`static java.lang.String`	`SETTING_OPTIONS`
`static java.lang.String`	`SETTING_PASSWORD`
`static java.lang.String`	`SETTING_PORT`
`static java.lang.String`	`SETTING_STATELESS`
`static java.lang.String`	`SETTING_URL`
`static java.lang.String`	`SETTING_USERNAME`
`protected AutoTimestampEventListener`	`autoTimestampEventListener`
`protected boolean`	`codecEngine`
`protected org.bson.codecs.configuration.CodecRegistry`	`codecRegistry`
`protected ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings>`	`connectionSources`
`protected java.util.Map<java.lang.String, MongoDatastore>`	`datastoresByConnectionSource`
`protected java.lang.String`	`defaultDatabase`
`protected javax.persistence.FlushModeType`	`defaultFlushMode`
`protected ConfigurableApplicationEventPublisher`	`eventPublisher`
`protected GormEnhancer`	`gormEnhancer`
`protected com.mongodb.client.MongoClient`	`mongo`
`protected java.util.Map<PersistentEntity, java.lang.String>`	`mongoCollections`
`protected java.util.Map<PersistentEntity, java.lang.String>`	`mongoDatabases`
`protected MultiTenancyMode`	`multiTenancyMode`
`protected boolean`	`stateless`
`protected TenantResolver`	`tenantResolver`
`protected org.springframework.transaction.PlatformTransactionManager`	`transactionManager`

Inherited fields
Fields inherited from class	Fields
`class AbstractDatastore`	`LOG, applicationContext, cacheAdapterRepository, connectionDetails, mappingContext, serviceRegistry`

Constructor Summary

Constructors
Constructor and description
`MongoDatastore (ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packages)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Package packages)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.client.MongoClient mongoClient, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, MongoConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (java.util.Map<java.lang.String, java.lang.Object> configuration)` Creates a MongoDatastore with the given configuration
`MongoDatastore (java.util.Map<java.lang.String, java.lang.Object> configuration, MongoMappingContext mappingContext)`
`MongoDatastore (MongoMappingContext mappingContext)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore (java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages
`MongoDatastore (java.lang.Package packageToScan)` Construct a Mongo datastore scanning the given package
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages
`MongoDatastore (java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages
`MongoDatastore (org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)` Construct a Mongo datastore scanning the given packages

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`buildIndex()` Builds the MongoDB index for this datastore
	`public void`	`close()`
	`private static void`	`configureValidationRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext)`
	`private static void`	`configureValidatorRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext, org.springframework.context.MessageSource messageSource)`
	`private MongoDatastore`	`createChildDatastore(MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher, MongoDatastore parent, SingletonConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> singletonConnectionSources)`
	`protected static ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings>`	`createDefaultConnectionSources(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)` Creates the connection sources for an existing com.mongodb.client.MongoClient
	`protected static MongoMappingContext`	`createMappingContext(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, java.lang.Class classes)`
	`protected static MongoMappingContext`	`createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)`
	`protected static com.mongodb.client.MongoClient`	`createMongoClient(org.springframework.core.env.PropertyResolver configuration, com.mongodb.MongoClientSettings$Builder mongoOptions, MongoMappingContext mappingContext)`
	`protected Session`	`createSession(org.springframework.core.env.PropertyResolver connDetails)`
	`protected Session`	`createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)`
	`public ConfigurableApplicationEventPublisher`	`getApplicationEventPublisher()` Returns: The ConfigurableApplicationEventPublisher instance used by this datastore
	`public AutoTimestampEventListener`	`getAutoTimestampEventListener()`
	`public org.bson.codecs.configuration.CodecRegistry`	`getCodecRegistry()` Returns: The org.bson.codecs.configuration.CodecRegistry
	`public com.mongodb.client.MongoCollection<org.bson.Document>`	`getCollection(PersistentEntity entity)` Obtain the raw com.mongodb.client.MongoCollection for the given entity
	`public java.lang.String`	`getCollectionName(PersistentEntity entity)` Gets the default collection name for the given entity
	`public ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings>`	`getConnectionSources()` Returns: The ConnectionSources for this datastore
	`public java.lang.String`	`getDatabaseName(PersistentEntity entity)`
	`public MongoDatastore`	`getDatastoreForConnection(java.lang.String connectionName)`
	`public Datastore`	`getDatastoreForConnection(java.lang.String connectionName)`
`<D>`	`private MongoDatastore`	`getDatastoreForQualifier(java.lang.Class<D> cls, java.lang.String qualifier)`
	`public MongoDatastore`	`getDatastoreForTenantId(java.io.Serializable tenantId)`
	`public java.lang.String`	`getDefaultDatabase()` Returns: The default database name
	`public javax.persistence.FlushModeType`	`getDefaultFlushMode()` Returns: The default flush mode
`<D>`	`protected GormInstanceApi<D>`	`getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)`
	`public MongoMappingContext`	`getMappingContext()` Returns: The mapping context
	`public com.mongodb.client.MongoClient`	`getMongoClient()` Returns: The com.mongodb.client.MongoClient instance
	`java.lang.String`	`getMongoFieldNameForProperty(PersistentProperty<MongoAttribute> property)`
	`public MultiTenancyMode`	`getMultiTenancyMode()`
	`public PersistentEntityCodec`	`getPersistentEntityCodec(PersistentEntity entity)` Obtains a PersistentEntityCodec for the given entity
	`public PersistentEntityCodec`	`getPersistentEntityCodec(java.lang.Class entityClass)` Obtains a PersistentEntityCodec for the given entity
`<D>`	`protected MongoStaticApi<D>`	`getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)`
	`public TenantResolver`	`getTenantResolver()`
	`public org.springframework.transaction.PlatformTransactionManager`	`getTransactionManager()` Returns: The transaction manager
`<D>`	`protected GormValidationApi<D>`	`getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)`
	`protected MongoGormEnhancer`	`initialize(MongoConnectionSourceSettings settings)`
	`protected MongoGormEnhancer`	`initialize(MongoConnectionSourceSettings settings)` Runs the initialization sequence
	`protected void`	`initializeIndices(PersistentEntity entity)` Indexes any properties that are mapped with index:true
	`public boolean`	`isSchemaless()`
	`public void`	`newConnectionSource(ConnectionSource<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSource)`
	`public void`	`persistentEntityAdded(PersistentEntity entity)`
	`public void`	`persistentEntityAdded(PersistentEntity entity)`
	`protected void`	`registerAllEntitiesWithEnhancer()`
	`protected void`	`registerEntity(PersistentEntity entity)`
	`protected void`	`registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)`
	`public java.io.Serializable`	`resolveTenantIdentifier()`
	`public java.lang.Iterable<java.io.Serializable>`	`resolveTenantIds()`
	`public void`	`setCodecProviders(java.util.List<org.bson.codecs.configuration.CodecProvider> codecProviders)` Sets any additional codec providers
	`public void`	`setCodecRegistries(java.util.List<org.bson.codecs.configuration.CodecRegistry> codecRegistries)` Sets any additional codec registries
	`public void`	`setCodecs(java.util.List<org.bson.codecs.Codec<?>> codecs)` Sets any additional codecs
	`public void`	`setMessageSource(org.springframework.context.MessageSource messageSource)` The message source used for validation messages
`<T1>`	`public T1`	`withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractDatastore`	`connect, connect, connectStateless, createSession, createStatelessSession, destroy, doInSession, getApplicationContext, getApplicationEventPublisher, getCurrentSession, getMappingContext, getService, getServices, hasCurrentSession, initializeConverters, isIndexed, isSchemaless, mapToPropertyResolver, publishSessionCreationEvent, retrieveSession, retrieveSession, setApplicationContext, withSession`

- 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_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_STATELESS
  - public static final java.lang.String SETTING_URL
  - public static final java.lang.String SETTING_USERNAME
  - protected final AutoTimestampEventListener autoTimestampEventListener
  - protected final boolean codecEngine
  - protected org.bson.codecs.configuration.CodecRegistry codecRegistry
  - protected final ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources
  - protected final java.util.Map<java.lang.String, MongoDatastore> datastoresByConnectionSource
  - protected final java.lang.String defaultDatabase
  - protected final javax.persistence.FlushModeType defaultFlushMode
  - protected final ConfigurableApplicationEventPublisher eventPublisher
  - protected final GormEnhancer gormEnhancer
  - protected final com.mongodb.client.MongoClient mongo
  - protected final java.util.Map<PersistentEntity, java.lang.String> mongoCollections
  - protected final java.util.Map<PersistentEntity, java.lang.String> mongoDatabases
  - protected final MultiTenancyMode multiTenancyMode
  - protected final boolean stateless
  - protected final TenantResolver tenantResolver
  - protected final org.springframework.transaction.PlatformTransactionManager transactionManager
- Constructor Detail
  - public MongoDatastore(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    connectionSources - The ConnectionSources to use
    eventPublisher - The Spring ApplicationContext
    mappingContext - The mapping context
  - public MongoDatastore(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    connectionSources - The ConnectionSources to use
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    eventPublisher - The Spring ApplicationContext
    mappingContext - The mapping context
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packages)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    eventPublisher - The Spring ApplicationContext
    packages - The packages to scan
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    classes - The persistent classes
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Package packages)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    packages - The packages to scan
  - public MongoDatastore(com.mongodb.client.MongoClient mongoClient, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient instance
    classes - The persistent classes
  - public MongoDatastore(com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    clientOptions - The com.mongodb.MongoClientSettings instance
    configuration - The configuration
    eventPublisher - The Spring ApplicationContext
    mappingContext - The mapping context
  - public MongoDatastore(com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    clientOptions - The com.mongodb.MongoClientSettings instance
    configuration - The configuration
    mappingContext - The mapping context
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    mappingContext - The mapping context
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    connectionSourceFactory - The connection source factory to use
    classes - The persistent classes
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    eventPublisher - The Spring ApplicationContext
    classes - The persistent classes
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    mappingContext - The mapping context
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration for the datastore
    classes - The persistent classes
  - public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration
    eventPublisher - The event publisher
    classes - The persistent classes
  - public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    configuration - The configuration
    classes - The persistent classes
  - public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration)
    
    Creates a MongoDatastore with the given configuration
    Parameters:
    configuration - The configuration
  - public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, MongoMappingContext mappingContext)
  - public MongoDatastore(MongoMappingContext mappingContext)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    mappingContext - The MongoMappingContext
  - public MongoDatastore(java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    classes - The persistent classes
  - public MongoDatastore(java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    packagesToScan - The packages to scan
  - public MongoDatastore(java.lang.Package packageToScan)
    
    Construct a Mongo datastore scanning the given package
    Parameters:
    packageToScan - The packages to scan
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
  - public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    configuration - The configuration
    packagesToScan - The packages to scan
  - public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)
    
    Construct a Mongo datastore scanning the given packages
    Parameters:
    configuration - The configuration
    eventPublisher - The event publisher
    packagesToScan - The packages to scan
- Method Detail
  - public void buildIndex()
    
    Builds the MongoDB index for this datastore
  - @java.lang.Override @javax.annotation.PreDestroy public void close()
  - private static void configureValidationRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext)
  - private static void configureValidatorRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext, org.springframework.context.MessageSource messageSource)
  - private MongoDatastore createChildDatastore(MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher, MongoDatastore parent, SingletonConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> singletonConnectionSources)
  - protected static ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> createDefaultConnectionSources(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)
    
    Creates the connection sources for an existing com.mongodb.client.MongoClient
    Parameters:
    mongoClient - The com.mongodb.client.MongoClient
    configuration - The configuration
    mappingContext - The MongoMappingContext
    Returns:
    The ConnectionSources
  - protected static MongoMappingContext createMappingContext(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, java.lang.Class classes)
  - protected static MongoMappingContext createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)
  - protected static com.mongodb.client.MongoClient createMongoClient(org.springframework.core.env.PropertyResolver configuration, com.mongodb.MongoClientSettings$Builder mongoOptions, MongoMappingContext mappingContext)
  - @java.lang.Override protected Session createSession(org.springframework.core.env.PropertyResolver connDetails)
  - @java.lang.Override protected Session createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)
  - @java.lang.Override public ConfigurableApplicationEventPublisher getApplicationEventPublisher()
    
    Returns:
    The ConfigurableApplicationEventPublisher instance used by this datastore
  - public AutoTimestampEventListener getAutoTimestampEventListener()
  - public org.bson.codecs.configuration.CodecRegistry getCodecRegistry()
    
    Returns:
    The org.bson.codecs.configuration.CodecRegistry
  - public com.mongodb.client.MongoCollection<org.bson.Document> getCollection(PersistentEntity entity)
    
    Obtain the raw com.mongodb.client.MongoCollection for the given entity
    Parameters:
    entity - The entity
    Returns:
    The Mongo collection
  - public java.lang.String getCollectionName(PersistentEntity entity)
    
    Gets the default collection name for the given entity
    Parameters:
    entity - The entity
    Returns:
    The collection name
  - public ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> getConnectionSources()
    
    Returns:
    The ConnectionSources for this datastore
  - public java.lang.String getDatabaseName(PersistentEntity entity)
  - @java.lang.Override public MongoDatastore getDatastoreForConnection(java.lang.String connectionName)
  - @java.lang.Override public Datastore getDatastoreForConnection(java.lang.String connectionName)
  - <D> private MongoDatastore getDatastoreForQualifier(java.lang.Class<D> cls, java.lang.String qualifier)
  - @java.lang.Override public MongoDatastore getDatastoreForTenantId(java.io.Serializable tenantId)
  - public java.lang.String getDefaultDatabase()
    
    Returns:
    The default database name
  - public javax.persistence.FlushModeType getDefaultFlushMode()
    
    Returns:
    The default flush mode
  - <D> @java.lang.Override protected GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - @java.lang.Override public MongoMappingContext getMappingContext()
    
    Returns:
    The mapping context
  - public com.mongodb.client.MongoClient getMongoClient()
    
    Returns:
    The com.mongodb.client.MongoClient instance
  - java.lang.String getMongoFieldNameForProperty(PersistentProperty<MongoAttribute> property)
  - @java.lang.Override public MultiTenancyMode getMultiTenancyMode()
  - public PersistentEntityCodec getPersistentEntityCodec(PersistentEntity entity)
    
    Obtains a PersistentEntityCodec for the given entity
    Parameters:
    entity - The entity
    Returns:
    The PersistentEntityCodec
  - public PersistentEntityCodec getPersistentEntityCodec(java.lang.Class entityClass)
    
    Obtains a PersistentEntityCodec for the given entity
    Parameters:
    entityClass - The entity class
    Returns:
    The PersistentEntityCodec
  - <D> @java.lang.Override protected MongoStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - @java.lang.Override public TenantResolver getTenantResolver()
  - public org.springframework.transaction.PlatformTransactionManager getTransactionManager()
    
    Returns:
    The transaction manager
  - <D> @java.lang.Override protected GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)
  - @java.lang.Override protected MongoGormEnhancer initialize(MongoConnectionSourceSettings settings)
  - protected MongoGormEnhancer initialize(MongoConnectionSourceSettings settings)
    
    Runs the initialization sequence
    Parameters:
    settings
  - 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 newConnectionSource(ConnectionSource<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSource)
  - @java.lang.Override public void persistentEntityAdded(PersistentEntity entity)
  - public void persistentEntityAdded(PersistentEntity entity)
  - protected void registerAllEntitiesWithEnhancer()
  - protected void registerEntity(PersistentEntity entity)
  - protected void registerEventListeners(ConfigurableApplicationEventPublisher eventPublisher)
  - @java.lang.Override public java.io.Serializable resolveTenantIdentifier()
  - @java.lang.Override public java.lang.Iterable<java.io.Serializable> resolveTenantIds()
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecProviders(java.util.List<org.bson.codecs.configuration.CodecProvider> codecProviders)
    
    Sets any additional codec providers
    Parameters:
    codecProviders - The org.bson.codecs.configuration.CodecProvider instances
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecRegistries(java.util.List<org.bson.codecs.configuration.CodecRegistry> codecRegistries)
    
    Sets any additional codec registries
    Parameters:
    codecRegistries - The org.bson.codecs.configuration.CodecRegistry instances
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setCodecs(java.util.List<org.bson.codecs.Codec<?>> codecs)
    
    Sets any additional codecs
    Parameters:
    codecs - The org.bson.codecs.Codec instances
  - @org.springframework.beans.factory.annotation.Autowired(required = false) public void setMessageSource(org.springframework.context.MessageSource messageSource)
    
    The message source used for validation messages
    Parameters:
    messageSource - The message source
  - <T1> @java.lang.Override public T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)

| Detail:
Field
Constructor
Method

Groovy Documentation

[Java] Class MongoDatastore

Nested Class Summary

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_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_STATELESS

public static final java.lang.String SETTING_URL

public static final java.lang.String SETTING_USERNAME

protected final AutoTimestampEventListener autoTimestampEventListener

protected final boolean codecEngine

protected org.bson.codecs.configuration.CodecRegistry codecRegistry

protected final ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources

protected final java.util.Map<java.lang.String, MongoDatastore> datastoresByConnectionSource

protected final java.lang.String defaultDatabase

protected final javax.persistence.FlushModeType defaultFlushMode

protected final ConfigurableApplicationEventPublisher eventPublisher

protected final GormEnhancer gormEnhancer

protected final com.mongodb.client.MongoClient mongo

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

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

protected final MultiTenancyMode multiTenancyMode

protected final boolean stateless

protected final TenantResolver tenantResolver

protected final org.springframework.transaction.PlatformTransactionManager transactionManager

Constructor Detail

public MongoDatastore(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public MongoDatastore(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packages)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, java.lang.Package packages)

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, java.lang.Class classes)

public MongoDatastore(com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public MongoDatastore(com.mongodb.MongoClientSettings$Builder clientOptions, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher)

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoConnectionSourceFactory connectionSourceFactory, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

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

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)

public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Class classes)

public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration)

public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, MongoMappingContext mappingContext)

public MongoDatastore(MongoMappingContext mappingContext)

public MongoDatastore(java.lang.Class classes)

public MongoDatastore(java.lang.Package packagesToScan)

public MongoDatastore(java.lang.Package packageToScan)

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, java.lang.Package packagesToScan)

public MongoDatastore(java.util.Map<java.lang.String, java.lang.Object> configuration, java.lang.Package packagesToScan)

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

Method Detail

public void buildIndex()

@java.lang.Override @javax.annotation.PreDestroy public void close()

private static void configureValidationRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext)

private static void configureValidatorRegistry(MongoConnectionSourceSettings settings, MongoMappingContext mongoMappingContext, org.springframework.context.MessageSource messageSource)

private MongoDatastore createChildDatastore(MongoMappingContext mappingContext, ConfigurableApplicationEventPublisher eventPublisher, MongoDatastore parent, SingletonConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> singletonConnectionSources)

protected static ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> createDefaultConnectionSources(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, MongoMappingContext mappingContext)

protected static MongoMappingContext createMappingContext(ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, java.lang.Class classes)

protected static MongoMappingContext createMappingContext(org.springframework.core.env.PropertyResolver configuration, java.lang.Class classes)

protected static com.mongodb.client.MongoClient createMongoClient(org.springframework.core.env.PropertyResolver configuration, com.mongodb.MongoClientSettings$Builder mongoOptions, MongoMappingContext mappingContext)

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

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

@java.lang.Override public ConfigurableApplicationEventPublisher getApplicationEventPublisher()

public AutoTimestampEventListener getAutoTimestampEventListener()

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

public com.mongodb.client.MongoCollection<org.bson.Document> getCollection(PersistentEntity entity)

public java.lang.String getCollectionName(PersistentEntity entity)