Skip to content

Commit

Permalink
add comment for rawkv scans (#462)
Browse files Browse the repository at this point in the history
Signed-off-by: disksing <[email protected]>
  • Loading branch information
disksing authored Apr 6, 2022
1 parent cab40e7 commit c7fbfc2
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion rawkv/rawkv.go
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@ func (c *Client) DeleteRange(ctx context.Context, startKey []byte, endKey []byte
}

// Scan queries continuous kv pairs in range [startKey, endKey), up to limit pairs.
// The returned keys are in lexicographical order.
// If endKey is empty, it means unbounded.
// If you want to exclude the startKey or include the endKey, push a '\0' to the key. For example, to scan
// (startKey, endKey], you can write:
Expand Down Expand Up @@ -456,7 +457,7 @@ func (c *Client) Scan(ctx context.Context, startKey, endKey []byte, limit int, o
}

// ReverseScan queries continuous kv pairs in range [endKey, startKey), up to limit pairs.
// Direction is different from Scan, upper to lower.
// The returned keys are in reversed lexicographical order.
// If endKey is empty, it means unbounded.
// If you want to include the startKey or exclude the endKey, push a '\0' to the key. For example, to scan
// (endKey, startKey], you can write:
Expand Down

0 comments on commit c7fbfc2

Please sign in to comment.