Скачать или смотреть How to Export Keycloak Database SQL Schema

Learn how to efficiently export the Keycloak database SQL schema using Liquibase, preventing direct execution of SQL commands during startup.
---
This video is based on the question https://stackoverflow.com/q/77105518/ asked by the user 'Andreascopp' ( https://stackoverflow.com/u/8220814/ ) and on the answer https://stackoverflow.com/a/77105596/ provided by the user 'Andreascopp' ( https://stackoverflow.com/u/8220814/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: How to export Keycloak database SQL schema

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
How to Export Keycloak Database SQL Schema

Setting up Keycloak for identity and access management can be challenging, especially when it comes to managing the database schema. One common issue is ensuring that Keycloak does not run any SQL commands automatically at startup. Instead, you'd like to prepare your SQL commands for manual execution beforehand. In this guide, we'll guide you step-by-step on how to configure your Keycloak installation to export the database SQL schema properly, specifically focusing on using Liquibase.

The Problem

The main goal here is to set up Keycloak using Liquibase to define its database schema. Earlier versions, before Keycloak 15, allowed you to use a simple configuration in standalone.xml or standalone-ha.xml files to enable schema exports. However, with the release of Keycloak 22.0.1 and higher, the configuration has changed, making it less straightforward.

What You Have Tried

You've attempted a couple of methods so far:

Exporting Environment Variable:

KEYCLOAK_HIBERNATE_HBM2DDL_EXPORT=true

Starting Keycloak with Parameters:

[[See Video to Reveal this Text or Code Snippet]]

Unfortunately, these attempts did not yield the desired results.

The Solution

Fortunately, there is a functioning solution that involves specific configurations after starting Keycloak. Below are the details of the approach that worked:

Step 1: Setting Up the Database

Before you start Keycloak, ensure that it is configured with the proper database. It’s crucial to note that the aforementioned parameters will not work with H2 database. For proper functionality, a compatible database (like PostgreSQL, MySQL, etc.) must be in place.

Step 2: Using the Parameters Correctly

Once you have ensured that the correct database is in use, launch Keycloak with the following parameters:

[[See Video to Reveal this Text or Code Snippet]]

Explanation of Parameters

--spi-connections-jpa-legacy-migration-strategy=manual:

This parameter ensures that the migration strategy is set to manual, preventing any automatic execution of SQL commands.

--spi-connections-jpa-legacy-initialize-empty=false:

This option specifies that the database should not be initialized to an empty state automatically.

--spi-connections-jpa-legacy-migration-export= path /exportKC_DB.sql:

This crucial parameter designates the file path where the SQL commands will be exported. Make sure to specify a valid path that your system can access.

Conclusion

By following the steps outlined above, you should be able to successfully export the Keycloak database SQL schema without encountering issues associated with automatic SQL execution during startup. This method ensures your database schema is prepared as you desire, allowing for a smoother setup process.

If you have any further questions or need additional assistance, feel free to reach out. Happy coding!