cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dbros...@apache.org
Subject git commit: Improve javadoc for KeysIndex
Date Sat, 17 May 2014 21:01:32 GMT
Repository: cassandra
Updated Branches:
  refs/heads/cassandra-2.0 7eefbf8b9 -> eaa78e085


Improve javadoc for KeysIndex

patch by plin reviewed by dbrosius for cassandra-7253


Project: http://git-wip-us.apache.org/repos/asf/cassandra/repo
Commit: http://git-wip-us.apache.org/repos/asf/cassandra/commit/eaa78e08
Tree: http://git-wip-us.apache.org/repos/asf/cassandra/tree/eaa78e08
Diff: http://git-wip-us.apache.org/repos/asf/cassandra/diff/eaa78e08

Branch: refs/heads/cassandra-2.0
Commit: eaa78e0857b30662c55cd72d5bc635a4d9d1a23a
Parents: 7eefbf8
Author: Peter Lin <woolfel@gmail.com>
Authored: Sat May 17 17:00:11 2014 -0400
Committer: Dave Brosius <dbrosius@mebigfatguy.com>
Committed: Sat May 17 17:00:11 2014 -0400

----------------------------------------------------------------------
 src/java/org/apache/cassandra/db/index/keys/KeysIndex.java | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cassandra/blob/eaa78e08/src/java/org/apache/cassandra/db/index/keys/KeysIndex.java
----------------------------------------------------------------------
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 f47b1e1..cbb91a6 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
 {


Mime
View raw message