Fix slow deletion on deleteClientSessionsByRealm and `deleteClientS…

…essionsByUser` when using mysql and mariadb by converting sub-query to join
keycloak · Oct 27, 2022 · 43a3677 · 43a3677
1 parent 9fb9780
commit 43a3677
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 2 deletions.
diff --git a/model/jpa/src/main/java/org/keycloak/models/jpa/session/PersistentClientSessionEntity.java b/model/jpa/src/main/java/org/keycloak/models/jpa/session/PersistentClientSessionEntity.java
@@ -30,11 +30,15 @@
  * @author <a href="mailto:mposolda@redhat.com">Marek Posolda</a>
  */
 @NamedQueries({
-        @NamedQuery(name="deleteClientSessionsByRealm", query="delete from PersistentClientSessionEntity sess where sess.userSessionId IN (select u.userSessionId from PersistentUserSessionEntity u where u.realmId = :realmId)"),
+        // sub-query with deletion performs very slow in MySQL/MariaDB databases
+        // It is removed from here and added manually in JpaUtils to give a native implementation if needed
+        // @NamedQuery(name="deleteClientSessionsByRealm", query="delete from PersistentClientSessionEntity sess where sess.userSessionId IN (select u.userSessionId from PersistentUserSessionEntity u where u.realmId = :realmId)"),
         @NamedQuery(name="deleteClientSessionsByClient", query="delete from PersistentClientSessionEntity sess where sess.clientId = :clientId"),
         @NamedQuery(name="deleteClientSessionsByExternalClient", query="delete from PersistentClientSessionEntity sess where sess.clientStorageProvider = :clientStorageProvider and sess.externalClientId = :externalClientId"),
         @NamedQuery(name="deleteClientSessionsByClientStorageProvider", query="delete from PersistentClientSessionEntity sess where sess.clientStorageProvider = :clientStorageProvider"),
-        @NamedQuery(name="deleteClientSessionsByUser", query="delete from PersistentClientSessionEntity sess where sess.userSessionId IN (select u.userSessionId from PersistentUserSessionEntity u where u.userId = :userId)"),
+        // sub-query with deletion performs very slow in MySQL/MariaDB databases
+        // It is removed from here and added manually in JpaUtils to give a native implementation if needed
+        // @NamedQuery(name="deleteClientSessionsByUser", query="delete from PersistentClientSessionEntity sess where sess.userSessionId IN (select u.userSessionId from PersistentUserSessionEntity u where u.userId = :userId)"),
         @NamedQuery(name="deleteClientSessionsByUserSession", query="delete from PersistentClientSessionEntity sess where sess.userSessionId = :userSessionId and sess.offline = :offline"),
         // KEYCLOAK-18842: The deleteExpiredClientSessions performs very slow in MySQL/MariaDB databases
         //                 It is removed from here and added manually in JpaUtils to give a native implementation if needed

diff --git a/model/jpa/src/main/resources/META-INF/queries-default.properties b/model/jpa/src/main/resources/META-INF/queries-default.properties
@@ -8,3 +8,11 @@
 deleteExpiredClientSessions=delete from PersistentClientSessionEntity sess where sess.userSessionId IN (\
  select u.userSessionId from PersistentUserSessionEntity u \
  where u.realmId = :realmId AND u.offline = :offline AND u.lastSessionRefresh < :lastSessionRefresh)
+
+deleteClientSessionsByRealm=delete from PersistentClientSessionEntity sess where sess.userSessionId IN (\
+  select u.userSessionId from PersistentUserSessionEntity u \
+  where u.realmId = :realmId)
+
+deleteClientSessionsByUser=delete from PersistentClientSessionEntity sess where sess.userSessionId IN (\
+  select u.userSessionId from PersistentUserSessionEntity u \
+  where u.userId = :userId)
diff --git a/model/jpa/src/main/resources/META-INF/queries-mariadb.properties b/model/jpa/src/main/resources/META-INF/queries-mariadb.properties
@@ -7,3 +7,9 @@
 deleteExpiredClientSessions[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
  where c.USER_SESSION_ID = u.USER_SESSION_ID and u.REALM_ID = :realmId and u.OFFLINE_FLAG = :offline \
  and u.LAST_SESSION_REFRESH < :lastSessionRefresh
+
+deleteClientSessionsByRealm[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
+ where c.USER_SESSION_ID = u.USER_SESSION_ID and u.REALM_ID = :realmId
+
+deleteClientSessionsByUser[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
+ where c.USER_SESSION_ID = u.USER_SESSION_ID and u.USER_ID = :userId
diff --git a/model/jpa/src/main/resources/META-INF/queries-mysql.properties b/model/jpa/src/main/resources/META-INF/queries-mysql.properties
@@ -7,3 +7,9 @@
 deleteExpiredClientSessions[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
  where c.USER_SESSION_ID = u.USER_SESSION_ID and u.REALM_ID = :realmId and u.OFFLINE_FLAG = :offline \
  and u.LAST_SESSION_REFRESH < :lastSessionRefresh
+
+deleteClientSessionsByRealm[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
+ where c.USER_SESSION_ID = u.USER_SESSION_ID and u.REALM_ID = :realmId
+
+deleteClientSessionsByUser[native]=delete c from OFFLINE_CLIENT_SESSION c join OFFLINE_USER_SESSION u \
+ where c.USER_SESSION_ID = u.USER_SESSION_ID and u.USER_ID = :userId