summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage
diff options
context:
space:
mode:
authorXiangyu Yao <xiangyu.yao@mongodb.com>2018-08-30 18:49:17 -0400
committerXiangyu Yao <xiangyu.yao@mongodb.com>2018-09-05 15:51:19 -0400
commitb231de1297d81e08efcd3eb510f322fd719dd42f (patch)
tree064e2c0ee08e752b479857efc2a21bb034f87bbb /src/mongo/db/storage
parentfdf3ac3da53134ffac8f3d51a8faa49479daec44 (diff)
downloadmongo-b231de1297d81e08efcd3eb510f322fd719dd42f.tar.gz
SERVER-36952 Update the comment for SortedDataInterface class
Diffstat (limited to 'src/mongo/db/storage')
-rw-r--r--src/mongo/db/storage/sorted_data_interface.h18
1 files changed, 3 insertions, 15 deletions
diff --git a/src/mongo/db/storage/sorted_data_interface.h b/src/mongo/db/storage/sorted_data_interface.h
index 4445acec0ff..74355bc96f9 100644
--- a/src/mongo/db/storage/sorted_data_interface.h
+++ b/src/mongo/db/storage/sorted_data_interface.h
@@ -52,21 +52,9 @@ struct ValidateResults;
enum SpecialFormatInserted { NoSpecialFormatInserted = 0, LongTypeBitsInserted = 1 };
/**
- * This interface is a work in progress. Notes below:
- *
- * This interface began as the SortedDataInterface, a way to hide the fact that there were two
- * on-disk formats for the btree. With the introduction of other storage engines, this
- * interface was generalized to provide access to sorted data. Specifically:
- *
- * 1. Many other storage engines provide different Btree(-ish) implementations. This interface
- * could allow those interfaces to avoid storing btree buckets in an already sorted structure.
- *
- * TODO: See if there is actually a performance gain.
- *
- * 2. The existing btree implementation is written to assume that if it modifies a record it is
- * modifying the underlying record. This interface is an attempt to work around that.
- *
- * TODO: See if this actually works.
+ * This is the uniform interface for storing indexes and supporting point queries as well as range
+ * queries. The actual implementation is up to the storage engine. All the storage engines must
+ * support an index key size up to the maximum document size.
*/
class SortedDataInterface {
public: