Package io.micronaut.starter.feature.database

Class SQLServer

java.lang.Object

io.micronaut.starter.feature.testresources.EaseTestingFeature

io.micronaut.starter.feature.database.DatabaseDriverFeature

io.micronaut.starter.feature.database.SQLServer

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.sqlserver.enabled",
          value="true",
          defaultValue="true")
@Singleton
public class SQLServer
extends DatabaseDriverFeature

Feature for Microsoft SQL Server database support.

Provides the necessary dependencies, default configuration, and connection URLs for both JDBC and R2DBC usage with SQL Server. Also integrates with test resources and test containers when applicable.

Field Summary

Fields

Modifier and Type	Field	Description
static final Dependency.Builder	DEPENDENCY_MSSQL_JDBC
static final String	NAME
static final String	VERTX_MSSQL_CLIENT

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected boolean	acceptLicense()	Determines whether to accept the license for the SQL Server test resources container.
void	apply(GeneratorContext generatorContext)	If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature).
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

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_MSSQL_CLIENT

public static final String VERTX_MSSQL_CLIENT

See Also:

• Constant Field Values

DEPENDENCY_MSSQL_JDBC

public static final Dependency.Builder DEPENDENCY_MSSQL_JDBC

Constructor Details

SQLServer

public SQLServer(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

getR2DbcDependency

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

getHibernateReactiveJavaClientDependency

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

getJavaClientDependency

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

embedded

public boolean embedded()

Specified by:

embedded in class DatabaseDriverFeature

apply

public void apply(GeneratorContext generatorContext)

Description copied from interface: Feature

If this method is called for a given feature that means the feature was explicitly selected, included by default as a result of DefaultFeature.shouldApply(io.micronaut.starter.options.Options, java.util.Set), or added explicitly by another feature through FeatureContext.addFeature(Feature). At this point the feature list is set and cannot change.

Specified by:

apply in interface Feature

Overrides:

apply in class DatabaseDriverFeature

Parameters:

generatorContext - THe generator context

acceptLicense

protected boolean acceptLicense()

Determines whether to accept the license for the SQL Server test resources container.

By default, this method returns false, indicating that the license is not accepted. Subclasses may override this method to change the default behavior.

Returns:

true if the license is accepted, false otherwise