HHH-18496 Add support for JSON functions #8793

beikov · 2024-08-17T01:12:27Z

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.

https://hibernate.atlassian.net/browse/HHH-18496

hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonValueFunction.java

+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		if ( arguments.errorBehavior() != null ) {
+			throw new QueryException( "Can't emulate on error clause on H2" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonValueFunction.java

+			jsonPath = walker.getLiteralValue( (Expression) arguments.jsonPath() );
+		}
+		catch (Exception ex) {
+			throw new QueryException( "H2 json_value only support literal json paths, but got " + arguments.jsonPath() );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/JsonPathHelper.java

...rnate-core/src/main/java/org/hibernate/query/sqm/tree/expression/SqmJsonValueExpression.java

hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonValueTest.java

hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonValueFunction.java

+			throw new QueryException( "Can't emulate on error clause on H2" );
+		}
+		if ( arguments.emptyBehavior() == JsonValueEmptyBehavior.ERROR ) {
+			throw new QueryException( "Can't emulate error on empty clause on H2" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/MariaDBJsonValueFunction.java

+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		if ( arguments.errorBehavior() != null && arguments.errorBehavior() != JsonValueErrorBehavior.NULL ) {
+			throw new QueryException( "Can't emulate on error clause on MariaDB" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/MariaDBJsonValueFunction.java

+			throw new QueryException( "Can't emulate on error clause on MariaDB" );
+		}
+		if ( arguments.emptyBehavior() != null && arguments.emptyBehavior() != JsonValueEmptyBehavior.NULL ) {
+			throw new QueryException( "Can't emulate on empty clause on MariaDB" );


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonValueTest.java

+		scope.inSession( em -> {
+			try {
+				//tag::hql-json-value-on-error-example[]
+				em.createQuery( "select json_value('invalidJson', '$.theInt' error on error) from EntityWithJson e")


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonValueTest.java

+		scope.inSession( em -> {
+			try {
+				//tag::hql-json-value-on-empty-example[]
+				em.createQuery("select json_value(e.json, '$.nonExisting' error on empty error on error) from EntityWithJson e" )


...ate-core/src/main/java/org/hibernate/dialect/function/json/CockroachDBJsonValueFunction.java

+			SqlAstTranslator<?> walker) {
+		// jsonb_path_query_first errors by default
+		if ( arguments.errorBehavior() != null && arguments.errorBehavior() != JsonValueErrorBehavior.ERROR ) {
+			throw new QueryException( "Can't emulate on error clause on CockroachDB" );


...ate-core/src/main/java/org/hibernate/dialect/function/json/CockroachDBJsonValueFunction.java

+			throw new QueryException( "Can't emulate on error clause on CockroachDB" );
+		}
+		if ( arguments.emptyBehavior() != null && arguments.emptyBehavior() != JsonValueEmptyBehavior.NULL ) {
+			throw new QueryException( "Can't emulate on empty clause on CockroachDB" );


...ate-core/src/main/java/org/hibernate/dialect/function/json/CockroachDBJsonValueFunction.java

+			jsonPath = walker.getLiteralValue( arguments.jsonPath() );
+		}
+		catch (Exception ex) {
+			throw new QueryException( "CockroachDB json_value only support literal json paths, but got " + arguments.jsonPath() );


...rnate-core/src/main/java/org/hibernate/query/sqm/tree/expression/SqmJsonValueExpression.java

hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonArrayTest.java

+	public void testSimple(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			//tag::hql-json-array-example[]
+			em.createQuery( "select json_array('val1', 'val2'), json_array(1, false, 'val')" ).getResultList();


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonArrayTest.java

+	public void testNullClause(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			//tag::hql-json-array-on-null-example[]
+			em.createQuery("select json_array(null, 1 null on null)" ).getResultList();


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonArrayTest.java

+	@Test
+	public void testAbsentOnNull(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			em.createQuery("select json_array(null, 1 absent on null)" ).getResultList();


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonObjectTest.java

+	public void testSimple(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			//tag::hql-json-object-example[]
+			em.createQuery( "select json_object('key', 'value'), json_object(KEY 'key1' VALUE 'value1', 'key2' VALUE 'value2', 'key3': 'value3')" ).getResultList();


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonObjectTest.java

+	@Test
+	public void testNullClause(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			em.createQuery("select json_object('key': null null on null)" ).getResultList();


hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonObjectTest.java

+	public void testAbsentOnNull(SessionFactoryScope scope) {
+		scope.inSession( em -> {
+			//tag::hql-json-object-on-null-example[]
+			em.createQuery("select json_object('key': null absent on null)" ).getResultList();


...ate-core/src/main/java/org/hibernate/dialect/function/json/CockroachDBJsonValueFunction.java

+				final String parameterName = ( (JsonPathHelper.JsonParameterIndexAccess) jsonPathElement ).parameterName();
+				final Expression expression = jsonPathPassingClause.getPassingExpressions().get( parameterName );
+				if ( expression == null ) {
+					throw new QueryException( "JSON path [" + jsonPath + "] uses parameter [" + parameterName + "] that is not passed" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonExistsFunction.java

+			SqlAstTranslator<?> walker) {
+		// Json dereference errors by default if the JSON is invalid
+		if ( arguments.errorBehavior() != null && arguments.errorBehavior() != JsonExistsErrorBehavior.ERROR ) {
+			throw new QueryException( "Can't emulate on error clause on H2" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonExistsFunction.java

+			jsonPath = walker.getLiteralValue( arguments.jsonPath() );
+		}
+		catch (Exception ex) {
+			throw new QueryException( "H2 json_value only support literal json paths, but got " + arguments.jsonPath() );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/H2JsonValueFunction.java

+				final String parameterName = ( (JsonPathHelper.JsonParameterIndexAccess) jsonPathElement ).parameterName();
+				final Expression expression = passingClause.getPassingExpressions().get( parameterName );
+				if ( expression == null ) {
+					throw new QueryException( "JSON path [" + jsonPath + "] uses parameter [" + parameterName + "] that is not passed" );


hibernate-core/src/main/java/org/hibernate/dialect/function/json/JsonExistsFunction.java

hibernate-core/src/main/java/org/hibernate/dialect/function/json/JsonPathHelper.java

+		assert jsonPath.charAt( bracketStartIndex ) == '[';
+		final int bracketEndIndex = jsonPath.lastIndexOf( ']', endIndex );
+		if ( bracketEndIndex < bracketStartIndex ) {
+			throw new QueryException( "Can't emulate non-simple json path expression: " + jsonPath );


...nate-core/src/main/java/org/hibernate/dialect/function/json/SQLServerJsonExistsFunction.java

+			ReturnableType<?> returnType,
+			SqlAstTranslator<?> walker) {
+		if ( arguments.errorBehavior() == JsonExistsErrorBehavior.TRUE ) {
+			throw new QueryException( "Can't emulate json_exists(... true on error) on SQL Server" );


...nate-core/src/main/java/org/hibernate/query/sqm/tree/expression/SqmJsonExistsExpression.java

hibernate-core/src/test/java/org/hibernate/orm/test/function/json/JsonExistsTest.java

+		scope.inSession( em -> {
+			try {
+				//tag::hql-json-exists-on-error-example[]
+				em.createQuery( "select json_exists('invalidJson', '$.theInt' error on error) from EntityWithJson e")


github-advanced-security

CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

beikov · 2024-09-18T14:10:50Z

Superseded by #8979

github-advanced-security bot found potential problems Aug 17, 2024

View reviewed changes

beikov added cockroachdb hana labels Aug 17, 2024

beikov force-pushed the HHH-18496 branch from fa71812 to 68b28ae Compare August 17, 2024 13:31

github-advanced-security bot found potential problems Aug 17, 2024

View reviewed changes

beikov force-pushed the HHH-18496 branch from 68b28ae to 5df7bfc Compare August 17, 2024 15:06

github-advanced-security bot found potential problems Aug 17, 2024

View reviewed changes

beikov removed cockroachdb hana labels Aug 19, 2024

beikov changed the title ~~HHH-18496 Add json_value function~~ HHH-18496 Add support for JSON functions Aug 19, 2024

github-advanced-security bot found potential problems Aug 19, 2024

View reviewed changes

beikov force-pushed the HHH-18496 branch 2 times, most recently from e0417d5 to 4654f88 Compare August 22, 2024 13:24

github-advanced-security bot found potential problems Aug 22, 2024

View reviewed changes

beikov force-pushed the HHH-18496 branch from 4654f88 to 44e6c3f Compare September 9, 2024 17:09

github-advanced-security bot found potential problems Sep 9, 2024

View reviewed changes

beikov force-pushed the HHH-18496 branch 3 times, most recently from 97e50cd to 0a4bbbe Compare September 11, 2024 08:20

beikov added cockroachdb hana labels Sep 11, 2024

beikov force-pushed the HHH-18496 branch 3 times, most recently from a4db12b to 9a6ab64 Compare September 12, 2024 05:47

beikov added 6 commits September 16, 2024 10:16

HHH-18496 Add json_value function

9e7095b

HHH-18496 Add json_object and json_array functions

47ea45e

HHH-18496 Add json_exists and support the passing clause

e8a7206

HHH-18496 Add json_query

1a20c47

HHH-18496 Add json_arrayagg

1bd869f

HHH-18496 Add json_objectagg

286d696

beikov added 2 commits September 16, 2024 10:16

HHH-18496 Hide JSON functions behind feature flag

7921eeb

HHH-18496 Fixup some CI issues

5a09e99

beikov force-pushed the HHH-18496 branch from 9a6ab64 to 5a09e99 Compare September 16, 2024 08:31

beikov closed this Sep 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HHH-18496 Add support for JSON functions #8793

HHH-18496 Add support for JSON functions #8793

beikov commented Aug 17, 2024 •

edited by hibernate-github-bot bot

Loading

github-advanced-security bot left a comment

beikov commented Sep 18, 2024

HHH-18496 Add support for JSON functions #8793

HHH-18496 Add support for JSON functions #8793

Conversation

beikov commented Aug 17, 2024 • edited by hibernate-github-bot bot Loading

github-advanced-security bot left a comment

Choose a reason for hiding this comment

beikov commented Sep 18, 2024

beikov commented Aug 17, 2024 •

edited by hibernate-github-bot bot

Loading