MongoDatastore (GORM for MongoDB

org.grails.datastore.mapping.mongo.MongoDatastore

All Implemented Interfaces and Traits:

MappingContextListener, java.io.Closeable, org.grails.datastore.mapping.core.StatelessDatastore, org.grails.datastore.mapping.core.connections.MultipleConnectionSourceCapableDatastore, org.grails.datastore.mapping.multitenancy.MultiTenantCapableDatastore, org.grails.datastore.mapping.transactions.TransactionCapableDatastore
```
public class MongoDatastore
extends org.grails.datastore.mapping.core.AbstractDatastore
implements MappingContextListener, java.io.Closeable, org.grails.datastore.mapping.core.StatelessDatastore, org.grails.datastore.mapping.core.connections.MultipleConnectionSourceCapableDatastore, org.grails.datastore.mapping.multitenancy.MultiTenantCapableDatastore, org.grails.datastore.mapping.transactions.TransactionCapableDatastore
```
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_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 org.grails.datastore.gorm.events.AutoTimestampEventListener`	`autoTimestampEventListener`
`protected boolean`	`codecEngine`
`protected org.bson.codecs.configuration.CodecRegistry`	`codecRegistry`
`protected org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings>`	`connectionSources`
`protected java.util.Map<java.lang.String, MongoDatastore>`	`datastoresByConnectionSource`
`protected java.lang.String`	`defaultDatabase`
`protected jakarta.persistence.FlushModeType`	`defaultFlushMode`
`protected org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher`	`eventPublisher`
`protected org.grails.datastore.gorm.GormEnhancer`	`gormEnhancer`
`protected com.mongodb.client.MongoClient`	`mongo`
`protected java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String>`	`mongoCollections`
`protected java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String>`	`mongoDatabases`
`protected org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode`	`multiTenancyMode`
`protected boolean`	`stateless`
`protected org.grails.datastore.mapping.multitenancy.TenantResolver`	`tenantResolver`
`protected org.springframework.transaction.PlatformTransactionManager`	`transactionManager`

Constructor Summary

Constructors
Constructor and description
`MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)` Configures a new MongoDatastore for the given arguments
`MongoDatastore(org.springframework.core.env.PropertyResolver configuration, MongoConnectionSourceFactory connectionSourceFactory, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)` Configures a new MongoDatastore for the given arguments
`MongoDatastore(org.springframework.core.env.PropertyResolver configuration, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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()`
	`protected static org.grails.datastore.mapping.core.connections.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(org.grails.datastore.mapping.core.connections.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 org.hibernate.Session`	`createSession(org.springframework.core.env.PropertyResolver connDetails)`
	`protected org.hibernate.Session`	`createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)`
	`public org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher`	`getApplicationEventPublisher()` Returns: The org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher instance used by this datastore
	`public org.grails.datastore.gorm.events.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(org.grails.datastore.mapping.model.PersistentEntity entity)` Obtain the raw com.mongodb.client.MongoCollection for the given entity
	`public java.lang.String`	`getCollectionName(org.grails.datastore.mapping.model.PersistentEntity entity)` Gets the default collection name for the given entity
	`public org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings>`	`getConnectionSources()` Returns: The org.grails.datastore.mapping.core.connections.ConnectionSources for this datastore
	`public java.lang.String`	`getDatabaseName(org.grails.datastore.mapping.model.PersistentEntity entity)`
	`public MongoDatastore`	`getDatastoreForConnection(java.lang.String connectionName)`
	`public org.grails.datastore.mapping.core.Datastore`	`getDatastoreForConnection(java.lang.String connectionName)`
	`public MongoDatastore`	`getDatastoreForTenantId(java.io.Serializable tenantId)`
	`public java.lang.String`	`getDefaultDatabase()` Returns: The default database name
	`public jakarta.persistence.FlushModeType`	`getDefaultFlushMode()` Returns: The default flush mode
`<D>`	`protected org.grails.datastore.gorm.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
	`public org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode`	`getMultiTenancyMode()`
	`public PersistentEntityCodec`	`getPersistentEntityCodec(org.grails.datastore.mapping.model.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 org.grails.datastore.mapping.multitenancy.TenantResolver`	`getTenantResolver()`
	`public org.springframework.transaction.PlatformTransactionManager`	`getTransactionManager()` Returns: The transaction manager
`<D>`	`protected org.grails.datastore.gorm.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(org.grails.datastore.mapping.model.PersistentEntity entity)` Indexes any properties that are mapped with index:true
	`public boolean`	`isSchemaless()`
	`public void`	`newConnectionSource(org.grails.datastore.mapping.core.connections.ConnectionSource<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSource)`
	`public void`	`persistentEntityAdded(org.grails.datastore.mapping.model.PersistentEntity entity)`
	`public void`	`persistentEntityAdded(org.grails.datastore.mapping.model.PersistentEntity entity)`
	`protected void`	`registerAllEntitiesWithEnhancer()`
	`protected void`	`registerEntity(org.grails.datastore.mapping.model.PersistentEntity entity)`
	`protected void`	`registerEventListeners(org.grails.datastore.gorm.events.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(java.util.List<org.springframework.context.MessageSource> messageSources)` The message source used for validation messages
	`public void`	`setMessageSource(org.springframework.context.MessageSource messageSource)`
`<T1>`	`public T1`	`withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.grails.datastore.mapping.core.AbstractDatastore`	org.grails.datastore.mapping.core.AbstractDatastore#getApplicationContext(), org.grails.datastore.mapping.core.AbstractDatastore#getMappingContext(), org.grails.datastore.mapping.core.AbstractDatastore#hasCurrentSession(), org.grails.datastore.mapping.core.AbstractDatastore#withSession(groovy.lang.Closure), org.grails.datastore.mapping.core.AbstractDatastore#connectStateless(), org.grails.datastore.mapping.core.AbstractDatastore#getCurrentSession(), org.grails.datastore.mapping.core.AbstractDatastore#isSchemaless(), org.grails.datastore.mapping.core.AbstractDatastore#setApplicationContext(org.springframework.context.ApplicationContext), org.grails.datastore.mapping.core.AbstractDatastore#retrieveSession(java.lang.Class), org.grails.datastore.mapping.core.AbstractDatastore#retrieveSession(), org.grails.datastore.mapping.core.AbstractDatastore#getApplicationEventPublisher(), org.grails.datastore.mapping.core.AbstractDatastore#connect(), org.grails.datastore.mapping.core.AbstractDatastore#connect(org.springframework.core.env.PropertyResolver), org.grails.datastore.mapping.core.AbstractDatastore#destroy(), org.grails.datastore.mapping.core.AbstractDatastore#getServices(), org.grails.datastore.mapping.core.AbstractDatastore#getService(java.lang.Class), org.grails.datastore.mapping.core.AbstractDatastore#wait(long, int), org.grails.datastore.mapping.core.AbstractDatastore#wait(), org.grails.datastore.mapping.core.AbstractDatastore#wait(long), org.grails.datastore.mapping.core.AbstractDatastore#equals(java.lang.Object), org.grails.datastore.mapping.core.AbstractDatastore#toString(), org.grails.datastore.mapping.core.AbstractDatastore#hashCode(), org.grails.datastore.mapping.core.AbstractDatastore#getClass(), org.grails.datastore.mapping.core.AbstractDatastore#notify(), org.grails.datastore.mapping.core.AbstractDatastore#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_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 org.grails.datastore.gorm.events.AutoTimestampEventListener autoTimestampEventListener
  - protected final boolean codecEngine
  - protected org.bson.codecs.configuration.CodecRegistry codecRegistry
  - protected final org.grails.datastore.mapping.core.connections.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 jakarta.persistence.FlushModeType defaultFlushMode
  - protected final org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher
  - protected final org.grails.datastore.gorm.GormEnhancer gormEnhancer
  - protected final com.mongodb.client.MongoClient mongo
  - protected final java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String> mongoCollections
  - protected final java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String> mongoDatabases
  - protected final org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode multiTenancyMode
  - protected final boolean stateless
  - protected final org.grails.datastore.mapping.multitenancy.TenantResolver tenantResolver
  - protected final org.springframework.transaction.PlatformTransactionManager transactionManager
- Constructor Detail
  - public MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    connectionSources - The org.grails.datastore.mapping.core.connections.ConnectionSources to use
    eventPublisher - The Spring ApplicationContext
    mappingContext - The mapping context
  - public MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)
    
    Configures a new MongoDatastore for the given arguments
    Parameters:
    connectionSources - The org.grails.datastore.mapping.core.connections.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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
    @jakarta.annotation.PreDestroy
    public void close()
  - protected static org.grails.datastore.mapping.core.connections.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 org.grails.datastore.mapping.core.connections.ConnectionSources
  - protected static MongoMappingContext createMappingContext(org.grails.datastore.mapping.core.connections.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 org.hibernate.Session createSession(org.springframework.core.env.PropertyResolver connDetails)
  - @java.lang.Override
    protected org.hibernate.Session createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)
  - @java.lang.Override
    public org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher getApplicationEventPublisher()
    
    Returns:
    The org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher instance used by this datastore
  - public org.grails.datastore.gorm.events.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(org.grails.datastore.mapping.model.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(org.grails.datastore.mapping.model.PersistentEntity entity)
    
    Gets the default collection name for the given entity
    Parameters:
    entity - The entity
    Returns:
    The collection name
  - public org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> getConnectionSources()
    
    Returns:
    The org.grails.datastore.mapping.core.connections.ConnectionSources for this datastore
  - public java.lang.String getDatabaseName(org.grails.datastore.mapping.model.PersistentEntity entity)
  - @java.lang.Override
    public MongoDatastore getDatastoreForConnection(java.lang.String connectionName)
  - @java.lang.Override
    public org.grails.datastore.mapping.core.Datastore getDatastoreForConnection(java.lang.String connectionName)
  - @java.lang.Override
    public MongoDatastore getDatastoreForTenantId(java.io.Serializable tenantId)
  - public java.lang.String getDefaultDatabase()
    
    Returns:
    The default database name
  - public jakarta.persistence.FlushModeType getDefaultFlushMode()
    
    Returns:
    The default flush mode
  - <D> @java.lang.Override
    protected org.grails.datastore.gorm.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.Override
    public org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode getMultiTenancyMode()
  - public PersistentEntityCodec getPersistentEntityCodec(org.grails.datastore.mapping.model.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 org.grails.datastore.mapping.multitenancy.TenantResolver getTenantResolver()
  - public org.springframework.transaction.PlatformTransactionManager getTransactionManager()
    
    Returns:
    The transaction manager
  - <D> @java.lang.Override
    protected org.grails.datastore.gorm.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(org.grails.datastore.mapping.model.PersistentEntity entity)
    
    Indexes any properties that are mapped with index:true
    Parameters:
    entity - The entity
  - @java.lang.Override
    public boolean isSchemaless()
  - public void newConnectionSource(org.grails.datastore.mapping.core.connections.ConnectionSource<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSource)
  - @java.lang.Override
    public void persistentEntityAdded(org.grails.datastore.mapping.model.PersistentEntity entity)
  - public void persistentEntityAdded(org.grails.datastore.mapping.model.PersistentEntity entity)
  - protected void registerAllEntitiesWithEnhancer()
  - protected void registerEntity(org.grails.datastore.mapping.model.PersistentEntity entity)
  - protected void registerEventListeners(org.grails.datastore.gorm.events.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(java.util.List<org.springframework.context.MessageSource> messageSources)
    
    The message source used for validation messages
    Parameters:
    messageSources - The message source
  - public void setMessageSource(org.springframework.context.MessageSource messageSource)
  - <T1> @java.lang.Override
    public T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

Groovy Documentation

[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_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 org.grails.datastore.gorm.events.AutoTimestampEventListener autoTimestampEventListener

protected final boolean codecEngine

protected org.bson.codecs.configuration.CodecRegistry codecRegistry

protected final org.grails.datastore.mapping.core.connections.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 jakarta.persistence.FlushModeType defaultFlushMode

protected final org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher

protected final org.grails.datastore.gorm.GormEnhancer gormEnhancer

protected final com.mongodb.client.MongoClient mongo

protected final java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String> mongoCollections

protected final java.util.Map<org.grails.datastore.mapping.model.PersistentEntity, java.lang.String> mongoDatabases

protected final org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode multiTenancyMode

protected final boolean stateless

protected final org.grails.datastore.mapping.multitenancy.TenantResolver tenantResolver

protected final org.springframework.transaction.PlatformTransactionManager transactionManager

Constructor Detail

public MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, MongoMappingContext mappingContext, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)

public MongoDatastore(org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> connectionSources, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher, java.lang.Class classes)

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

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

public MongoDatastore(com.mongodb.client.MongoClient mongoClient, org.springframework.core.env.PropertyResolver configuration, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher)

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

public MongoDatastore(org.springframework.core.env.PropertyResolver configuration, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.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, org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher eventPublisher, java.lang.Package packagesToScan)

Method Detail

public void buildIndex()

@java.lang.Override@jakarta.annotation.PreDestroypublic void close()

protected static MongoMappingContext createMappingContext(org.grails.datastore.mapping.core.connections.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.Overrideprotected org.hibernate.Session createSession(org.springframework.core.env.PropertyResolver connDetails)

@java.lang.Overrideprotected org.hibernate.Session createStatelessSession(org.springframework.core.env.PropertyResolver connectionDetails)

@java.lang.Overridepublic org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher getApplicationEventPublisher()

public org.grails.datastore.gorm.events.AutoTimestampEventListener getAutoTimestampEventListener()

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

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

public java.lang.String getCollectionName(org.grails.datastore.mapping.model.PersistentEntity entity)

public org.grails.datastore.mapping.core.connections.ConnectionSources<com.mongodb.client.MongoClient, MongoConnectionSourceSettings> getConnectionSources()

public java.lang.String getDatabaseName(org.grails.datastore.mapping.model.PersistentEntity entity)

@java.lang.Overridepublic MongoDatastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Overridepublic org.grails.datastore.mapping.core.Datastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Overridepublic MongoDatastore getDatastoreForTenantId(java.io.Serializable tenantId)

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

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

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

@java.lang.Override
public org.grails.datastore.gorm.events.ConfigurableApplicationEventPublisher getApplicationEventPublisher()

@java.lang.Override
public MongoDatastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Override
public org.grails.datastore.mapping.core.Datastore getDatastoreForConnection(java.lang.String connectionName)

@java.lang.Override
public MongoDatastore getDatastoreForTenantId(java.io.Serializable tenantId)

<D> @java.lang.Override
protected org.grails.datastore.gorm.GormInstanceApi<D> getInstanceApi(java.lang.Class<D> cls, java.lang.String qualifier)

@java.lang.Override
public MongoMappingContext getMappingContext()

@java.lang.Override
public org.grails.datastore.mapping.multitenancy.MultiTenancySettings$MultiTenancyMode getMultiTenancyMode()

<D> @java.lang.Override
protected MongoStaticApi<D> getStaticApi(java.lang.Class<D> cls, java.lang.String qualifier)

@java.lang.Override
public org.grails.datastore.mapping.multitenancy.TenantResolver getTenantResolver()

<D> @java.lang.Override
protected org.grails.datastore.gorm.GormValidationApi<D> getValidationApi(java.lang.Class<D> cls, java.lang.String qualifier)

@java.lang.Override
protected MongoGormEnhancer initialize(MongoConnectionSourceSettings settings)

@java.lang.Override
public boolean isSchemaless()

@java.lang.Override
public void persistentEntityAdded(org.grails.datastore.mapping.model.PersistentEntity entity)

@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)

@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)

@org.springframework.beans.factory.annotation.Autowired(required = false)
public void setMessageSource(java.util.List<org.springframework.context.MessageSource> messageSources)

<T1> @java.lang.Override
public T1 withNewSession(java.io.Serializable tenantId, groovy.lang.Closure<T1> callable)