Package io.micronaut.starter.feature.database.r2dbc

Class R2dbc

java.lang.Object

io.micronaut.starter.feature.database.r2dbc.R2dbcConfigurationUtils

io.micronaut.starter.feature.database.r2dbc.R2dbc

All Implemented Interfaces:

io.micronaut.core.naming.Described, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, Feature, OpenRewriteFeature, R2dbcFeature

@Requires(property="micronaut.starter.feature.r2dbc.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class R2dbc
extends R2dbcConfigurationUtils
implements R2dbcFeature, OpenRewriteFeature

Feature that adds support for R2DBC (Reactive Relational Database Connectivity). This feature ensures a default database driver is present, and if database migration features are included without a JDBC feature, it adds the Hikari JDBC connection pool. It also contributes relevant recipes for documentation, dependencies, and database configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
R2dbc(DatabaseDriverFeature defaultDbFeature, Hikari hikari)

Method Summary

Modifier and Type	Method	Description
String	getCategory()
@NonNull String	getDescription()
@NonNull String	getName()	The name of the feature.
List<String>	getRecipes(GeneratorContext generatorContext)
String	getTitle()
String	getUrlKey()
void	processSelectedFeatures(FeatureContext featureContext)	If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set).

Methods inherited from class io.micronaut.starter.feature.database.r2dbc.R2dbcConfigurationUtils

addDatabaseConfigRecipe

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

getOrder, isCommunity, isPreview, isVisible, supports

Methods inherited from interface io.micronaut.projectgen.core.openrewrite.OpenRewriteFeature

apply, getFrameworkDocumentation, getThirdPartyDocumentation, processRecipes

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

R2dbc

public R2dbc(DatabaseDriverFeature defaultDbFeature,
 Hikari hikari)

Method Details

getName

@NonNull
public @NonNull String getName()

Description copied from interface: Feature

The name of the feature. It must be unique.

Specified by:

getName in interface Feature

Specified by:

getName in interface io.micronaut.core.naming.Named

Returns:

the name of the feature

getTitle

public String getTitle()

Specified by:

getTitle in interface Feature

Returns:

The title of the feature

getDescription

@NonNull
public @NonNull String getDescription()

Specified by:

getDescription in interface io.micronaut.core.naming.Described

Specified by:

getDescription in interface Feature

processSelectedFeatures

public void processSelectedFeatures(FeatureContext featureContext)

Description copied from interface: Feature

If this method is called for a given feature then that feature was explicitly selected or was included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set). This method can be implemented to allow features to modify the list of features that will apply to the project. The methods FeatureContext.addFeature(Feature) and FeatureContext.exclude(FeaturePredicate) are the primary ways to add and remove features from the context. FeatureContext.isPresent(Class) can be used to determine the existence of other features in order to make decisions.

Specified by:

processSelectedFeatures in interface Feature

Parameters:

featureContext - The feature context

getCategory

public String getCategory()

Specified by:

getCategory in interface Feature

Returns:

The Category to which the feature belongs to.

getRecipes

public List<String> getRecipes(GeneratorContext generatorContext)

Specified by:

getRecipes in interface OpenRewriteFeature

getUrlKey

public String getUrlKey()

Returns:

The URL key