Package com.mongodb.hibernate.cfg

Interface MongoConfigurator

@Sealed
public interface MongoConfigurator

The configurator of the MongoDB Extension for Hibernate ORM.

Supported configuration properties

Method	Has default	Related configuration property name	Supported value types of the configuration property	Value, unless overridden via MongoConfigurator
applyToMongoClientSettings(Consumer)	✓	"jakarta.persistence.jdbc.url"	String ConnectionString	Is based on the ConnectionString constructed from "jakarta.persistence.jdbc.url", if the latter is configured; otherwise a MongoClientSettings instance with its defaults.
databaseName(String)	✗	"jakarta.persistence.jdbc.url"	String ConnectionString	The MongoDB database name from "jakarta.persistence.jdbc.url", if configured; otherwise a value must be configured via databaseName(String).

See Also:

• MongoConfigurationContributor

Method Summary

Modifier and Type	Method	Description
MongoConfigurator	applyToMongoClientSettings(Consumer<MongoClientSettings.Builder> configurator)	Configures MongoClientSettings.
MongoConfigurator	databaseName(String databaseName)	Sets the name of a MongoDB database to use.

Method Details

applyToMongoClientSettings

MongoConfigurator applyToMongoClientSettings(Consumer<MongoClientSettings.Builder> configurator)

Configures MongoClientSettings.

Note that if you apply a ConnectionString with the database name configured, you still must configure the database name via databaseName(String), as there is no way for that to happen automatically.

Parameters:

configurator - The Consumer of the MongoClientSettings.Builder.

Returns:

this.

databaseName

MongoConfigurator databaseName(String databaseName)

Sets the name of a MongoDB database to use.

Parameters:

databaseName - The name of a MongoDB database to use.

Returns:

this.