wbtiger
/
foundationdb
mirror of https://github.com/apple/foundationdb.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review 

Co-authored-by: A.J. Beamon <ajbeamon@users.noreply.github.com>
This commit is contained in:
Xin Dong 2020-10-12 09:50:45 -07:00 committed by GitHub
parent 079f27d47d
commit 8f311543f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bindings/go/src/fdb/snapshot.go
View File

@ -98,7 +98,7 @@ func (s Snapshot) GetEstimatedRangeSizeBytes(r ExactRange) FutureInt64 {
}
// GetRangeSplitPoints returns a list of keys that can split the given range
// into (roughly)equally sized chunks based on chunkSize.
// into (roughly) equally sized chunks based on chunkSize.
// Note: the returned split points contain the start key and end key of the given range.
func (s Snapshot) GetRangeSplitPoints(r ExactRange, chunkSize int64) FutureKeyArray {
beginKey, endKey := r.FDBRangeKeys()

2
bindings/go/src/fdb/transaction.go
View File

@ -349,7 +349,7 @@ func (t *transaction) getRangeSplitPoints(beginKey Key, endKey Key, chunkSize in
}
// GetRangeSplitPoints returns a list of keys that can split the given range
// into (roughly)equally sized chunks based on chunkSize.
// into (roughly) equally sized chunks based on chunkSize.
// Note: the returned split points contain the start key and end key of the given range.
func (t Transaction) GetRangeSplitPoints(r ExactRange, chunkSize int64) FutureKeyArray {
beginKey, endKey := r.FDBRangeKeys()

4
bindings/java/src/main/com/apple/foundationdb/ReadTransaction.java
View File

@ -456,7 +456,7 @@ public interface ReadTransaction extends ReadTransactionContext {
CompletableFuture<Long> getEstimatedRangeSizeBytes(Range range);
/**
* Gets a list of keys that can split the given range into (roughly)equally sized chunks based on chunkSize.
* Gets a list of keys that can split the given range into (roughly) equally sized chunks based on <code>chunkSize</code>.
* Note: the returned split points contain the start key and end key of the given range.
*
* @param begin the beginning of the range (inclusive)
@ -467,7 +467,7 @@ public interface ReadTransaction extends ReadTransactionContext {
CompletableFuture<KeyArrayResult> getRangeSplitPoints(byte[] begin, byte[] end, long chunkSize);
/**
* Gets a list of keys that can split the given range into (roughly)equally sized chunks based on chunkSize
* Gets a list of keys that can split the given range into (roughly) equally sized chunks based on <code>chunkSize</code>
* Note: the returned split points contain the start key and end key of the given range.
*
* @param range the range of the keys

2
documentation/sphinx/source/api-c.rst
View File

@ -487,7 +487,7 @@ Applications must provide error handling and an appropriate retry loop around th
|future-return0| the estimated size of the key range given. |future-return1| call :func:`fdb_future_get_int64()` to extract the size, |future-return2|
.. function:: FDBFuture* fdb_transaction_get_range_split_points( FDBTransaction* tr, uint8_t const* begin_key_name, int begin_key_name_length, uint8_t const* end_key_name, int end_key_name_length, int64_t chunkSize)
Returns a list of keys that can split the given range into (roughly)equally sized chunks based on chunkSize.
Returns a list of keys that can split the given range into (roughly) equally sized chunks based on chunkSize.
.. note:: The returned split points contain the start key and end key of the given range
|future-return0| the list of split points. |future-return1| call :func:`fdb_future_get_key_array()` to extract the array, |future-return2|

2
documentation/sphinx/source/api-python.rst
View File

@ -804,7 +804,7 @@ Transaction misc functions
.. method:: Transaction.get_range_split_points(self, begin_key, end_key, chunk_size)
Gets a list of keys that can split the given range into (roughly)equally sized chunks based on chunkSize. Returns a :class:`FutureKeyArray`.
Gets a list of keys that can split the given range into (roughly) equally sized chunks based on ``chunk_size``. Returns a :class:`FutureKeyArray`.
.. note:: The returned split points contain the start key and end key of the given range

2
documentation/sphinx/source/api-ruby.rst
View File

@ -748,7 +748,7 @@ Transaction misc functions
.. method:: Transaction.get_range_split_points(begin_key, end_key, chunk_size) -> FutureKeyArray
Gets a list of keys that can split the given range into (roughly)equally sized chunks based on chunkSize. Returns a :class:`FutureKeyArray`.
Gets a list of keys that can split the given range into (roughly) equally sized chunks based on ``chunk_size``. Returns a :class:`FutureKeyArray`.
.. note:: The returned split points contain the start key and end key of the given range
.. method:: Transaction.get_approximate_size() -> Int64Future