Package io.micronaut.starter.feature.database

Class PostgreSQL

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.database.DatabaseDriverFeature

io.micronaut.starter.feature.database.PostgreSQL

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OneOfFeature, DatabaseDriverFeatureDependencies, TestResourcesAdditionalModulesProvider

@Requires(property="micronaut.starter.feature.postgres.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class PostgreSQL
extends DatabaseDriverFeature

Feature representing PostgreSQL database driver support. provides default configuration values for connecting to a PostgreSQL database. Supports both synchronous and reactive database access.

Field Summary

Fields

Modifier and Type	Field	Description
static final Dependency.Builder	DEPENDENCY_POSTGRESQL
static final String	NAME
static final String	VERTX_PG_CLIENT

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
PostgreSQL(JdbcFeature jdbcFeature, TestContainers testContainers, TestResources testResources)

Method Summary

Modifier and Type	Method	Description
boolean	embedded()
String	getDataDialect()
@NonNull Optional<DbType>	getDbType()	Returns the database type if applicable.
String	getDefaultPassword()
String	getDefaultUser()
@NonNull String	getDescription()
String	getDriverClass()
@NonNull Optional<Dependency.Builder>	getHibernateReactiveJavaClientDependency()
@NonNull Optional<Dependency.Builder>	getJavaClientDependency()
String	getJdbcUrl()
@NonNull String	getName()	The name of the feature.
@NonNull Optional<Dependency.Builder>	getR2DbcDependency()
String	getR2dbcUrl()
String	getTitle()

Methods inherited from class io.micronaut.starter.feature.database.DatabaseDriverFeature

apply, dependenciesForHibernateReactive, getAdditionalConfig, getCategory, getFeatureClass, getTestResourcesAdditionalModules, getTestResourcesDependencies, parseDependencies, processSelectedFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.naming.Described

getDescription

Methods inherited from interface io.micronaut.projectgen.core.feature.Feature

getFrameworkDocumentation, getOrder, getThirdPartyDocumentation, isCommunity, isPreview, isVisible, supports

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

VERTX_PG_CLIENT

public static final String VERTX_PG_CLIENT

See Also:

• Constant Field Values

DEPENDENCY_POSTGRESQL

public static final Dependency.Builder DEPENDENCY_POSTGRESQL

Constructor Details

PostgreSQL

public PostgreSQL(JdbcFeature jdbcFeature,
 TestContainers testContainers,
 TestResources testResources)

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Returns:

the name of the feature

getTitle

public String getTitle()

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

getJdbcUrl

public String getJdbcUrl()

Specified by:

getJdbcUrl in class DatabaseDriverFeature

getR2dbcUrl

public String getR2dbcUrl()

Specified by:

getR2dbcUrl in class DatabaseDriverFeature

getDriverClass

public String getDriverClass()

Specified by:

getDriverClass in class DatabaseDriverFeature

getDbType

@NonNull
public @NonNull Optional<DbType> getDbType()

Description copied from class: DatabaseDriverFeature

Returns the database type if applicable.

Subclasses may override this to provide a specific DbType. Ensure consistency with other database-related features.

Overrides:

getDbType in class DatabaseDriverFeature

Returns:

An Optional containing the DbType, or empty if not applicable.

getDefaultUser

public String getDefaultUser()

Specified by:

getDefaultUser in class DatabaseDriverFeature

getDefaultPassword

public String getDefaultPassword()

Specified by:

getDefaultPassword in class DatabaseDriverFeature

getDataDialect

public String getDataDialect()

Specified by:

getDataDialect in class DatabaseDriverFeature

embedded

public boolean embedded()

Specified by:

embedded in class DatabaseDriverFeature

getR2DbcDependency

@NonNull
public @NonNull Optional<Dependency.Builder> getR2DbcDependency()

getHibernateReactiveJavaClientDependency

@NonNull
public @NonNull Optional<Dependency.Builder> getHibernateReactiveJavaClientDependency()

getJavaClientDependency

@NonNull
public @NonNull Optional<Dependency.Builder> getJavaClientDependency()