natas_hw
/
cassandra
mirror of https://github.com/apache/cassandra
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve javadoc for KeysIndex 

patch by plin reviewed by dbrosius for cassandra-7253
This commit is contained in:
Peter Lin 2014-05-17 17:00:11 -04:00 committed by Dave Brosius
parent 7eefbf8b9d
commit eaa78e0857
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/java/org/apache/cassandra/db/index/keys/KeysIndex.java
View File

@ -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
{