Quarkus Doma

Introduction

Doma is a database access framework with support for type-safe Criteria API and SQL templates.

For more details, please refer to https://doma.readthedocs.io/en/latest/quarkus-support/.

Configuration References

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.doma.dialect

The SQL dialect.

Environment variable: QUARKUS_DOMA_DIALECT

db2, h2, mssql, mysql, oracle, postgres, standard, sqlite

depends on 'quarkus.datasource.db-kind'

quarkus.doma.batch-size

The batch size.

Environment variable: QUARKUS_DOMA_BATCH_SIZE

int

0

quarkus.doma.fetch-size

The fetch size.

Environment variable: QUARKUS_DOMA_FETCH_SIZE

int

0

quarkus.doma.max-rows

The max rows.

Environment variable: QUARKUS_DOMA_MAX_ROWS

int

0

quarkus.doma.query-timeout

The query timeout limit in seconds.

Environment variable: QUARKUS_DOMA_QUERY_TIMEOUT

int

0

quarkus.doma.sql-load-script

Name of the file containing the SQL statements to execute when Doma starts. Its default value differs depending on the Quarkus launch mode:

* In dev and test modes, it defaults to import.sql. Simply add an import.sql file in the root of your resources directory and it will be picked up without having to set this property. Pass no-file to force Doma to ignore the SQL import file. * In production mode, it defaults to no-file. It means Doma won’t try to execute any SQL import file by default. Pass an explicit value to force Doma to execute the SQL import file.

Environment variable: QUARKUS_DOMA_SQL_LOAD_SCRIPT

string

import.sql in DEV, TEST ; no-file otherwise

quarkus.doma.sql-file-repository

The SQL file repository.

Environment variable: QUARKUS_DOMA_SQL_FILE_REPOSITORY

no-cache, greedy-cache

greedy-cache

quarkus.doma.naming

The naming convention controller.

Environment variable: QUARKUS_DOMA_NAMING

none, lower-case, upper-case, snake-lower-case, snake-upper-case

none

quarkus.doma.exception-sql-log-type

The SQL log type that determines the SQL log format in exceptions.

Environment variable: QUARKUS_DOMA_EXCEPTION_SQL_LOG_TYPE

raw, formatted, none

none

Additional named datasources

Type

Default

quarkus.doma."datasource-name".dialect

The SQL dialect.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__DIALECT

db2, h2, mssql, mysql, oracle, postgres, standard, sqlite

depends on 'quarkus.datasource.db-kind'

quarkus.doma."datasource-name".batch-size

The batch size.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__BATCH_SIZE

int

0

quarkus.doma."datasource-name".fetch-size

The fetch size.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__FETCH_SIZE

int

0

quarkus.doma."datasource-name".max-rows

The max rows.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__MAX_ROWS

int

0

quarkus.doma."datasource-name".query-timeout

The query timeout limit in seconds.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__QUERY_TIMEOUT

int

0

quarkus.doma."datasource-name".sql-load-script

Name of the file containing the SQL statements to execute when Doma starts. Its default value differs depending on the Quarkus launch mode:

* In dev and test modes, it defaults to import.sql. Simply add an import.sql file in the root of your resources directory and it will be picked up without having to set this property. Pass no-file to force Doma to ignore the SQL import file. * In production mode, it defaults to no-file. It means Doma won’t try to execute any SQL import file by default. Pass an explicit value to force Doma to execute the SQL import file.

Environment variable: QUARKUS_DOMA__DATASOURCE_NAME__SQL_LOAD_SCRIPT

string

import.sql in DEV, TEST ; no-file otherwise