Chapter 6. Installing and managing Java extensions with Quarkus applications

Procedure

1. Navigate to your Quarkus project directory.

2. To list the available extensions, enter the following command:

   ./mvnw quarkus:list-extensions

   Copy to Clipboard Toggle word wrap

3. To add an extension to your project, enter the following command where <extension> is the group, artifact, version (GAV) of the extension that you want to add:

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

   Copy to Clipboard Toggle word wrap

   For example, to add the Agroal extension, enter the following command:

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

   Copy to Clipboard Toggle word wrap

4. To search for a specific extension, enter the extension name or partial name after -Dextensions=. The following example searches for extensions that contain the text jdbc, agroal, and non-exist-ent in the name:

   ./mvnw quarkus:add-extension -Dextensions=jdbc,agroal,non-exist-ent

   Copy to Clipboard Toggle word wrap

   This command returns the following result:

   ❌ Multiple extensions matching 'jdbc'
       * io.quarkus:quarkus-jdbc-h2
       * io.quarkus:quarkus-jdbc-mariadb
       * io.quarkus:quarkus-jdbc-postgresql
       Be more specific e.g using the exact name or the full gav.
   ✅ Adding extension io.quarkus:quarkus-agroal
   ❌ Cannot find a dependency matching 'non-exist-ent', maybe a typo?
   [...]

   Copy to Clipboard Toggle word wrap

5. To install all extensions that a specific text string returns, enter the extension name or partial name after -Dextensions=. The following example searches for and installs all extensions that begin with hibernate-:

   ./mvnw quarkus:add-extension -Dextensions="hibernate-*"

   Copy to Clipboard Toggle word wrap