upstream/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-05-28 04:13:22 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Fix charset of ORG.ID for mysql/mariadb

Browse source 
Closes #45239

Signed-off-by: vramik <vramik@redhat.com>
This commit is contained in:
vramik 2026-01-08 13:17:34 +01:00 committed by Pedro Igor
parent ad695dc700
commit 5d773e688b
2 changed files with 101 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
model/jpa/src/main/java/org/keycloak/connections/jpa/updater/liquibase/custom/JpaUpdate26_5_0_OrgTableCharset.java Normal file
View file

@ -0,0 +1,66 @@
/*
* Copyright 2026 Red Hat, Inc. and/or its affiliates
* and other contributors as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.keycloak.connections.jpa.updater.liquibase.custom;
import liquibase.exception.CustomChangeException;
import liquibase.snapshot.SnapshotGeneratorFactory;
import liquibase.statement.core.RawSqlStatement;
import liquibase.structure.core.Table;
/**
* Ensures ORG.ID column has correct charset for MySQL/MariaDB to allow foreign keys from ORG_INVITATION table.
*
* This fixes the issue where foreign key creation fails due to charset mismatch between ORG.ID and
* ORG_INVITATION.ORGANIZATION_ID columns on MySQL/MariaDB databases.
*
* See https://github.com/keycloak/keycloak/issues/45239
*/
public class JpaUpdate26_5_0_OrgTableCharset extends CustomKeycloakTask {
@Override
protected boolean isApplicable() throws CustomChangeException {
// Always apply this charset fix when ORG table exists
// Don't check for REALM data as this needs to run during initial database creation
try {
// Correct the table name based on the database dialect (quotes, case-sensitivity)
String correctedTableName = database.correctObjectName("ORG", Table.class);
// Use the Liquibase Snapshot API to check if the table actually exists in the schema
return SnapshotGeneratorFactory.getInstance().has(new Table().setName(correctedTableName), database);
} catch (Exception e) {
throw new CustomChangeException("Failed to check for existence of ORG table", e);
}
}
@Override
protected void generateStatementsImpl() throws CustomChangeException {
String orgTableName = getTableName("ORG");
// Fix ORG.ID column charset to utf8mb3 to ensure foreign key compatibility with ORG_INVITATION table
statements.add(new RawSqlStatement(
"ALTER TABLE " + orgTableName +
" MODIFY ID VARCHAR(255) CHARACTER SET utf8mb3 COLLATE utf8mb3_unicode_ci NOT NULL"
));
confirmationMessage.append("Updated ORG.ID column charset to utf8mb3 for foreign key compatibility");
}
@Override
protected String getTaskId() {
return "Update ORG table charset and collation";
}
}

37
model/jpa/src/main/resources/META-INF/jpa-changelog-26.5.0.xml
View file

@ -135,7 +135,29 @@
<!-- replaced by the 2 indexes above -->
<dropIndex tableName="OFFLINE_USER_SESSION" indexName="IDX_OFFLINE_USS_BY_LAST_SESSION_REFRESH"/>
</changeSet>
<changeSet author="keycloak" id="26.5.0-invitations-table">
<changeSet author="keycloak" id="26.5.0-org-id-charset-mysql">
<preConditions onFail="MARK_RAN" onSqlOutput="TEST">
<and>
<or>
<dbms type="mysql"/>
<dbms type="mariadb"/>
</or>
<not>
<changeSetExecuted id="26.5.0-invitations-table" author="keycloak" changeLogFile="META-INF/jpa-changelog-26.5.0.xml"/>
</not>
</and>
</preConditions>
<customChange class="org.keycloak.connections.jpa.updater.liquibase.custom.JpaUpdate26_5_0_OrgTableCharset"/>
</changeSet>
<changeSet author="keycloak" id="26.5.0-invitations-table-fixed">
<preConditions onFail="MARK_RAN" onSqlOutput="TEST">
<not>
<changeSetExecuted id="26.5.0-invitations-table" author="keycloak" changeLogFile="META-INF/jpa-changelog-26.5.0.xml"/>
</not>
</preConditions>
<createTable tableName="ORG_INVITATION">
<column name="ID" type="VARCHAR(36)">
<constraints nullable="false" primaryKey="true" primaryKeyName="CONSTRAINT_ORG_INVITATION"/>
@ -155,6 +177,18 @@
<column name="INVITE_LINK" type="VARCHAR(2048)"/>
</createTable>
<modifySql dbms="mysql,mariadb">
<append value=" CHARACTER SET utf8mb3 COLLATE utf8mb3_unicode_ci"/>
</modifySql>
</changeSet>
<changeSet author="keycloak" id="26.5.0-invitations-table-fixed-fk">
<preConditions onFail="MARK_RAN" onSqlOutput="TEST">
<not>
<changeSetExecuted id="26.5.0-invitations-table" author="keycloak" changeLogFile="META-INF/jpa-changelog-26.5.0.xml"/>
</not>
</preConditions>
<addForeignKeyConstraint baseTableName="ORG_INVITATION"
baseColumnNames="ORGANIZATION_ID"
constraintName="FK_ORG_INVITATION_ORG"
@ -179,5 +213,4 @@
columnNames="ORGANIZATION_ID,EMAIL"
constraintName="UK_ORG_INVITATION_EMAIL"/>
</changeSet>
</databaseChangeLog>