HHH-3404 support for regular expressions in HQL LIKE operator

Author: gavinking

hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java

@@ -149,7 +149,6 @@
 import org.hibernate.tool.schema.spi.SchemaManagementTool;
 import org.hibernate.tool.schema.spi.TableMigrator;
 import org.hibernate.type.BasicType;
-import org.hibernate.type.BasicTypeRegistry;
 import org.hibernate.type.SqlTypes;
 import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.WrapperOptions;
@@ -1374,6 +1373,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionRegistry.registerAlternateKey( "current_instant", "instant" ); //deprecated legacy!
 
 		functionRegistry.register( "sql", new SqlFunction() );
+
+		functionFactory.regexpLike();
 	}
 
 	/**

hibernate-core/src/main/java/org/hibernate/dialect/MariaDBDialect.java

@@ -45,7 +45,6 @@
 import org.hibernate.tool.schema.extract.internal.SequenceInformationExtractorMariaDBDatabaseImpl;
 import org.hibernate.tool.schema.extract.spi.SequenceInformationExtractor;
 import org.hibernate.type.SqlTypes;
-import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.jdbc.JdbcType;
 import org.hibernate.type.descriptor.jdbc.VarcharUUIDJdbcType;
 import org.hibernate.type.descriptor.jdbc.spi.JdbcTypeRegistry;
@@ -59,11 +58,11 @@
 
 import static org.hibernate.exception.spi.TemplatedViolatedConstraintNameExtractor.extractUsingTemplate;
 import static org.hibernate.internal.util.JdbcExceptionHelper.extractSqlState;
-import static org.hibernate.query.sqm.produce.function.FunctionParameterType.NUMERIC;
 import static org.hibernate.type.SqlTypes.GEOMETRY;
 import static org.hibernate.type.SqlTypes.OTHER;
 import static org.hibernate.type.SqlTypes.UUID;
 import static org.hibernate.type.SqlTypes.VARBINARY;
+import static org.hibernate.type.StandardBasicTypes.BOOLEAN;
 
 /**
  * A {@linkplain Dialect SQL dialect} for MariaDB 10.6 and above.
@@ -121,15 +120,20 @@ public NationalizationSupport getNationalizationSupport() {
 	public void initializeFunctionRegistry(FunctionContributions functionContributions) {
 		super.initializeFunctionRegistry( functionContributions );
 
+		final var functionRegistry = functionContributions.getFunctionRegistry();
 		final var commonFunctionFactory = new CommonFunctionFactory( functionContributions );
+		final var basicTypeRegistry = functionContributions.getTypeConfiguration().getBasicTypeRegistry();
 
 		commonFunctionFactory.windowFunctions();
 		commonFunctionFactory.hypotheticalOrderedSetAggregates_windowEmulation();
-		functionContributions.getFunctionRegistry().registerNamed(
+		commonFunctionFactory.inverseDistributionOrderedSetAggregates_windowEmulation();
+		commonFunctionFactory.median_medianOver();
+
+		commonFunctionFactory.regexpLike_regexp();
+
+		functionRegistry.registerNamed(
 				"json_valid",
-				functionContributions.getTypeConfiguration()
-						.getBasicTypeRegistry()
-						.resolve( StandardBasicTypes.BOOLEAN )
+				basicTypeRegistry.resolve( BOOLEAN )
 		);
 		commonFunctionFactory.jsonValue_mariadb();
 		commonFunctionFactory.jsonArray_mariadb();
@@ -139,13 +143,6 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		commonFunctionFactory.jsonArrayAppend_mariadb();
 		commonFunctionFactory.unnest_emulated();
 		commonFunctionFactory.jsonTable_mysql();
-
-		commonFunctionFactory.inverseDistributionOrderedSetAggregates_windowEmulation();
-		functionContributions.getFunctionRegistry().patternDescriptorBuilder( "median", "median(?1) over ()" )
-				.setInvariantType( functionContributions.getTypeConfiguration().getBasicTypeRegistry().resolve( StandardBasicTypes.DOUBLE ) )
-				.setExactArgumentCount( 1 )
-				.setParameterTypes(NUMERIC)
-				.register();
 	}
 
 	@Override
@@ -332,11 +329,6 @@ public IdentifierHelper buildIdentifierHelper(IdentifierHelperBuilder builder, D
 		return super.buildIdentifierHelper( builder, metadata );
 	}
 
-	@Override
-	public String getDual() {
-		return "dual";
-	}
-
 	public ViolatedConstraintNameExtractor getViolatedConstraintNameExtractor() {
 		return EXTRACTOR;
 	}

hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java

@@ -403,6 +403,20 @@ public void median_percentileCont_castDouble() {
 				.register();
 	}
 
+	/**
+	 * For MariaDB
+	 */
+	public void median_medianOver() {
+		functionRegistry.patternDescriptorBuilder(
+						"median",
+						"median(?1) over ()"
+				)
+				.setInvariantType(doubleType)
+				.setExactArgumentCount( 1 )
+				.setParameterTypes(NUMERIC)
+				.register();
+	}
+
 	/**
 	 * Warning: the semantics of this function are inconsistent between DBs.
 	 * <ul>
@@ -2651,6 +2665,25 @@ public void dateTrunc_datetrunc() {
 				.register();
 	}
 
+	public void regexpLike() {
+		functionRegistry.namedDescriptorBuilder( "regexp_like"  )
+				.setArgumentCountBetween( 2, 3 )
+				.setParameterTypes( STRING, STRING, STRING )
+				.setInvariantType( booleanType )
+				.register();
+
+	}
+
+	/**
+	 * For MariaDB
+	 */
+	public void regexpLike_regexp() {
+		functionRegistry.patternDescriptorBuilder( "regexp_like", "?1 regexp ?2" )
+				.setParameterTypes( STRING, STRING )
+				.setInvariantType( booleanType )
+				.register();
+	}
+
 	/**
 	 * H2, HSQL array() constructor function
 	 */

hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/RegexTest.java

@@ -0,0 +1,60 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.orm.test.query.hql;
+
+import org.hibernate.dialect.HSQLDialect;
+import org.hibernate.dialect.MariaDBDialect;
+import org.hibernate.dialect.OracleDialect;
+import org.hibernate.dialect.SQLServerDialect;
+import org.hibernate.dialect.SybaseASEDialect;
+import org.hibernate.testing.orm.junit.EntityManagerFactoryScope;
+import org.hibernate.testing.orm.junit.Jpa;
+import org.hibernate.testing.orm.junit.SkipForDialect;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@Jpa
+class RegexTest {
+	@Test
+	@SkipForDialect(dialectClass = SQLServerDialect.class,
+			reason = "regexp_like coming in 2025")
+	@SkipForDialect(dialectClass = SybaseASEDialect.class,
+			reason = "no regex support in Sybase ASE")
+	void testInSelect(EntityManagerFactoryScope scope) {
+		if ( !( scope.getDialect() instanceof OracleDialect dialect
+				&& ( dialect.isAutonomous() || dialect.getVersion().isBefore( 23 ) ) ) ) {
+			scope.inEntityManager( em -> {
+				assertTrue( em.createQuery( "select regexp_like('abcdef', 'ab.*')", Boolean.class ).getSingleResult() );
+				assertTrue( em.createQuery( "select 'abcdef' like regexp 'ab.*'", Boolean.class ).getSingleResult() );
+			} );
+		}
+	}
+
+	@Test
+	@SkipForDialect(dialectClass = MariaDBDialect.class)
+	@SkipForDialect(dialectClass = HSQLDialect.class)
+	@SkipForDialect(dialectClass = SQLServerDialect.class,
+			reason = "regexp_like coming in 2025")
+	@SkipForDialect(dialectClass = SybaseASEDialect.class,
+			reason = "no regex support in Sybase ASE")
+	void testInSelectCaseInsensitive(EntityManagerFactoryScope scope) {
+		scope.inEntityManager( em -> {
+			assertTrue( em.createQuery( "select regexp_like('ABCDEF', 'ab.*', 'i')", Boolean.class ).getSingleResult() );
+		} );
+	}
+
+	@Test
+	@SkipForDialect(dialectClass = SQLServerDialect.class,
+			reason = "regexp_like coming in 2025")
+	@SkipForDialect(dialectClass = SybaseASEDialect.class,
+			reason = "no regex support in Sybase ASE")
+	void testInWhere(EntityManagerFactoryScope scope) {
+		scope.inEntityManager( em -> {
+			assertEquals( 1, em.createQuery( "select 1 where regexp_like('abcdef', 'ab.*')", Integer.class ).getSingleResult() );
+		} );
+	}
+}