HHH-18892 add sha() function to HQL

gavinking · gavinking · commit 80ddafcc2dd7 · 2024-12-03T11:30:31.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;
@@ -64,6 +65,7 @@
 import org.hibernate.sql.exec.spi.JdbcOperation;
 import org.hibernate.tool.schema.extract.spi.ColumnTypeInformation;
 import org.hibernate.type.JavaObjectType;
+import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.jdbc.JdbcType;
 import org.hibernate.type.descriptor.jdbc.ObjectNullAsBinaryTypeJdbcType;
 import org.hibernate.type.descriptor.jdbc.UUIDJdbcType;
@@ -503,6 +505,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				new PostgreSQLTruncFunction( true, functionContributions.getTypeConfiguration() )
 		);
 		functionContributions.getFunctionRegistry().registerAlternateKey( "truncate", "trunc" );
+
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "sha256(?1)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	@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,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 		functionFactory.unnest_db2( getMaximumSeriesSize() );
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, true );
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "hash(?1, 2)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
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;
@@ -65,6 +66,7 @@
 import org.hibernate.sql.model.internal.OptionalTableUpdate;
 import org.hibernate.tool.schema.extract.internal.SequenceInformationExtractorLegacyImpl;
 import org.hibernate.tool.schema.extract.spi.SequenceInformationExtractor;
+import org.hibernate.type.StandardBasicTypes;
 import org.hibernate.type.descriptor.jdbc.EnumJdbcType;
 import org.hibernate.type.descriptor.jdbc.JdbcType;
 import org.hibernate.type.descriptor.jdbc.OrdinalEnumJdbcType;
@@ -368,6 +370,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.unnest_h2( getMaximumArraySize() );
 		functionFactory.generateSeries_h2( getMaximumSeriesSize() );
 		functionFactory.jsonTable_h2( getMaximumArraySize() );
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "hash('SHA-256', ?1)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
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,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 
 //		functionFactory.xmlextract();
 		functionFactory.generateSeries_hana( getMaximumSeriesSize() );
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "hash_sha256(?1)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/MySQLDialect.java
@@ -688,6 +688,15 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		if ( supportsRecursiveCTE() ) {
 			functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );
 		}
+
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "unhex(sha2(?1, 256))" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
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,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.unnest_oracle();
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), true, false );
 		functionFactory.jsonTable_oracle();
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "standard_hash(?1, 'SHA256')" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQLDialect.java
@@ -67,6 +67,7 @@
 import org.hibernate.query.sqm.mutation.internal.cte.CteMutationStrategy;
 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.query.sqm.produce.function.StandardFunctionArgumentTypeResolvers;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.sql.ast.SqlAstTranslator;
@@ -83,6 +84,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 +692,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			functionFactory.unnest_postgresql();
 		}
 		functionFactory.generateSeries( null, "ordinality", false );
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "sha256(?1)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	@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
@@ -66,6 +66,7 @@
 import org.hibernate.query.sqm.IntervalType;
 import org.hibernate.query.common.TemporalUnit;
 import org.hibernate.query.sqm.TrimSpec;
+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;
@@ -487,6 +488,14 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );
 			}
 		}
+
+		functionContributions.getFunctionRegistry()
+				.patternDescriptorBuilder( "sha", "hashbytes('SHA2_256', ?1)" )
+				.setExactArgumentCount( 1 )
+				.setParameterTypes( FunctionParameterType.STRING )
+				.setInvariantType( functionContributions.getTypeConfiguration()
+						.getBasicTypeRegistry().resolve( StandardBasicTypes.BINARY) )
+				.register();
 	}
 
 	/**
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 {
+				assertEquals( MessageDigest.getInstance( "SHA-256" ).digest("hello".getBytes()), bytes );
+			}
+			catch (NoSuchAlgorithmException e) {
+				throw new RuntimeException( e );
+			}
+		});
+	}
 }
