Package io.quarkus.hibernate.orm.runtime

Interface HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase

Enclosing interface:
HibernateOrmRuntimeConfigPersistenceUnit
public static interface HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabase

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String>
    defaultCatalog()
    The default catalog to use for the database objects.
    Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String>
    defaultSchema()
    The default schema to use for the database objects.
    HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabaseGeneration
    generation()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Use quarkus.hibernate-orm.schema-management instead.
    boolean
    startOffline()
    Instructs Hibernate ORM to avoid connecting to the database on startup.
    Optional<Boolean>
    versionCheckEnabled()
    Whether Hibernate ORM should check on startup that the version of the database matches the version configured on the dialect (either the default version, or the one set through `quarkus.datasource.db-version`).

  • Method Details

    • generation

      @Deprecated(forRemoval=true, since="3.22") HibernateOrmRuntimeConfigPersistenceUnit.HibernateOrmConfigPersistenceUnitDatabaseGeneration generation()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use quarkus.hibernate-orm.schema-management instead.
      Schema generation configuration.

    • defaultCatalog

      Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String> defaultCatalog()
      The default catalog to use for the database objects.

    • defaultSchema

      Optional<@WithConverter(io.quarkus.runtime.configuration.TrimmedStringConverter.class) String> defaultSchema()
      The default schema to use for the database objects.

    • versionCheckEnabled

      @WithName("version-check.enabled") @ConfigDocDefault("`false` if starting offline (see `start-offline`), `true` otherwise") Optional<Boolean> versionCheckEnabled()
      Whether Hibernate ORM should check on startup that the version of the database matches the version configured on the dialect (either the default version, or the one set through `quarkus.datasource.db-version`). This should be set to `false` if the database is not available on startup.

    • startOffline

      @WithDefault("false") boolean startOffline()
      Instructs Hibernate ORM to avoid connecting to the database on startup. When starting offline: * Hibernate ORM will not attempt to create a schema automatically, so it must already be created when the application hits the database for the first time. * Quarkus will not check that the database version matches the one configured at build time.