introduce standardized POWER() function

hibernate · May 8, 2019 · b8d1f06 · b8d1f06
1 parent 946b25a
commit b8d1f06
Show file tree

Hide file tree

Showing 25 changed files with 211 additions and 32 deletions.
diff --git a/hibernate-core/src/main/antlr/org/hibernate/query/hql/internal/HqlLexer.g4 b/hibernate-core/src/main/antlr/org/hibernate/query/hql/internal/HqlLexer.g4
@@ -196,6 +196,7 @@ OR					: [oO] [rR];
 ORDER				: [oO] [rR] [dD] [eE] [rR];
 OUTER				: [oO] [uU] [tT] [eE] [rR];
 POSITION			: [pP] [oO] [sS] [iI] [tT] [iI] [oO] [nN];
+POWER				: [pP] [oO] [wW] [eE] [rR];
 REPLACE             : [rR] [eE] [pP] [lL] [aA] [cC] [eE];
 RIGHT				: [rR] [iI] [gG] [hH] [tT];
 SECOND				: [sS] [eE] [cC] [oO] [nN] [dD];

diff --git a/hibernate-core/src/main/antlr/org/hibernate/query/hql/internal/HqlParser.g4 b/hibernate-core/src/main/antlr/org/hibernate/query/hql/internal/HqlParser.g4
@@ -582,6 +582,7 @@ standardFunction
 	|   lnFunction
 	|   expFunction
 	|	modFunction
+	|   powerFunction
 	|   strFunction
 	|	currentDateFunction
 	|	currentTimeFunction
@@ -703,14 +704,22 @@ expFunction
 	:	EXP LEFT_PAREN expression RIGHT_PAREN
 	;
 
+powerFunction
+	:	POWER LEFT_PAREN powerBaseArgument COMMA powerPowerArgument RIGHT_PAREN
+	;
+
+powerBaseArgument
+	: expression
+	;
+
+powerPowerArgument
+	: expression
+	;
+
 modFunction
 	:	MOD LEFT_PAREN modDividendArgument COMMA modDivisorArgument RIGHT_PAREN
 	;
 
-strFunction
-    :   STR LEFT_PAREN expression RIGHT_PAREN
-    ;
-
 modDividendArgument
 	: expression
 	;
@@ -719,6 +728,10 @@ modDivisorArgument
 	: expression
 	;
 
+strFunction
+    :   STR LEFT_PAREN expression RIGHT_PAREN
+    ;
+
 currentDateFunction
 	: CURRENT_DATE (LEFT_PAREN RIGHT_PAREN)?
 	;
@@ -840,6 +853,7 @@ identifier
 	| ORDER
 	| OUTER
 	| POSITION
+	| POWER
 	| REPLACE
 	| RIGHT
 	| SELECT

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/AbstractHANADialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/AbstractHANADialect.java
@@ -339,7 +339,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 		queryEngine.getSqmFunctionRegistry().registerNamed( "least" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "log", StandardSpiBasicTypes.DOUBLE );
 
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "round" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "sign", StandardSpiBasicTypes.INTEGER );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "sin", StandardSpiBasicTypes.DOUBLE );

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/CUBRIDDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/CUBRIDDialect.java
@@ -179,7 +179,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 
 		queryEngine.getSqmFunctionRegistry().registerNamed( "substr", StandardSpiBasicTypes.STRING );
 
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "stddev" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "variance" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "trunc" );

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Cache71Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Cache71Dialect.java
@@ -344,7 +344,6 @@ protected void commonFunctionRegistrations(QueryEngine queryEngine) {
 		queryEngine.getSqmFunctionRegistry().registerVarArgs( "%pattern", StandardSpiBasicTypes.STRING, "", "%pattern", "" );
 		queryEngine.getSqmFunctionRegistry().wrapInJdbcEscape( "pi", queryEngine.getSqmFunctionRegistry().registerNamed( "pi", StandardSpiBasicTypes.DOUBLE ) );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "$piece", StandardSpiBasicTypes.STRING );
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power", StandardSpiBasicTypes.STRING );
 		queryEngine.getSqmFunctionRegistry().wrapInJdbcEscape( "quarter", queryEngine.getSqmFunctionRegistry().registerNamed( "quarter", StandardSpiBasicTypes.INTEGER ) );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "repeat", StandardSpiBasicTypes.STRING );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "replicate", StandardSpiBasicTypes.STRING );

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java
@@ -273,6 +273,7 @@ protected Dialect() {
 	 * 	    * character_length
 	 *      * ln
 	 *      * exp
+	 *      * power
 	 *
 	 * And several additional "standard" functions:
 	 *

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/H2Dialect.java
@@ -208,11 +208,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 				.setInvariantType( StandardSpiBasicTypes.DOUBLE )
 				.register();
 
-		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "power" )
-				.setExactArgumentCount( 2 )
-				.setInvariantType( StandardSpiBasicTypes.DOUBLE )
-				.register();
-
 		CommonFunctionFactory.radians( queryEngine );
 
 		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "rand" )

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/IngresDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/IngresDialect.java
@@ -286,11 +286,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 		// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 		// Numeric functions
 
-		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "power" )
-				.setExactArgumentCount( 2 )
-				.setInvariantType( StandardSpiBasicTypes.DOUBLE )
-				.register();
-
 		queryEngine.getSqmFunctionRegistry().noArgsBuilder( "random" )
 				.setUseParenthesesWhenNoArgs( true )
 				.setInvariantType( StandardSpiBasicTypes.LONG )

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/MimerSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/MimerSQLDialect.java
@@ -100,7 +100,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 		queryEngine.getSqmFunctionRegistry().registerNamed( "dtan", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "tan", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "dpower" );
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power" );
 
 		queryEngine.getSqmFunctionRegistry().registerNamed( "date", StandardSpiBasicTypes.DATE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "dayofweek", StandardSpiBasicTypes.INTEGER );

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Oracle8iDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Oracle8iDialect.java
@@ -277,10 +277,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 				.setExactArgumentCount( 2 )
 				.register();
 		CommonFunctionFactory.log( queryEngine );
-		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "power" )
-				.setInvariantType( StandardSpiBasicTypes.FLOAT )
-				.setExactArgumentCount( 2 )
-				.register();
 
 		// Multi-param date dialect functions...
 		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "add_months" )

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Oracle9Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Oracle9Dialect.java
@@ -226,10 +226,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 				.setExactArgumentCount( 1 )
 				.register();
 		CommonFunctionFactory.log( queryEngine );
-		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "power" )
-				.setInvariantType( StandardSpiBasicTypes.FLOAT )
-				.setExactArgumentCount( 2 )
-				.register();
 
 		// Multi-param date dialect functions...
 		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "add_months" )

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQL81Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/PostgreSQL81Dialect.java
@@ -273,10 +273,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 				.setExactArgumentCount( 2 )
 				.register();
 		CommonFunctionFactory.log( queryEngine );
-		queryEngine.getSqmFunctionRegistry().namedTemplateBuilder( "power" )
-				.setInvariantType( StandardSpiBasicTypes.FLOAT )
-				.setExactArgumentCount( 2 )
-				.register();
 	}
 
 	@Override

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/RDMSOS2200Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/RDMSOS2200Dialect.java
@@ -243,7 +243,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 
 		queryEngine.getSqmFunctionRegistry().registerNamed( "atan2", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "nvl" );
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power", StandardSpiBasicTypes.DOUBLE );
 	}
 
 

diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/SAPDBDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SAPDBDialect.java
@@ -65,7 +65,6 @@ public void initializeFunctionRegistry(QueryEngine queryEngine) {
 
 		queryEngine.getSqmFunctionRegistry().registerNamed( "log", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNoArgs( "pi", StandardSpiBasicTypes.DOUBLE );
-		queryEngine.getSqmFunctionRegistry().registerNamed( "power" );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "acos", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "asin", StandardSpiBasicTypes.DOUBLE );
 		queryEngine.getSqmFunctionRegistry().registerNamed( "atan", StandardSpiBasicTypes.DOUBLE );

diff --git a/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java
@@ -1876,6 +1876,22 @@ public SqmExpression visitModFunction(HqlParser.ModFunctionContext ctx) {
 		);
 	}
 
+	@Override
+	public SqmExpression visitPowerFunction(HqlParser.PowerFunctionContext ctx) {
+		//noinspection unchecked
+		return generateTwoArgFunction(
+				SqmModFunction.NAME,
+				(sqmFunctionTemplate, arg1, arg2) -> sqmFunctionTemplate.makeSqmFunctionExpression(
+						asList( arg1, arg2 ),
+						(AllowableFunctionReturnType) arg1.getExpressableType(),
+						creationContext.getQueryEngine()
+				),
+				(arg1, arg2) -> new SqmModFunction( arg1, arg2, (AllowableFunctionReturnType) arg1.getExpressableType(), creationContext.getNodeBuilder() ),
+				ctx.powerBaseArgument().expression(),
+				ctx.powerPowerArgument().expression()
+		);
+	}
+
 	@Override
 	public SqmExpression visitSqrtFunction(HqlParser.SqrtFunctionContext ctx) {
 		//noinspection unchecked

diff --git a/...rnate-core/src/main/java/org/hibernate/query/sqm/consume/spi/BaseSemanticQueryWalker.java b/...rnate-core/src/main/java/org/hibernate/query/sqm/consume/spi/BaseSemanticQueryWalker.java
@@ -63,6 +63,7 @@
 import org.hibernate.query.sqm.tree.expression.function.SqmMinFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmModFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmNullifFunction;
+import org.hibernate.query.sqm.tree.expression.function.SqmPowerFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmReplaceFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmSqrtFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmStrFunction;
@@ -590,6 +591,11 @@ public T visitModFunction(SqmModFunction function) {
 		return (T) function;
 	}
 
+	@Override
+	public T visitPowerFunction(SqmPowerFunction function) {
+		return (T) function;
+	}
+
 	@Override
 	public T visitNullifFunction(SqmNullifFunction expression) {
 		return (T) expression;

diff --git a/...nate-core/src/main/java/org/hibernate/query/sqm/consume/spi/BaseSqmToSqlAstConverter.java b/...nate-core/src/main/java/org/hibernate/query/sqm/consume/spi/BaseSqmToSqlAstConverter.java
@@ -76,6 +76,7 @@
 import org.hibernate.query.sqm.tree.expression.function.SqmMinFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmModFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmNullifFunction;
+import org.hibernate.query.sqm.tree.expression.function.SqmPowerFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmReplaceFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmSqrtFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmStrFunction;
@@ -153,6 +154,7 @@
 import org.hibernate.sql.ast.tree.expression.ModFunction;
 import org.hibernate.sql.ast.tree.expression.NonStandardFunction;
 import org.hibernate.sql.ast.tree.expression.NullifFunction;
+import org.hibernate.sql.ast.tree.expression.PowerFunction;
 import org.hibernate.sql.ast.tree.expression.QueryLiteral;
 import org.hibernate.sql.ast.tree.expression.ReplaceFunction;
 import org.hibernate.sql.ast.tree.expression.SqlTuple;
@@ -1156,6 +1158,24 @@ public Object visitModFunction(SqmModFunction function) {
 		}
 	}
 
+	@Override
+	public Object visitPowerFunction(SqmPowerFunction function) {
+		shallownessStack.push( Shallowness.FUNCTION );
+
+		final Expression base = toSqlExpression( function.getBase().accept( this ) );
+		final Expression power = toSqlExpression( function.getPower().accept( this ) );
+		try {
+			return new PowerFunction(
+					base,
+					power,
+					function.getExpressableType().getSqlExpressableType()
+			);
+		}
+		finally {
+			shallownessStack.pop();
+		}
+	}
+
 	@Override
 	public Object visitSubstringFunction(SqmSubstringFunction expression) {
 		shallownessStack.push( Shallowness.FUNCTION );

diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/consume/spi/SemanticQueryWalker.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/consume/spi/SemanticQueryWalker.java
@@ -62,6 +62,7 @@
 import org.hibernate.query.sqm.tree.expression.function.SqmMinFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmModFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmNullifFunction;
+import org.hibernate.query.sqm.tree.expression.function.SqmPowerFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmReplaceFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmSqrtFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmStrFunction;
@@ -346,4 +347,6 @@ default T visitJpaCompoundSelection(SqmJpaCompoundSelection selection) {
 	T visitExpFunction(SqmExpFunction<?> tSqmExpFunction);
 
 	T visitLnFunction(SqmLnFunction<?> tSqmLnFunction);
+
+	T visitPowerFunction(SqmPowerFunction<?> tSqmPowerFunction);
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/internal/SqmTreePrinter.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/produce/internal/SqmTreePrinter.java
@@ -65,6 +65,7 @@
 import org.hibernate.query.sqm.tree.expression.function.SqmMinFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmModFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmNullifFunction;
+import org.hibernate.query.sqm.tree.expression.function.SqmPowerFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmReplaceFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmSqrtFunction;
 import org.hibernate.query.sqm.tree.expression.function.SqmStrFunction;
@@ -710,6 +711,11 @@ public Object visitModFunction(SqmModFunction sqmModFunction) {
 		return null;
 	}
 
+	@Override
+	public Object visitPowerFunction(SqmPowerFunction sqmModFunction) {
+		return null;
+	}
+
 	@Override
 	public Object visitNullifFunction(SqmNullifFunction expression) {
 		return null;

diff --git a/...core/src/main/java/org/hibernate/query/sqm/tree/expression/function/SqmPowerFunction.java b/...core/src/main/java/org/hibernate/query/sqm/tree/expression/function/SqmPowerFunction.java
@@ -0,0 +1,68 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later
+ * See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
+ */
+package org.hibernate.query.sqm.tree.expression.function;
+
+import org.hibernate.metamodel.model.domain.spi.AllowableFunctionReturnType;
+import org.hibernate.query.sqm.NodeBuilder;
+import org.hibernate.query.sqm.consume.spi.SemanticQueryWalker;
+import org.hibernate.query.sqm.tree.expression.SqmExpression;
+
+import java.util.Locale;
+
+/**
+ * @author Gavin King
+ */
+public class SqmPowerFunction<T> extends AbstractSqmFunction<T> {
+	public static final String NAME = "power";
+
+	private final SqmExpression base;
+	private final SqmExpression power;
+
+	public SqmPowerFunction(
+			SqmExpression<?> base,
+			SqmExpression<?> power,
+			AllowableFunctionReturnType<T> resultType,
+			NodeBuilder nodeBuilder) {
+		super( resultType, nodeBuilder );
+		this.base = base;
+		this.power = power;
+	}
+
+	public SqmExpression getBase() {
+		return base;
+	}
+
+	public SqmExpression getPower() {
+		return power;
+	}
+
+	@Override
+	public String getFunctionName() {
+		return NAME;
+	}
+
+	@Override
+	public boolean hasArguments() {
+		return true;
+	}
+
+	@Override
+	public <T> T accept(SemanticQueryWalker<T> walker) {
+		return walker.visitPowerFunction( this );
+	}
+
+	@Override
+	public String asLoggableText() {
+		return String.format(
+				Locale.ROOT,
+				"%s( %s, %s )",
+				NAME,
+				base.asLoggableText(),
+				power.asLoggableText()
+		);
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/consume/SqlAstPrinter.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/consume/SqlAstPrinter.java
@@ -48,6 +48,7 @@
 import org.hibernate.sql.ast.tree.expression.NonStandardFunction;
 import org.hibernate.sql.ast.tree.expression.NullifFunction;
 import org.hibernate.sql.ast.tree.expression.PositionalParameter;
+import org.hibernate.sql.ast.tree.expression.PowerFunction;
 import org.hibernate.sql.ast.tree.expression.QueryLiteral;
 import org.hibernate.sql.ast.tree.expression.ReplaceFunction;
 import org.hibernate.sql.ast.tree.expression.SqlTuple;
@@ -697,6 +698,11 @@ public void visitModFunction(ModFunction function) {
 
 	}
 
+	@Override
+	public void visitPowerFunction(PowerFunction function) {
+
+	}
+
 	@Override
 	public void visitNullifFunction(NullifFunction function) {
 

diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/consume/spi/AbstractSqlAstWalker.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/consume/spi/AbstractSqlAstWalker.java
@@ -633,6 +633,16 @@ public void visitModFunction(ModFunction function) {
 		sqlAppender.appendSql( CLOSE_PARENTHESIS );
 	}
 
+	@Override
+	@SuppressWarnings("unchecked")
+	public void visitPowerFunction(PowerFunction function) {
+		sqlAppender.appendSql( "power(" );
+		function.getBase().accept( this );
+		sqlAppender.appendSql( COMA_SEPARATOR );
+		function.getPower().accept( this );
+		sqlAppender.appendSql( CLOSE_PARENTHESIS );
+	}
+
 	@Override
 	@SuppressWarnings("unchecked")
 	public void visitSqrtFunction(SqrtFunction function) {