Support "RETURNING INTO" clause for INSERT/UPDATE/DELETE in Oracle database by radovanradic · Pull Request #3669 · micronaut-projects/micronaut-data

radovanradic · 2025-12-31T10:37:26Z

Implementation for issue #2669

…returning

dstepanov · 2026-01-16T09:03:11Z

data-model/src/main/java/io/micronaut/data/model/query/builder/sql/SqlQueryBuilder.java

Pls remove lines

…returning

Copilot

Pull request overview

Adds support for Oracle RETURNING ... INTO semantics across INSERT/UPDATE/DELETE by propagating OUT parameter metadata from query building/processing into runtime JDBC execution.

Changes:

Introduces builder-time and runtime QueryOutParameterBinding metadata and wires it through annotation processing (DataMethodQueryOutParameter) into StoredQuery.
Updates SQL builders and raw @Query parsing to generate Oracle PL/SQL blocks (BEGIN ... RETURNING ... INTO ...; END;) and capture OUT parameter ordering/types.
Extends JDBC operations to execute Oracle returning statements via CallableStatement and map OUT parameters back to entities / scalar results, with new tests.

Reviewed changes

Copilot reviewed 26 out of 26 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
data-runtime/.../QueryResultStoredQuery.java	Adds runtime OUT parameter bindings mapped from builder metadata.
data-runtime/.../DelegateStoredQuery.java	Delegates new `getOutParameterBindings()` API.
data-runtime/.../DefaultStoredQuery.java	Reads OUT parameter metadata from generated annotations.
data-runtime/.../DefaultSqlStoredQuery.java	Pass-through for OUT parameter bindings.
data-processor/.../RawQueryMethodMatcher.java	Parses Oracle `RETURNING` in raw queries and synthesizes OUT bindings/PLSQL wrapper.
data-processor/.../RepositoryTypeElementVisitor.java	Emits `DataMethodQueryOutParameter` annotations based on `QueryResult` OUT bindings.
data-model/.../StoredQuery.java	Adds new `getOutParameterBindings()` default API.
data-model/.../QueryResult.java	Supports OUT bindings on `QueryResult` with new factory overload.
data-model/.../sql/SqlQueryBuilder.java	Emits Oracle `RETURNING ... INTO` for INSERT and collects OUT binding metadata.
data-model/.../sql/AbstractSqlLikeQueryBuilder.java	Adds RETURNING visitor plumbing and Oracle RETURNING handling for UPDATE/DELETE.
data-jdbc/.../DefaultJdbcRepositoryOperations.java	Executes Oracle returning via `CallableStatement` and maps OUT params to entities/scalars.
data-jdbc/.../ColumnNameByIndexCallableResultReader.java	Adds name-based OUT param reader backed by index mapping.
data-processor tests + data-jdbc tests	Adds compilation/runtime regression tests for Oracle RETURNING behavior.
config/checkstyle/custom-suppressions.xml	Suppresses file length for SqlQueryBuilder.

...cessor/src/main/java/io/micronaut/data/processor/visitors/finders/RawQueryMethodMatcher.java

+        String cleanLower = SQL_COMMENT_PATTERN.matcher(finalQueryString).replaceAll("").trim().toLowerCase(Locale.ENGLISH);
+        boolean hasReturning = RETURNING_PATTERN.matcher(cleanLower).find();
+        if (hasReturning) {
+            Dialect dialect = matchContext.getRepositoryClass().enumValue(Repository.class, "dialect", Dialect.class)
+                .orElse(Dialect.ANSI);
+            if (dialect == Dialect.ORACLE) {
+                SourcePersistentEntity entity = persistentEntity != null ? persistentEntity : matchContext.getRootEntity();
+                int returningIdx = cleanLower.lastIndexOf("returning");


...cessor/src/main/java/io/micronaut/data/processor/visitors/finders/RawQueryMethodMatcher.java

+                }
+                return QueryResult.of("", queryParts, parameterBindings, outBindings, Map.of());


data-model/src/main/java/io/micronaut/data/model/query/builder/sql/SqlQueryBuilder.java

                        .orElse(identity.getAnnotationMetadata().stringValue(JSON_PROPERTY_ANNOTATION)
                            .orElse(identity.getName()));
+                    resultColumns.add(identityName);
+                    resultColumnTypes.add(identity.getDataType());


...ocessor/src/main/java/io/micronaut/data/processor/visitors/RepositoryTypeElementVisitor.java

+                    if (StringUtils.isNotEmpty(b.getName())) {
+                        outBuilder.member(DataMethodQueryOutParameter.META_MEMBER_NAME, b.getName());
+                    }
+                    if (b.getDataType() != null) {
+                        outBuilder.member(DataMethodQueryOutParameter.META_MEMBER_DATA_TYPE, b.getDataType());
+                    }


data-jdbc/src/main/java/io/micronaut/data/jdbc/operations/DefaultJdbcRepositoryOperations.java

+                boolean isEntityResult = preparedQuery.getResultDataType() == DataType.ENTITY;
+                if (isEntityResult) {
+                    SqlResultEntityTypeMapper mapper = getSqlResultEntityTypeMapper(preparedQuery.getPersistentEntity(), columnNames, inCount);
+                    return List.of((R) mapper.readEntity(cs));


config/checkstyle/custom-suppressions.xml


 <suppressions>
    <suppress checks="FileLength" files=".*AbstractSqlLikeQueryBuilder.*" />
+    <suppress checks="FileLength" files="SqlQueryBuilder.java" />


data-runtime/src/main/java/io/micronaut/data/runtime/query/internal/QueryResultStoredQuery.java

+            public String name() {
+                return delegate.getName();
+            }
+
+            @Override
+            public DataType dataType() {
+                return delegate.getDataType();
+            }
+
+        }
+


radovanradic · 2026-03-18T15:26:05Z

@copilot open a new pull request to apply changes based on the comments in this thread

Copilot · 2026-03-18T15:26:14Z

@radovanradic I've opened a new pull request, #3762, to work on those changes. Once the pull request is ready, I'll request review from you.

* Initial plan * Apply PR review feedback for Oracle RETURNING INTO support Co-authored-by: radovanradic <10271067+radovanradic@users.noreply.github.com> * Use DEFAULT_POSITIONAL_PARAMETER_MARKER constant and clarify assembledSql comment Co-authored-by: radovanradic <10271067+radovanradic@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: radovanradic <10271067+radovanradic@users.noreply.github.com>

sonarqubecloud · 2026-03-18T18:50:29Z

Quality Gate failed

Failed conditions
6 New Critical Issues (required ≤ 0)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

radovanradic added 16 commits December 26, 2025 19:35

Oracle returning simple attempt, to improve later

30f5852

Oracle returning simple attempt, to improve later

60ff1da

Oracle returning simple attempt, to improve later

3511f55

Oracle returning simple attempt, to improve later

484bc2d

Oracle returning simple attempt, to improve later

135a847

Cleanup and remove obsolete code, for now support only insert returning

110445f

Oracle update returning entity supported

25c2d49

Oracle update returning both entity and single field supported

fcd899c

Undo formatting changes.

808febc

Support delete returning for Oracle

81e20e2

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

1f11c39

…returning

Cleanup and minor improvements.

7a925b8

Cleanup space on github runners

b2b17f8

Revert formatting and updated some docs/comments.

1d26088

Minor improvement and more tests

ee48ae4

Minor improvement and code cleanup

589a9c9

radovanradic requested a review from dstepanov December 31, 2025 10:37

radovanradic added 4 commits December 31, 2025 12:47

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

afa1e23

…returning

Fix Sonar reported issue

6015d39

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

44a5ce3

…returning

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

4e5cea4

…returning

dstepanov reviewed Jan 16, 2026

View reviewed changes

radovanradic added 8 commits January 16, 2026 11:40

Remove added lines

eab27fd

Support Oracle RETURNING for custom methods/queries.

2441863

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

baffbaa

…returning

Fix test

0a585b7

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

3bdeb7f

…returning

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

47ff92d

…returning

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

7a655d5

…returning

Remove blank line

b6ffeaf

radovanradic added 3 commits March 9, 2026 15:57

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

77776c8

…returning

Checkstyle fix

2414442

Merge remote-tracking branch 'origin/5.0.x' into radovanradic/oracle-…

97625ba

…returning

radovanradic requested a review from Copilot March 18, 2026 15:12

Copilot AI reviewed Mar 18, 2026

View reviewed changes

Copilot AI mentioned this pull request Mar 18, 2026

Fix review feedback for Oracle RETURNING INTO support #3762

Merged

7 tasks

Copilot started reviewing on behalf of radovanradic March 18, 2026 15:29 View session

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support "RETURNING INTO" clause for INSERT/UPDATE/DELETE in Oracle database#3669

Support "RETURNING INTO" clause for INSERT/UPDATE/DELETE in Oracle database#3669
radovanradic wants to merge 32 commits into5.0.xfrom
radovanradic/oracle-returning

radovanradic commented Dec 31, 2025

Uh oh!

dstepanov Jan 16, 2026

Uh oh!

radovanradic Jan 16, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

radovanradic commented Mar 18, 2026

Uh oh!

Copilot AI commented Mar 18, 2026

Uh oh!

sonarqubecloud bot commented Mar 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		}
		return QueryResult.of("", queryParts, parameterBindings, outBindings, Map.of());

Conversation

radovanradic commented Dec 31, 2025

Uh oh!

dstepanov Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

radovanradic Jan 16, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

radovanradic commented Mar 18, 2026

Uh oh!

Copilot AI commented Mar 18, 2026

Uh oh!

sonarqubecloud bot commented Mar 18, 2026

Quality Gate failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants