HHH-18892 add sha() and md5() functions to HQL

gavinking · gavinking · commit b5c847b05bb9 · 2024-12-03T15:11:05.000+01:00
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java
@@ -54,6 +54,7 @@
 import org.hibernate.query.SemanticException;
 import org.hibernate.query.sqm.IntervalType;
 import org.hibernate.query.common.TemporalUnit;
+import org.hibernate.query.sqm.produce.function.FunctionParameterType;
 import org.hibernate.query.sqm.produce.function.StandardFunctionArgumentTypeResolvers;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.sql.ast.SqlAstTranslator;
@@ -503,6 +504,10 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				new PostgreSQLTruncFunction( true, functionContributions.getTypeConfiguration() )
 		);
 		functionContributions.getFunctionRegistry().registerAlternateKey( "truncate", "trunc" );
+
+
+		functionFactory.sha( "sha256(?1)" );
+		functionFactory.md5( "decode(md5(?1), 'hex')" );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
@@ -452,6 +452,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 		functionFactory.unnest_db2( getMaximumSeriesSize() );
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, true );
+
+		functionFactory.sha( "hash(?1, 2)" );
+		functionFactory.md5( "hash(?1, 0)" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java
@@ -52,6 +52,7 @@
 import org.hibernate.query.sqm.mutation.internal.temptable.GlobalTemporaryTableMutationStrategy;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableInsertStrategy;
 import org.hibernate.query.sqm.mutation.spi.SqmMultiTableMutationStrategy;
+import org.hibernate.query.sqm.produce.function.FunctionParameterType;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.sql.ast.SqlAstNodeRenderingMode;
 import org.hibernate.sql.ast.SqlAstTranslator;
@@ -368,6 +369,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.unnest_h2( getMaximumArraySize() );
 		functionFactory.generateSeries_h2( getMaximumSeriesSize() );
 		functionFactory.jsonTable_h2( getMaximumArraySize() );
+
+		functionFactory.sha( "hash('SHA-256', ?1)" );
+		functionFactory.md5( "hash('MD5', ?1)" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/HANADialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/HANADialect.java
@@ -517,6 +517,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 //		functionFactory.xmlextract();
 		functionFactory.generateSeries_hana( getMaximumSeriesSize() );
+
+		functionFactory.sha( "hash_sha256(?1)" );
+		functionFactory.md5( "hash_md5(?1)" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java
@@ -606,7 +606,6 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.crc32();
 		functionFactory.sha1();
 		functionFactory.sha2();
-		functionFactory.sha();
 		functionFactory.bitLength();
 		functionFactory.octetLength();
 		functionFactory.ascii();
@@ -688,6 +687,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		if ( supportsRecursiveCTE() ) {
 			functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );
 		}
+
+		functionFactory.sha( "unhex(sha2(?1, 256))" );
+		functionFactory.md5( "unhex(md5(?1))" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/OracleDialect.java
@@ -440,6 +440,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.unnest_oracle();
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), true, false );
 		functionFactory.jsonTable_oracle();
+
+		functionFactory.sha( "standard_hash(?1, 'SHA256')" );
+		functionFactory.md5( "standard_hash(?1, 'MD5')" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java
@@ -83,6 +83,7 @@
 import org.hibernate.tool.schema.internal.StandardTableExporter;
 import org.hibernate.tool.schema.spi.Exporter;
 import org.hibernate.type.JavaObjectType;
+import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.java.PrimitiveByteArrayJavaType;
 import org.hibernate.type.descriptor.jdbc.BlobJdbcType;
 import org.hibernate.type.descriptor.jdbc.ClobJdbcType;
@@ -690,6 +691,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			functionFactory.unnest_postgresql();
 		}
 		functionFactory.generateSeries( null, "ordinality", false );
+
+		functionFactory.sha( "sha256(?1)" );
+		functionFactory.md5( "decode(md5(?1), 'hex')" );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java
@@ -487,6 +487,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );
 			}
 		}
+
+		functionFactory.sha( "hashbytes('SHA2_256', ?1)" );
+		functionFactory.md5( "hashbytes('MD5', ?1)" );
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/CommonFunctionFactory.java
@@ -68,6 +68,7 @@ public class CommonFunctionFactory {
 	private final BasicType<Boolean> booleanType;
 	private final BasicType<Character> characterType;
 	private final BasicType<String> stringType;
+	private final BasicType<byte[]> binaryType;
 	private final BasicType<Integer> integerType;
 	private final BasicType<Long> longType;
 	private final BasicType<Double> doubleType;
@@ -90,6 +91,7 @@ public CommonFunctionFactory(FunctionContributions functionContributions) {
 		characterType = basicTypeRegistry.resolve(StandardBasicTypes.CHARACTER);
 		booleanType = basicTypeRegistry.resolve(StandardBasicTypes.BOOLEAN);
 		stringType = basicTypeRegistry.resolve(StandardBasicTypes.STRING);
+		binaryType = basicTypeRegistry.resolve(StandardBasicTypes.BINARY);
 		integerType = basicTypeRegistry.resolve(StandardBasicTypes.INTEGER);
 		doubleType = basicTypeRegistry.resolve(StandardBasicTypes.DOUBLE);
 	}
@@ -2313,6 +2315,7 @@ public void cbrt() {
 				.register();
 	}
 
+	@Deprecated(since = "7")
 	public void crc32() {
 		functionRegistry.namedDescriptorBuilder( "crc32" )
 				.setInvariantType(integerType)
@@ -2321,6 +2324,23 @@ public void crc32() {
 				.register();
 	}
 
+	public void md5(String pattern) {
+		functionRegistry.patternDescriptorBuilder( "md5", pattern )
+				.setInvariantType(binaryType)
+				.setParameterTypes( STRING )
+				.setExactArgumentCount( 1 )
+				.register();
+	}
+
+	public void sha(String pattern) {
+		functionRegistry.patternDescriptorBuilder( "sha", pattern )
+				.setInvariantType(binaryType)
+				.setParameterTypes( STRING )
+				.setExactArgumentCount( 1 )
+				.register();
+	}
+
+	@Deprecated(since = "7")
 	public void sha1() {
 		functionRegistry.namedDescriptorBuilder( "sha1" )
 				.setInvariantType(stringType)
@@ -2329,6 +2349,7 @@ public void sha1() {
 				.register();
 	}
 
+	@Deprecated(since = "7")
 	public void sha2() {
 		functionRegistry.namedDescriptorBuilder( "sha2" )
 				.setInvariantType(stringType)
@@ -2337,6 +2358,7 @@ public void sha2() {
 				.register();
 	}
 
+	@Deprecated(since = "7")
 	public void sha() {
 		functionRegistry.namedDescriptorBuilder( "sha" )
 				.setInvariantType(stringType)
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/FunctionTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/query/hql/FunctionTests.java
@@ -15,6 +15,7 @@
 import org.hibernate.dialect.DB2Dialect;
 import org.hibernate.community.dialect.DerbyDialect;
 import org.hibernate.dialect.H2Dialect;
+import org.hibernate.dialect.HANADialect;
 import org.hibernate.dialect.HSQLDialect;
 import org.hibernate.dialect.MariaDBDialect;
 import org.hibernate.dialect.MySQLDialect;
@@ -47,6 +48,8 @@
 
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.security.MessageDigest;
+import java.security.NoSuchAlgorithmException;
 import java.sql.Time;
 import java.sql.Timestamp;
 import java.time.Duration;
@@ -2596,4 +2599,25 @@ public void testCtidColumnFunction(SessionFactoryScope scope) {
 					.getSingleResultOrNull();
 		});
 	}
+
+	@Test
+	@RequiresDialect(PostgreSQLDialect.class)
+	@RequiresDialect(MySQLDialect.class)
+	@RequiresDialect(OracleDialect.class)
+	@RequiresDialect(DB2Dialect.class)
+	@RequiresDialect(SQLServerDialect.class)
+	@RequiresDialect(H2Dialect.class)
+	@RequiresDialect(HANADialect.class)
+	@RequiresDialect(CockroachDialect.class)
+	public void testSha256Function(SessionFactoryScope scope) {
+		scope.inTransaction(s -> {
+			byte[] bytes = s.createSelectionQuery("select sha('hello')", byte[].class).getSingleResult();
+			try {
+				assertArrayEquals( MessageDigest.getInstance( "SHA-256" ).digest("hello".getBytes()), bytes );
+			}
+			catch (NoSuchAlgorithmException e) {
+				throw new RuntimeException( e );
+			}
+		});
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -452,6 +452,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`452`	`452`
`453`	`453`	`functionFactory.unnest_db2( getMaximumSeriesSize() );`
`454`	`454`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, true );`
	`455`	`+`
	`456`	`+ functionFactory.sha( "hash(?1, 2)" );`
	`457`	`+ functionFactory.md5( "hash(?1, 0)" );`
`455`	`458`	`}`
`456`	`459`
`457`	`460`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -517,6 +517,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`517`	`517`
`518`	`518`	`// functionFactory.xmlextract();`
`519`	`519`	`functionFactory.generateSeries_hana( getMaximumSeriesSize() );`
	`520`	`+`
	`521`	`+ functionFactory.sha( "hash_sha256(?1)" );`
	`522`	`+ functionFactory.md5( "hash_md5(?1)" );`
`520`	`523`	`}`
`521`	`524`
`522`	`525`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -440,6 +440,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`440`	`440`	`functionFactory.unnest_oracle();`
`441`	`441`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), true, false );`
`442`	`442`	`functionFactory.jsonTable_oracle();`
	`443`	`+`
	`444`	`+ functionFactory.sha( "standard_hash(?1, 'SHA256')" );`
	`445`	`+ functionFactory.md5( "standard_hash(?1, 'MD5')" );`
`443`	`446`	`}`
`444`	`447`
`445`	`448`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -487,6 +487,9 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`487`	`487`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );`
`488`	`488`	`}`
`489`	`489`	`}`
	`490`	`+`
	`491`	`+ functionFactory.sha( "hashbytes('SHA2_256', ?1)" );`
	`492`	`+ functionFactory.md5( "hashbytes('MD5', ?1)" );`
`490`	`493`	`}`
`491`	`494`
`492`	`495`	`/**`