NCBC-3307: Implement ByteLimit, ItemLimit and TimeLimit.

Motivation ---------- Implementation already mostly done in main range scan patch. Changes ------- *Doc change *Fixed typo *Exposed TimeLimit in ScanOptions Change-Id: Id285d46f9bbd83d1b87c5996c15e15e7c6cf4ea4 Reviewed-on: https://review.couchbase.org/c/couchbase-net-client/+/184612 Tested-by: Build Bot <[email protected]> Reviewed-by: Richard Ponton <[email protected]>
couchbase · Feb 2, 2023 · a6a1335 · a6a1335
1 parent 45ba570
commit a6a1335
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/src/Couchbase/KeyValue/RangeScan/PartitionScan.cs b/src/Couchbase/KeyValue/RangeScan/PartitionScan.cs
@@ -9,7 +9,7 @@
 
 namespace Couchbase.KeyValue.RangeScan;
 
-internal record PartitionScan
+internal class PartitionScan
 {
     public PartitionScan(IOperationConfigurator operationConfigurator, BucketBase bucket, ICouchbaseCollection collection, ILogger<GetResult> getLogger, ScanOptions options, IScanType scanType, short partitionId)
     {
@@ -71,6 +71,7 @@ public async Task<PartitionScan> ScanAsync()
                         Uuid = _uuid.Value,
                         IdsOnly = _options.IdsOnlyValue,
                         Logger = _getLogger,
+                        TimeLimit = _options.BatchTimeLimit,
                         ItemLimit = _options.BatchItemLimit,
                         ByteLimit = _options.BatchByteLimit
                     };
@@ -96,6 +97,7 @@ public async Task<PartitionScan> ScanAsync()
                 Uuid = _uuid.Value,
                 IdsOnly = _options.IdsOnlyValue,
                 Logger = _getLogger,
+                TimeLimit = _options.BatchTimeLimit,
                 ItemLimit = _options.BatchItemLimit,
                 ByteLimit = _options.BatchByteLimit
             };

diff --git a/src/Couchbase/KeyValue/RangeScan/ScanOptions.cs b/src/Couchbase/KeyValue/RangeScan/ScanOptions.cs
@@ -39,9 +39,11 @@ static ScanOptions()
 
         internal CancellationToken TokenValue { get; private set; }
 
-        internal uint BatchItemLimit { get; set; }
+        internal uint BatchItemLimit { get; set; } = 0;
 
-        internal uint BatchByteLimit { get; set; }
+        internal uint BatchByteLimit { get; set; } = 0;
+
+        internal uint BatchTimeLimit { get; set; } = 0;
 
         ITypeTranscoder? ITranscoderOverrideOptions.Transcoder => TranscoderValue;
 
@@ -167,6 +169,17 @@ public ScanOptions ByteLimit(uint limit)
             return this;
         }
 
+        /// <summary>
+        /// Sets the Time Limit in milliseconds for the scan to keep returning documents. This will be applied to each stream individually.
+        /// </summary>
+        /// <param name="limit"></param>
+        /// <returns>A <see cref="ScanOptions"/> instance for chaining.</returns>
+        public ScanOptions TimeLimit(uint limit)
+        {
+            BatchTimeLimit = limit;
+            return this;
+        }
+
         #endregion
     }
 }