andreacavalli/rocksdb
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Java-API: Fix minor Javadoc copy-paste errors (#8034)

Browse Source 
Summary:
Fixes 3 minor Javadoc copy-paste errors in the `RocksDB#newIterator()` and `Transaction#getIterator()` variants that take a column family handle but are talking about iterating over "the database" or "the default column family".

Pull Request resolved: https://github.com/facebook/rocksdb/pull/8034

Reviewed By: jay-zhuang

Differential Revision: D26877667

Pulled By: mrambacher

fbshipit-source-id: 95dd95b667c496e389f221acc9a91b340e4b63bf
This commit is contained in:
stefan-zobel 2021-03-16 18:05:13 -07:00 committed by Facebook GitHub Bot
parent 1a343bc393
commit 8d9088464b
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
java/src/main/java/org/rocksdb/RocksDB.java
View File

@ -2834,8 +2834,8 @@ public class RocksDB extends RocksObject {
} }
/** /**
* <p>Return a heap-allocated iterator over the contents of the * <p>Return a heap-allocated iterator over the contents of a
* database. The result of newIterator() is initially invalid * ColumnFamily. The result of newIterator() is initially invalid
* (caller must call one of the Seek methods on the iterator * (caller must call one of the Seek methods on the iterator
* before using it).</p> * before using it).</p>
* *
@ -2854,8 +2854,8 @@ public class RocksDB extends RocksObject {
} }
/** /**
* <p>Return a heap-allocated iterator over the contents of the * <p>Return a heap-allocated iterator over the contents of a
* database. The result of newIterator() is initially invalid * ColumnFamily. The result of newIterator() is initially invalid
* (caller must call one of the Seek methods on the iterator * (caller must call one of the Seek methods on the iterator
* before using it).</p> * before using it).</p>
* *

6
java/src/main/java/org/rocksdb/Transaction.java
View File

@ -611,9 +611,9 @@ public class Transaction extends RocksObject {
} }
/** /**
* Returns an iterator that will iterate on all keys in the default * Returns an iterator that will iterate on all keys in the column family
* column family including both keys in the DB and uncommitted keys in this * specified by {@code columnFamilyHandle} including both keys in the DB
* transaction. * and uncommitted keys in this transaction.
* *
* Setting {@link ReadOptions#setSnapshot(Snapshot)} will affect what is read * Setting {@link ReadOptions#setSnapshot(Snapshot)} will affect what is read
* from the DB but will NOT change which keys are read from this transaction * from the DB but will NOT change which keys are read from this transaction