Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Commit

Permalink
update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
foreverneverer committed Jan 27, 2021
1 parent 5ab7eaf commit db52a03
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/main/java/com/xiaomi/infra/pegasus/client/PegasusTable.java
Original file line number Diff line number Diff line change
Expand Up @@ -1818,11 +1818,30 @@ public List<PegasusScannerInterface> getUnorderedScanners(
return ret;
}

/**
* {@linkplain #scanRange(byte[], byte[], byte[], ScanOptions, int, int)} result, if fetch all
* data for {startSortKey, stopSortKey}, ScanRangeResult.allFetched=true
*/
static class ScanRangeResult {
public List<Pair<Pair<byte[], byte[]>, byte[]>> results;
public boolean allFetched;
}

/**
* get scan result for {startSortKey, stopSortKey} within hashKey
*
* @param hashKey used to decide which partition to put this k-v,
* @param startSortKey start sort key scan from if null or length == 0, means start from begin
* @param stopSortKey stop sort key scan to if null or length == 0, means stop to end
* @param options scan options like endpoint inclusive/exclusive
* @param maxFetchCount max count of k-v pairs to be fetched. if <=0 means fetch all data for
* {startSortKey, stopSortKey}
* @param timeout if exceed the timeout will throw timeout exception, if <=0, it is equal with
* "timeout" of config
* @return ScanRangeResult, if fetch all data for {startSortKey, stopSortKey},
* ScanRangeResult.allFetched=true
* @throws PException
*/
ScanRangeResult scanRange(
byte[] hashKey,
byte[] startSortKey,
Expand Down

0 comments on commit db52a03

Please sign in to comment.