Skip to content

Commit 1c8cc82

Browse files
authored
Changes to java doc of QueryRequest.setLimit(), it is used to set update limit for update query in onprem.(#143)
1 parent 435e5d6 commit 1c8cc82

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

driver/src/main/java/oracle/nosql/driver/ops/QueryRequest.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,11 @@ public QueryRequest setCompartment(String compartment) {
484484
* Returns the limit on number of items returned by the operation. If
485485
* not set by the application this value will be 0 which means no limit set.
486486
*
487+
* For update query with on-premise service, returns the update limit on
488+
* the number of records that can be updated in single update query. If not
489+
* set by the application this value will be 0 which means no application
490+
* limit set.
491+
*
487492
* @return the limit, or 0 if not set
488493
*/
489494
public int getLimit() {
@@ -494,7 +499,14 @@ public int getLimit() {
494499
* Sets the limit on number of items returned by the operation. This allows
495500
* an operation to return less than the default amount of data.
496501
*
497-
* @param limit the limit in terms of number of items returned
502+
* For update query, if with on-premise service, this is to set the update
503+
* limit on the number of records that can be updated in single query, if
504+
* not set by the application, default service limit is used. If with cloud
505+
* service, this update limit will be ignored, the maximum of records that
506+
* can be updated is limited by other cloud limits maxWriteKB and maxReadKB.
507+
*
508+
* @param limit the limit in terms of number of items returned, or the
509+
* maximum of records that can be updated in a update query.
498510
*
499511
* @return this
500512
*

0 commit comments

Comments
 (0)