Package io.quarkus.hibernate.orm.deployment.spi

Class DatabaseKindDialectBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.hibernate.orm.deployment.spi.DatabaseKindDialectBuildItem

public final class DatabaseKindDialectBuildItem
extends io.quarkus.builder.item.MultiBuildItem

An Hibernate Dialect associated with a database kind.

Constructor Summary

Constructors

Constructor	Description
DatabaseKindDialectBuildItem(String dbKind, String dialect)	Deprecated. Use forCoreDialect(String, String, Set)(different arguments!)
DatabaseKindDialectBuildItem(String dbKind, String dialect, String defaultDatabaseProductVersion)	Deprecated. Use forCoreDialect(String, String, Set, String)(different arguments!)

Method Summary

Modifier and Type	Method	Description
static DatabaseKindDialectBuildItem	forCoreDialect(String dbKind, String databaseProductName, Set<String> dialects)
static DatabaseKindDialectBuildItem	forCoreDialect(String dbKind, String databaseProductName, Set<String> dialects, String defaultDatabaseProductVersion)
static DatabaseKindDialectBuildItem	forThirdPartyDialect(String dbKind, String dialect)
static DatabaseKindDialectBuildItem	forThirdPartyDialect(String dbKind, String dialect, String defaultDatabaseProductVersion)
Optional<String>	getDatabaseProductName()
String	getDbKind()
Optional<String>	getDefaultDatabaseProductVersion()
String	getDialect()
Optional<String>	getDialectOptional()
Set<String>	getMatchingDialects()

Methods inherited from class java.lang.Object

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

Constructor Details

DatabaseKindDialectBuildItem

@Deprecated
public DatabaseKindDialectBuildItem(String dbKind,
 String dialect)

Deprecated.

Use forCoreDialect(String, String, Set)(different arguments!) for core Hibernate ORM dialects to avoid warnings on startup, or forThirdPartyDialect(String, String) for community or third-party dialects.

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

dialect - The corresponding dialect to set in Hibernate ORM.

DatabaseKindDialectBuildItem

@Deprecated
public DatabaseKindDialectBuildItem(String dbKind,
 String dialect,
 String defaultDatabaseProductVersion)

Deprecated.

Use forCoreDialect(String, String, Set, String)(different arguments!) for core Hibernate ORM dialects to avoid warnings on startup, or forThirdPartyDialect(String, String, String) for community or third-party dialects.

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

dialect - The corresponding dialect to set in Hibernate ORM. See org.hibernate.dialect.Database for information on how this name is resolved to a dialect.

defaultDatabaseProductVersion - The default database-product-version to set in Hibernate ORM. This is useful when the default version of the dialect in Hibernate ORM is lower than what we expect in Quarkus.

Method Details

forCoreDialect

public static DatabaseKindDialectBuildItem forCoreDialect(String dbKind,
 String databaseProductName,
 Set<String> dialects)

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

databaseProductName - The corresponding database-product-name to set in Hibernate ORM. See org.hibernate.dialect.Database for information on how this name is resolved to a dialect. Also works with org.hibernate.community.dialect.CommunityDatabase if hibernate-community-dialects is in the classpath.

dialects - The corresponding dialects in Hibernate ORM, to detect the dbKind when using database multi-tenancy.

forCoreDialect

public static DatabaseKindDialectBuildItem forCoreDialect(String dbKind,
 String databaseProductName,
 Set<String> dialects,
 String defaultDatabaseProductVersion)

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

databaseProductName - The corresponding database-product-name to set in Hibernate ORM. See org.hibernate.dialect.Database for information on how this name is resolved to a dialect. Also works with org.hibernate.community.dialect.CommunityDatabase if hibernate-community-dialects is in the classpath.

dialects - The corresponding dialects in Hibernate ORM, to detect the dbKind when using database multi-tenancy.

defaultDatabaseProductVersion - The default database-product-version to set in Hibernate ORM. This is useful when the default version of the dialect in Hibernate ORM is lower than what we expect in Quarkus.

forThirdPartyDialect

public static DatabaseKindDialectBuildItem forThirdPartyDialect(String dbKind,
 String dialect)

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

dialect - The corresponding dialect to set in Hibernate ORM. See org.hibernate.dialect.Database for information on how this name is resolved to a dialect.

forThirdPartyDialect

public static DatabaseKindDialectBuildItem forThirdPartyDialect(String dbKind,
 String dialect,
 String defaultDatabaseProductVersion)

Parameters:

dbKind - The DB Kind set through quarkus.datasource.db-kind

dialect - The corresponding dialect to set in Hibernate ORM. See org.hibernate.dialect.Database for information on how this name is resolved to a dialect.

defaultDatabaseProductVersion - The default database-product-version to set in Hibernate ORM. This is useful when the default version of the dialect in Hibernate ORM is lower than what we expect in Quarkus.

getDbKind

public String getDbKind()

getDialect

public String getDialect()

getDialectOptional

public Optional<String> getDialectOptional()

getMatchingDialects

public Set<String> getMatchingDialects()

getDatabaseProductName

public Optional<String> getDatabaseProductName()

getDefaultDatabaseProductVersion

public Optional<String> getDefaultDatabaseProductVersion()