From 7ef9246a6e75ce7bf227ace5634accbe18f8194f Mon Sep 17 00:00:00 2001
From: Lukas Eder <lukas.eder@datageekery.com>
Date: Wed, 7 Feb 2024 11:10:05 +0100
Subject: [PATCH] [jOOQ/jOOQ#16217] Add ExecuteContext.params(): Param<?>[]

---
 .../main/java/org/jooq/ExecuteContext.java    | 16 ++++
 .../main/java/org/jooq/ExecuteListener.java   | 80 ++++++++++++++-----
 .../org/jooq/impl/DefaultExecuteContext.java  | 15 ++++
 .../org/jooq/impl/SimpleExecuteContext.java   | 11 +++
 4 files changed, 104 insertions(+), 18 deletions(-)

diff --git a/jOOQ/src/main/java/org/jooq/ExecuteContext.java b/jOOQ/src/main/java/org/jooq/ExecuteContext.java
index 23d333601b..8dd8fa4060 100644
--- a/jOOQ/src/main/java/org/jooq/ExecuteContext.java
+++ b/jOOQ/src/main/java/org/jooq/ExecuteContext.java
@@ -243,6 +243,22 @@ public interface ExecuteContext extends Scope {
      */
     void sql(String sql);
 
+    /**
+     * The bind values that are being bound to the {@link PreparedStatement}.
+     */
+    Param<?> @NotNull [] params();
+
+    /**
+     * Override the bind values that are being bound to the
+     * {@link PreparedStatement}.
+     * <p>
+     * This may have no effect, if called at the wrong moment.
+     *
+     * @see ExecuteListener#renderEnd(ExecuteContext)
+     * @see ExecuteListener#prepareStart(ExecuteContext)
+     */
+    void params(Param<?>[] params);
+
     /**
      * The number of user defined update counts that are going to be skipped
      * when a statement batch is executed.
diff --git a/jOOQ/src/main/java/org/jooq/ExecuteListener.java b/jOOQ/src/main/java/org/jooq/ExecuteListener.java
index f248c71cd2..8a77364e85 100644
--- a/jOOQ/src/main/java/org/jooq/ExecuteListener.java
+++ b/jOOQ/src/main/java/org/jooq/ExecuteListener.java
@@ -375,7 +375,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * </ul>
      * <p>
      * Overridable attributes in <code>ExecuteContext</code>:
@@ -383,6 +385,8 @@ public interface ExecuteListener extends EventListener, Serializable {
      * <li>{@link ExecuteContext#sql(String)}: The rendered <code>SQL</code>
      * statement that is about to be executed. You can modify this statement
      * freely.</li>
+     * <li>{@link ExecuteContext#params(Param[])}: Bind values that are to be
+     * bound to the {@link PreparedStatement}.</li>
      * </ul>
      *
      * @param ctx The context containing information about the execution.
@@ -472,7 +476,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * </ul>
      * <p>
      * Overridable attributes in <code>ExecuteContext</code>:
@@ -480,6 +486,8 @@ public interface ExecuteListener extends EventListener, Serializable {
      * <li>{@link ExecuteContext#sql(String)}: The rendered <code>SQL</code>
      * statement that is about to be executed. You can modify this statement
      * freely.</li>
+     * <li>{@link ExecuteContext#params(Param[])}: Bind values that are to be
+     * bound to the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The {@link PreparedStatement}
      * about to be executed. At this stage, no such statement is available yet,
      * but if provided, the execution lifecycle will skip preparing a statement.
@@ -521,7 +529,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -542,6 +552,8 @@ public interface ExecuteListener extends EventListener, Serializable {
      * <p>
      * Overridable attributes in <code>ExecuteContext</code>:
      * <ul>
+     * <li>{@link ExecuteContext#params(Param[])}: Bind values that are to be
+     * bound to the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement(PreparedStatement)}: The
      * <code>Statement</code>, <code>PreparedStatement</code>, or
      * <code>CallableStatement</code> that is about to be executed. You can
@@ -568,7 +580,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -586,6 +600,8 @@ public interface ExecuteListener extends EventListener, Serializable {
      * <p>
      * Overridable attributes in <code>ExecuteContext</code>:
      * <ul>
+     * <li>{@link ExecuteContext#params(Param[])}: Bind values that are to be
+     * bound to the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement(PreparedStatement)}: The
      * <code>PreparedStatement</code>, or <code>CallableStatement</code> that is
      * about to be executed. You can modify this statement freely, or wrap
@@ -615,7 +631,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -662,7 +680,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -715,7 +735,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -770,7 +792,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -807,7 +831,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -845,7 +871,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -903,7 +931,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -973,7 +1003,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1025,7 +1057,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1077,7 +1111,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1149,7 +1185,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1208,7 +1246,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1262,7 +1302,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
@@ -1317,7 +1359,9 @@ public interface ExecuteListener extends EventListener, Serializable {
      * a jOOQ routine is being executed or <code>null</code> otherwise</li>
      * <li>{@link ExecuteContext#sql()}: The rendered <code>SQL</code> statement
      * that is about to be executed, or <code>null</code> if the
-     * <code>SQL</code> statement is unknown..</li>
+     * <code>SQL</code> statement is unknown.</li>
+     * <li>{@link ExecuteContext#params()}: The bind values that are bound to
+     * the {@link PreparedStatement}.</li>
      * <li>{@link ExecuteContext#statement()}: The
      * <code>PreparedStatement</code> that is about to be executed, or
      * <code>null</code> if no statement is known to jOOQ. This can be any of
diff --git a/jOOQ/src/main/java/org/jooq/impl/DefaultExecuteContext.java b/jOOQ/src/main/java/org/jooq/impl/DefaultExecuteContext.java
index bf7dd122ff..9171f25986 100644
--- a/jOOQ/src/main/java/org/jooq/impl/DefaultExecuteContext.java
+++ b/jOOQ/src/main/java/org/jooq/impl/DefaultExecuteContext.java
@@ -41,6 +41,7 @@ import static java.lang.Boolean.TRUE;
 // ...
 import static org.jooq.conf.SettingsTools.renderLocale;
 import static org.jooq.impl.Tools.EMPTY_INT;
+import static org.jooq.impl.Tools.EMPTY_PARAM;
 import static org.jooq.impl.Tools.EMPTY_QUERY;
 import static org.jooq.impl.Tools.EMPTY_STRING;
 
@@ -74,6 +75,7 @@ import org.jooq.ExecuteListener;
 import org.jooq.ExecuteType;
 import org.jooq.Insert;
 import org.jooq.Merge;
+import org.jooq.Param;
 // ...
 import org.jooq.Query;
 import org.jooq.Record;
@@ -119,6 +121,7 @@ class DefaultExecuteContext implements ExecuteContext {
     private Query                                         query;
     private final Routine<?>                              routine;
     private String                                        sql;
+    private Param<?>[]                                    params;
     private int                                           skipUpdateCounts;
 
     private final BatchMode                               batchMode;
@@ -546,6 +549,18 @@ class DefaultExecuteContext implements ExecuteContext {
         return sql;
     }
 
+    @Override
+    public void params(Param<?>[] p) {
+        this.params = p;
+    }
+
+    @Override
+    public final Param<?>[] params() {
+        return params != null
+            ? params
+            : EMPTY_PARAM;
+    }
+
     @Override
     public final int skipUpdateCounts() {
         return this.skipUpdateCounts;
diff --git a/jOOQ/src/main/java/org/jooq/impl/SimpleExecuteContext.java b/jOOQ/src/main/java/org/jooq/impl/SimpleExecuteContext.java
index 546ceaf077..2f3b332ace 100644
--- a/jOOQ/src/main/java/org/jooq/impl/SimpleExecuteContext.java
+++ b/jOOQ/src/main/java/org/jooq/impl/SimpleExecuteContext.java
@@ -49,6 +49,7 @@ import org.jooq.ConnectionProvider;
 import org.jooq.ConverterContext;
 import org.jooq.ExecuteContext;
 import org.jooq.ExecuteType;
+import org.jooq.Param;
 import org.jooq.Query;
 import org.jooq.Record;
 import org.jooq.Result;
@@ -150,6 +151,16 @@ final class SimpleExecuteContext extends AbstractScope implements ExecuteContext
         throw new UnsupportedOperationException("Not implemented");
     }
 
+    @Override
+    public final Param<?>[] params() {
+        throw new UnsupportedOperationException("Not implemented");
+    }
+
+    @Override
+    public final void params(Param<?>[] params) {
+        throw new UnsupportedOperationException("Not implemented");
+    }
+
     @Override
     public final int skipUpdateCounts() {
         throw new UnsupportedOperationException("Not implemented");