HHH-18892 add hex() function

gavinking · gavinking · commit 1a5db3bf4251 · 2024-12-03T23:16:28.000+01:00
diff --git a/documentation/src/main/asciidoc/querylanguage/Expressions.adoc b/documentation/src/main/asciidoc/querylanguage/Expressions.adoc
@@ -841,6 +841,7 @@ Naturally, there are a good number of functions for working with strings.
 | `replace()` | Replace every occurrence of a pattern in a string | `replace(str, patt, rep)` | ✔ / ✖
 | `repeat()` | Concatenate a string with itself multiple times | `repeat(str, times)` | ✖ / ✖
 | `collate()` | Select a collation | `collate(p.name as collation)` | ✖ / ✖
+| `hex()` | Encode a binary value as a hexadecimal string | `hex(image.bytes)` | ✖ / ✖
 |===
 
 Let's take a closer look at just some of these.
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/CockroachDialect.java
@@ -503,6 +503,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		);
 		functionContributions.getFunctionRegistry().registerAlternateKey( "truncate", "trunc" );
 
+		functionFactory.hex( "encode(?1, 'hex')" );
 		functionFactory.sha( "digest(?1, 'sha256')" );
 		functionFactory.md5( "digest(?1, 'md5')" );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
@@ -453,6 +453,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.unnest_db2( getMaximumSeriesSize() );
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, true );
 
+		functionFactory.hex( "hex(?1)" );
 		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
@@ -369,6 +369,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.generateSeries_h2( getMaximumSeriesSize() );
 		functionFactory.jsonTable_h2( getMaximumArraySize() );
 
+		functionFactory.hex( "rawtohex(?1)" );
 		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
@@ -518,6 +518,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 //		functionFactory.xmlextract();
 		functionFactory.generateSeries_hana( getMaximumSeriesSize() );
 
+		functionFactory.hex( "to_hex(?1)" );
 		functionFactory.sha( "hash_sha256(?1)" );
 		functionFactory.md5( "hash_md5(?1)" );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java
@@ -222,6 +222,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				functionContributions.getTypeConfiguration(),
 				SqlAstNodeRenderingMode.NO_PLAIN_PARAMETER
 		) );
+
+		functionFactory.hex( "hex(?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
@@ -687,6 +687,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );
 		}
 
+		functionFactory.hex( "hex(?1)" );
 		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
@@ -441,6 +441,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.generateSeries_recursive( getMaximumSeriesSize(), true, false );
 		functionFactory.jsonTable_oracle();
 
+		functionFactory.hex( "rawtohex(?1)" );
 		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
@@ -690,6 +690,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		}
 		functionFactory.generateSeries( null, "ordinality", false );
 
+		functionFactory.hex( "encode(?1, 'hex')" );
 		functionFactory.sha( "sha256(?1)" );
 		functionFactory.md5( "decode(md5(?1), 'hex')" );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java
@@ -488,6 +488,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 			}
 		}
 
+		functionFactory.hex( "convert(varchar(MAX), ?1, 2)" );
 		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
@@ -389,7 +389,8 @@ public void median_percentileCont(boolean over) {
 	}
 
 	/**
-	 * CockroachDB lacks implicit casting: https://github.com/cockroachdb/cockroach/issues/89965
+	 * CockroachDB lacks
+	 * <a href="https://github.com/cockroachdb/cockroach/issues/89965">implicit casting</a>
 	 */
 	public void median_percentileCont_castDouble() {
 		functionRegistry.patternDescriptorBuilder(
@@ -2325,6 +2326,14 @@ public void crc32() {
 				.register();
 	}
 
+	public void hex(String pattern) {
+		functionRegistry.patternDescriptorBuilder( "hex", pattern )
+				.setInvariantType(stringType)
+				.setParameterTypes( BINARY )
+				.setExactArgumentCount( 1 )
+				.register();
+	}
+
 	public void md5(String pattern) {
 		functionRegistry.patternDescriptorBuilder( "md5", pattern )
 				.setInvariantType(binaryType)
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/function/ArgumentTypesValidator.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/function/ArgumentTypesValidator.java
@@ -248,6 +248,7 @@ private static boolean isCompatible(FunctionParameterType type, JdbcType jdbcTyp
 			case TEMPORAL -> jdbcType.isTemporal();
 			case DATE -> jdbcType.hasDatePart();
 			case TIME -> jdbcType.hasTimePart();
+			case BINARY -> jdbcType.isBinary();
 			case SPATIAL -> jdbcType.isSpatial();
 			case JSON -> jdbcType.isJson();
 			case IMPLICIT_JSON -> jdbcType.isImplicitJson();
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/function/FunctionParameterType.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/function/FunctionParameterType.java
@@ -48,6 +48,10 @@ public enum FunctionParameterType {
 	 * a logical expression (predicate)
 	 */
 	BOOLEAN,
+	/**
+	 * @see org.hibernate.type.SqlTypes#isBinaryType(int)
+	 */
+	BINARY,
 	/**
 	 * Indicates a parameter that accepts any type
 	 */
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
@@ -23,6 +23,7 @@
 import org.hibernate.dialect.PostgreSQLDialect;
 import org.hibernate.dialect.PostgresPlusDialect;
 import org.hibernate.dialect.SQLServerDialect;
+import org.hibernate.dialect.SybaseASEDialect;
 import org.hibernate.dialect.SybaseDialect;
 import org.hibernate.dialect.TiDBDialect;
 import org.hibernate.query.sqm.produce.function.FunctionArgumentException;
@@ -62,6 +63,7 @@
 import java.time.temporal.ChronoUnit;
 import java.util.Date;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.UUID;
 
@@ -2627,4 +2629,14 @@ public void testSha256Function(SessionFactoryScope scope) {
 			}
 		});
 	}
+
+	@Test
+	@SkipForDialect(dialectClass = SybaseASEDialect.class)
+	public void testHexFunction(SessionFactoryScope scope) {
+		scope.inTransaction(s -> {
+			assertEquals( "DEADBEEF",
+					s.createSelectionQuery("select hex({0xDE, 0xAD, 0xBE, 0xEF})", String.class)
+							.getSingleResult().toUpperCase( Locale.ROOT ) );
+		});
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -503,6 +503,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`503`	`503`	`);`
`504`	`504`	`functionContributions.getFunctionRegistry().registerAlternateKey( "truncate", "trunc" );`
`505`	`505`
	`506`	`+ functionFactory.hex( "encode(?1, 'hex')" );`
`506`	`507`	`functionFactory.sha( "digest(?1, 'sha256')" );`
`507`	`508`	`functionFactory.md5( "digest(?1, 'md5')" );`
`508`	`509`	`}`
Original file line number	Diff line number	Diff line change
`@@ -453,6 +453,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`453`	`453`	`functionFactory.unnest_db2( getMaximumSeriesSize() );`
`454`	`454`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, true );`
`455`	`455`
	`456`	`+ functionFactory.hex( "hex(?1)" );`
`456`	`457`	`functionFactory.sha( "hash(?1, 2)" );`
`457`	`458`	`functionFactory.md5( "hash(?1, 0)" );`
`458`	`459`	`}`
Original file line number	Diff line number	Diff line change
`@@ -369,6 +369,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`369`	`369`	`functionFactory.generateSeries_h2( getMaximumSeriesSize() );`
`370`	`370`	`functionFactory.jsonTable_h2( getMaximumArraySize() );`
`371`	`371`
	`372`	`+ functionFactory.hex( "rawtohex(?1)" );`
`372`	`373`	`functionFactory.sha( "hash('SHA-256', ?1)" );`
`373`	`374`	`functionFactory.md5( "hash('MD5', ?1)" );`
`374`	`375`	`}`
Original file line number	Diff line number	Diff line change
`@@ -518,6 +518,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`518`	`518`	`// functionFactory.xmlextract();`
`519`	`519`	`functionFactory.generateSeries_hana( getMaximumSeriesSize() );`
`520`	`520`
	`521`	`+ functionFactory.hex( "to_hex(?1)" );`
`521`	`522`	`functionFactory.sha( "hash_sha256(?1)" );`
`522`	`523`	`functionFactory.md5( "hash_md5(?1)" );`
`523`	`524`	`}`
Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,8 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`222`	`222`	`functionContributions.getTypeConfiguration(),`
`223`	`223`	`SqlAstNodeRenderingMode.NO_PLAIN_PARAMETER`
`224`	`224`	`) );`
	`225`	`+`
	`226`	`+ functionFactory.hex( "hex(?1)" );`
`225`	`227`	`}`
`226`	`228`
`227`	`229`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -687,6 +687,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`687`	`687`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), false, false );`
`688`	`688`	`}`
`689`	`689`
	`690`	`+ functionFactory.hex( "hex(?1)" );`
`690`	`691`	`functionFactory.sha( "unhex(sha2(?1, 256))" );`
`691`	`692`	`functionFactory.md5( "unhex(md5(?1))" );`
`692`	`693`	`}`
Original file line number	Diff line number	Diff line change
`@@ -441,6 +441,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`441`	`441`	`functionFactory.generateSeries_recursive( getMaximumSeriesSize(), true, false );`
`442`	`442`	`functionFactory.jsonTable_oracle();`
`443`	`443`
	`444`	`+ functionFactory.hex( "rawtohex(?1)" );`
`444`	`445`	`functionFactory.sha( "standard_hash(?1, 'SHA256')" );`
`445`	`446`	`functionFactory.md5( "standard_hash(?1, 'MD5')" );`
`446`	`447`	`}`
Original file line number	Diff line number	Diff line change
`@@ -690,6 +690,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`690`	`690`	`}`
`691`	`691`	`functionFactory.generateSeries( null, "ordinality", false );`
`692`	`692`
	`693`	`+ functionFactory.hex( "encode(?1, 'hex')" );`
`693`	`694`	`functionFactory.sha( "sha256(?1)" );`
`694`	`695`	`functionFactory.md5( "decode(md5(?1), 'hex')" );`
`695`	`696`	`}`
Original file line number	Diff line number	Diff line change
`@@ -488,6 +488,7 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio`
`488`	`488`	`}`
`489`	`489`	`}`
`490`	`490`
	`491`	`+ functionFactory.hex( "convert(varchar(MAX), ?1, 2)" );`
`491`	`492`	`functionFactory.sha( "hashbytes('SHA2_256', ?1)" );`
`492`	`493`	`functionFactory.md5( "hashbytes('MD5', ?1)" );`
`493`	`494`	`}`