AbstractMongoConnectionSourceSettings (GORM for Hibernate 7

org.grails.datastore.mapping.mongo.connections.AbstractMongoConnectionSourceSettings

All Implemented Interfaces and Traits:: MongoSettings

@groovy.transform.AutoClone
@groovy.transform.builder.Builder(builderStrategy: SimpleStrategy, prefix: )
@groovy.transform.CompileStatic
abstract class AbstractMongoConnectionSourceSettings
extends ConnectionSourceSettings
implements MongoSettings

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`protected ConnectionString`	`connectionString`	The connection string

Properties Summary

Properties
Type	Name and description
`boolean`	`buildIndexes` Whether GORM creates and reconciles the indexes declared in domain class mapping blocks by itself when the datastore starts.
`boolean`	`buildIndexesAsync` Whether index builds run on a background thread instead of blocking the thread that starts them: the startup build, and any started with `MongoDatastore.buildIndex()`, whatever buildIndexes says.
`CodecRegistry`	`codecRegistry` An additional codec registry
`java.util.List<java.lang.Class<? extends Codec>>`	`codecs` Custom MongoDB codecs
`java.lang.String`	`connectionsCollection` The collection name to use to resolve connections when using MongoConnectionSources
`java.lang.String`	`databaseName` The default database name
`boolean`	`decimalType` Whether to use the decimal128 type for BigDecimal values
`java.lang.String`	`engine` The engine to use by default
`java.lang.String`	`host` The host name to use
`java.lang.String`	`password` The password to use
`java.lang.Integer`	`port` The port to use
`boolean`	`stateless` Whether to use stateless mode by default
`StringIdSettings`	`stringIds` Nested settings for domains with `String id`.
`boolean`	`transactional` Whether GORM should use real MongoDB multi-document transactions (a server-side `ClientSession`) for transactional operations.
`java.lang.String`	`username` The username to use

Inherited properties
Properties inherited from class	Properties
`class ConnectionSourceSettings`	`autoFlush, autowire, cacheAutoTimestampAnnotations, connectionSourcesClass, custom, default, defaultIdType, defaults, failOnError, failOnErrorPackages, flushMode, markDirty, multiTenancy`

Constructor Summary

Constructors
Constructor and description
`AbstractMongoConnectionSourceSettings()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getDatabase()` Returns: Obtain the database name
	`ConnectionString`	`getUrl()` Returns: Obtain the final URL whether from the connection string or the host/port setting
	`void`	`url(ConnectionString connectionString)` Parameters: `connectionString` - The connection string

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ConnectionSourceSettings`	`getDefault, setDefault`

- Field Detail
  - protected ConnectionString connectionString
    
    The connection string
- Property Detail
  - boolean buildIndexes
    
    Whether GORM creates and reconciles the indexes declared in domain class mapping blocks by itself when the datastore starts. When false the indexes on the server are left exactly as they are and GORM issues no createIndex or collMod command of its own until the application calls MongoDatastore.buildIndex(); queries are unaffected and continue to use whatever indexes already exist. Bound from grails.mongodb.buildIndexes.
    Since:
    8.0
  - boolean buildIndexesAsync
    
    Whether index builds run on a background thread instead of blocking the thread that starts them: the startup build, and any started with MongoDatastore.buildIndex(), whatever buildIndexes says. MongoDB answers a createIndex command only once the index has been built, so with the default false an application waits at startup for every declared index. Bound from grails.mongodb.buildIndexesAsync.
    Since:
    8.0
  - CodecRegistry codecRegistry
    
    An additional codec registry
  - java.util.List<java.lang.Class<? extends Codec>> codecs
    
    Custom MongoDB codecs
  - java.lang.String connectionsCollection
    
    The collection name to use to resolve connections when using MongoConnectionSources
  - java.lang.String databaseName
    
    The default database name
  - boolean decimalType
    
    Whether to use the decimal128 type for BigDecimal values
    See Also:
    org.bson.types.Decimal128
  - java.lang.String engine
    
    The engine to use by default
  - java.lang.String host
    
    The host name to use
  - java.lang.String password
    
    The password to use
  - java.lang.Integer port
    
    The port to use
  - boolean stateless
    
    Whether to use stateless mode by default
  - StringIdSettings stringIds
    
    Nested settings for domains with String id. Holds the global default defaultStoredAs switch plus any future string-id configuration.
    Exposes the property path grails.mongodb.stringIds.defaultStoredAs, aligned with the Spring-style hierarchical namespace convention.
    Since:
    7.1.1
  - boolean transactional
    
    Whether GORM should use real MongoDB multi-document transactions (a server-side ClientSession) for transactional operations. Requires a replica set or sharded cluster. When false (the default) a GORM transaction remains a client-side flush boundary, preserving the historical behavior. Bound from grails.mongodb.transactional.
    Since:
    8.0
  - java.lang.String username
    
    The username to use
- Constructor Detail
  - AbstractMongoConnectionSourceSettings()
- Method Detail
  - java.lang.String getDatabase()
    
    Returns:
    Obtain the database name
  - ConnectionString getUrl()
    
    Returns:
    Obtain the final URL whether from the connection string or the host/port setting
  - void url(ConnectionString connectionString)
    
    Parameters:
    connectionString - The connection string

Summary:
Field
Property
Constructor
Method

[Groovy] Class AbstractMongoConnectionSourceSettings

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected ConnectionString connectionString

Property Detail

boolean buildIndexes

boolean buildIndexesAsync

CodecRegistry codecRegistry

java.util.List<java.lang.Class<? extends Codec>> codecs

java.lang.String connectionsCollection

java.lang.String databaseName

boolean decimalType

java.lang.String engine

java.lang.String host

java.lang.String password

java.lang.Integer port

boolean stateless

StringIdSettings stringIds

boolean transactional

java.lang.String username

Constructor Detail

AbstractMongoConnectionSourceSettings()

Method Detail

java.lang.String getDatabase()

ConnectionString getUrl()

void url(ConnectionString connectionString)