From eaa78e0857b30662c55cd72d5bc635a4d9d1a23a Mon Sep 17 00:00:00 2001 From: Peter Lin Date: Sat, 17 May 2014 17:00:11 -0400 Subject: [PATCH] Improve javadoc for KeysIndex patch by plin reviewed by dbrosius for cassandra-7253 --- .../org/apache/cassandra/db/index/keys/KeysIndex.java | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/java/org/apache/cassandra/db/index/keys/KeysIndex.java b/src/java/org/apache/cassandra/db/index/keys/KeysIndex.java index f47b1e1d30..cbb91a6829 100644 --- a/src/java/org/apache/cassandra/db/index/keys/KeysIndex.java +++ b/src/java/org/apache/cassandra/db/index/keys/KeysIndex.java @@ -28,8 +28,12 @@ import org.apache.cassandra.db.marshal.AbstractType; import org.apache.cassandra.exceptions.ConfigurationException; /** - * Implements a secondary index for a column family using a second column family - * in which the row keys are indexed values, and column names are base row keys. + * Implements a secondary index for a column family using a second column family. + * The design uses inverted index http://en.wikipedia.org/wiki/Inverted_index. + * The row key is the indexed value. For example, if we're indexing a column named + * city, the index value of city is the row key. + * The column names are the keys of the records. To see a detailed example, please + * refer to wikipedia. */ public class KeysIndex extends AbstractSimplePerColumnSecondaryIndex {