diff --git a/db/db_impl/db_impl.h b/db/db_impl/db_impl.h index 772398947349..e0bb5eec936f 100644 --- a/db/db_impl/db_impl.h +++ b/db/db_impl/db_impl.h @@ -379,9 +379,7 @@ class DBImpl : public DB { void ReleaseSnapshot(const Snapshot* snapshot) override; // DO NOT USE, UNDER CONSTRUCTION - // Returns a cross-column-family iterator from a consistent database state. - // When the same key exists in more than one column families, this iterates in - // the order that column family is provided in column_families + // Return a cross-column-family iterator from a consistent database state. MultiCfIterator* NewMultiCfIterator( const ReadOptions& options, const std::vector& column_families, diff --git a/include/rocksdb/db.h b/include/rocksdb/db.h index f0a520a6400e..1db1093b5171 100644 --- a/include/rocksdb/db.h +++ b/include/rocksdb/db.h @@ -974,9 +974,10 @@ class DB { // DO NOT USE, UNDER CONSTRUCTION // Return a cross-column-family iterator from a consistent database state. - // When the same key exists in more than one column families, the iterator + // When the same key is present in multiple column families, the iterator // selects the value from the first column family containing the key, in the - // order provided in the `column_families` parameter. + // order specified by the `column_families` parameter. For wide column values, + // the iterator combines the columns into a single wide column value. virtual MultiCfIterator* NewMultiCfIterator( const ReadOptions& options, const std::vector& column_families, diff --git a/include/rocksdb/multi_cf_iterator.h b/include/rocksdb/multi_cf_iterator.h index 0b9ee622fca8..ddaf1a29f350 100644 --- a/include/rocksdb/multi_cf_iterator.h +++ b/include/rocksdb/multi_cf_iterator.h @@ -19,9 +19,10 @@ struct ReadOptions; // UNDER CONSTRUCTION - DO NOT USE // A cross-column-family iterator from a consistent database state. -// When the same key exists in more than one column families, the iterator +// When the same key is present in multiple column families, the iterator // selects the value from the first column family containing the key, in the -// order provided in the `column_families` parameter. +// order specified by the `column_families` parameter. For wide column values, +// the iterator combines the columns into a single wide column value. class MultiCfIterator : public Iterator { public: MultiCfIterator() {}