add cache modes and timeout to @NamedQuery, @NamedNativeQuery

see issue jakartaee#473 Signed-off-by: Gavin King <[email protected]>
gavinking · Sep 20, 2024 · 6ef3994 · 6ef3994
1 parent 1aac75c
commit 6ef3994
Show file tree

Hide file tree

Showing 2 changed files with 58 additions and 7 deletions.
diff --git a/api/src/main/java/jakarta/persistence/NamedNativeQuery.java b/api/src/main/java/jakarta/persistence/NamedNativeQuery.java
@@ -11,6 +11,7 @@
  */
 
 // Contributors:
+//     Gavin King       - 4.0
 //     Gavin King       - 3.2
 //     Petros Splinakis - 2.2
 //     Linda DeMichiel  - 2.1
@@ -95,12 +96,6 @@
      */
     String query();
 
-    /**
-     * Query properties and hints.
-     * (May include vendor-specific query hints.)
-     */
-    QueryHint[] hints() default {};
-
     /**
      * The class of each query result. If a {@link #resultSetMapping
      * result set mapping} is specified, the specified result class
@@ -145,4 +140,34 @@
      * @since 3.2
      */
     ColumnResult[] columns() default {};
+
+    /**
+     * (Optional) The {@linkplain CacheStoreMode cache store mode}
+     * to use in query execution.
+     * @since 4.0
+     * @see Query#setCacheStoreMode
+     */
+    CacheStoreMode cacheStoreMode() default CacheStoreMode.USE;
+
+    /**
+     * (Optional) The {@linkplain CacheRetrieveMode cache retrieve mode}
+     * to use in query execution.
+     * @since 4.0
+     * @see Query#setCacheRetrieveMode
+     */
+    CacheRetrieveMode cacheRetrieveMode() default CacheRetrieveMode.USE;
+
+    /**
+     * (Optional) A query timeout in milliseconds. By default,
+     * there is no timeout.
+     * @since 4.0
+     * @see Query#setTimeout
+     */
+    int timeout() default -1;
+
+    /**
+     * Query properties and hints.
+     * (May include vendor-specific query hints.)
+     */
+    QueryHint[] hints() default {};
 }
diff --git a/api/src/main/java/jakarta/persistence/NamedQuery.java b/api/src/main/java/jakarta/persistence/NamedQuery.java
@@ -11,6 +11,7 @@
  */
 
 // Contributors:
+//     Gavin King       - 4.0
 //     Gavin King       - 3.2
 //     Petros Splinakis - 2.2
 //     Linda DeMichiel  - 2.1
@@ -86,9 +87,34 @@
      * is specified, the query must be executed in a transaction
      * and the persistence context joined to the transaction.
      * @since 2.0
+     * @see Query#setLockMode
      */
     LockModeType lockMode() default LockModeType.NONE;
-
+
+    /**
+     * (Optional) The {@linkplain CacheStoreMode cache store mode}
+     * to use in query execution.
+     * @since 4.0
+     * @see Query#setCacheStoreMode 
+     */
+    CacheStoreMode cacheStoreMode() default CacheStoreMode.USE;
+
+    /**
+     * (Optional) The {@linkplain CacheRetrieveMode cache retrieve mode}
+     * to use in query execution.
+     * @since 4.0
+     * @see Query#setCacheRetrieveMode 
+     */
+    CacheRetrieveMode cacheRetrieveMode() default CacheRetrieveMode.USE;
+
+    /**
+     * (Optional) A query timeout in milliseconds. By default,
+     * there is no timeout.
+     * @since 4.0
+     * @see Query#setTimeout 
+     */
+    int timeout() default -1;
+
     /**
      * (Optional) Query properties and hints. May include
      * vendor-specific query hints.