Chapter 2. JDBC data source configuration

Procedure

1. Navigate to your Quarkus project directory.

2. Add the quarkus-agroal extension to your project:

   ./mvnw quarkus:add-extension -Dextensions="agroal"

3. Add the Quarkus extension for the appropriate type of relational database driver to your application:

   ./mvnw quarkus:add-extension -Dextensions="<extension>"

   For example, to add a PostgreSQL database driver extension, use:

   ./mvnw quarkus:add-extension -Dextensions="jdbc-postgresql"

Procedure

1. Navigate to your Quarkus project directory.
2. Open the src/main/resources/application.properties file.

3. Set the value of the quarkus.datasource.jdbc.url property to match the JDBC URL for your data source:

   quarkus.datasource.jdbc.url=<JDBC_URL>

   For example, to set the JDBC URL of a PostgreSQL data source, use:

   quarkus.datasource.jdbc.url=jdbc:postgresql://localhost:5432/hibernate_orm_test

Procedure

1. Navigate to your Quarkus project directory.
2. Open the src/main/resources/application.properties file.

3. Set the quarkus.datasource.jdbc property to false to disable the JDBC data source:

   quarkus.datasource.jdbc=false

Procedure

1. Navigate to your Quarkus project directory.
2. Open the src/main/resources/application.properties file.

3. Set the value of the db-kind property to other:

   quarkus.datasource.db-kind=other

4. Set the value of the quarkus.datasource.jdbc.driver property to match the type of driver extension that you want to use:

   quarkus.datasource.jdbc.driver=<driver>

5. Set the value of the quarkus.datasource.jdbc.url property to match the JDBC URL for your data source:

   quarkus.datasource.jdbc.url=<JDBC_URL>

   For example, Quarkus does not provide a built-in driver extension for the OpenTracing driver. Ensure that you add the opentracing-jdbc artifact to your pom.xml file, and set the following properties in your application.properties file to configure the OpenTracing driver:

   quarkus.datasource.db-kind=postgresql
   quarkus.datasource.jdbc.url=jdbc:tracing:postgresql://localhost:5432/mydatabase
   quarkus.datasource.jdbc.driver=io.opentracing.contrib.jdbc.TracingDriver
   quarkus.hibernate-orm.dialect=org.hibernate.dialect.PostgreSQLDialect

Procedure

1. Navigate to your Quarkus project directory.

2. In the src/main/resources/application.properties file, set the following properties for each of your data sources:

   • The name of the data source. For example, if you choose users as the name of the data source, the fully qualified reference of your data source is quarkus.datasource.users.
   • The db-kind property that matches the type of the data source
   • The quarkus.datasource.username that specifies the username for the data source
   • The quarkus.datasource.jdbc.url that specifies the JDBC connection URL of the data source
   • The quarkus.datasource.jdbc.min-size property that specifies the minimum number of connections that are maintained in the connection pool of the data source

   • The quarkus.datasource.jdbc.max-size property that specifies the maximum number of connections that are maintained in the connection pool of the data source

     The following example shows the complete configuration for 3 JDBC data sources:

     quarkus.datasource.db-kind=h2
     quarkus.datasource.username=username-default
     quarkus.datasource.jdbc.url=jdbc:h2:tcp://localhost/mem:default
     quarkus.datasource.jdbc.min-size=3
     quarkus.datasource.jdbc.max-size=13
     
     quarkus.datasource.users.db-kind=h2
     quarkus.datasource.users.username=username1
     quarkus.datasource.users.jdbc.url=jdbc:h2:tcp://localhost/mem:users
     quarkus.datasource.users.jdbc.min-size=1
     quarkus.datasource.users.jdbc.max-size=11
     
     quarkus.datasource.inventory.db-kind=h2
     quarkus.datasource.inventory.username=username2
     quarkus.datasource.inventory.jdbc.url=jdbc:h2:tcp://localhost/mem:inventory
     quarkus.datasource.inventory.jdbc.min-size=2
     quarkus.datasource.inventory.jdbc.max-size=12

3. Inject multiple data sources into by adding the @Inject annotation to each one of the class properties. When you configure multiple data sources for your application, ensure that you add the io.quarkus.agroal.DataSource qualifier with the name of the data source as the value to each DataSource class:

   import javax.inject.Inject;
   import io.agroal.api.AgroalDataSource;
   import io.quarkus.agroal.DataSource;
   
   @Inject
   AgroalDataSource defaultDataSource;
   
   @Inject
   @DataSource("users")
   AgroalDataSource usersDataSource;
   
   @Inject
   @DataSource("inventory")
   AgroalDataSource inventoryDataSource;