Uses of Class org.apache.cassandra.db.index.SecondaryIndex (apache-cassandra API)
Date: 2018-02-12

## Uses of Class
org.apache.cassandra.db.index.SecondaryIndex

- Packages that use SecondaryIndex
  Package | Description
  --- | ---
  org.apache.cassandra.cql3.restrictions |
  org.apache.cassandra.db.index |
  org.apache.cassandra.db.index.composites |
  org.apache.cassandra.db.index.keys |

- - ### Uses of SecondaryIndex in org.apache.cassandra.cql3.restrictions

    Methods in org.apache.cassandra.cql3.restrictions with parameters of type SecondaryIndex
    Modifier and Type | Method and Description
    --- | ---
    `protected abstract boolean` | MultiColumnRestriction.`isSupportedBy(SecondaryIndex index)` Check if this type of restriction is supported for by the specified index.
    `protected boolean` | MultiColumnRestriction.EQ.`isSupportedBy(SecondaryIndex index)`
    `protected boolean` | MultiColumnRestriction.IN.`isSupportedBy(SecondaryIndex index)`
    `protected boolean` | MultiColumnRestriction.Slice.`isSupportedBy(SecondaryIndex index)`
    `protected abstract boolean` | SingleColumnRestriction.`isSupportedBy(SecondaryIndex index)` Check if this type of restriction is supported by the specified index.
    `protected boolean` | SingleColumnRestriction.EQ.`isSupportedBy(SecondaryIndex index)`
    `protected boolean` | SingleColumnRestriction.IN.`isSupportedBy(SecondaryIndex index)`
    `protected boolean` | SingleColumnRestriction.Slice.`isSupportedBy(SecondaryIndex index)`
    `protected boolean` | SingleColumnRestriction.Contains.`isSupportedBy(SecondaryIndex index)`

  - ### Uses of SecondaryIndex in org.apache.cassandra.db.index

    Subclasses of SecondaryIndex in org.apache.cassandra.db.index
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractSimplePerColumnSecondaryIndex` 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.
    `class` | `PerColumnSecondaryIndex` Base class for Secondary indexes that implement a unique index per column
    `class` | `PerRowSecondaryIndex` Base class for Secondary indexes that implement a unique index per row

    Methods in org.apache.cassandra.db.index that return SecondaryIndex
    Modifier and Type | Method and Description
    --- | ---
    `static SecondaryIndex` | SecondaryIndex.`createInstance(ColumnFamilyStore baseCfs, ColumnDefinition cdef)` This is the primary way to create a secondary index instance for a CF column.
    `SecondaryIndex` | SecondaryIndexManager.`getIndexByName(java.lang.String name)`
    `SecondaryIndex` | SecondaryIndexManager.`getIndexForColumn(java.nio.ByteBuffer column)`
    `SecondaryIndex` | SecondaryIndexSearcher.`highestSelectivityIndex(java.util.List<IndexExpression> clause)`
    `SecondaryIndex` | SecondaryIndexManager.`validate(java.nio.ByteBuffer rowKey, Cell cell)`

    Methods in org.apache.cassandra.db.index that return types with arguments of type SecondaryIndex
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Collection<SecondaryIndex>` | SecondaryIndexManager.`getIndexes()`
    `java.util.Set<SecondaryIndex>` | SecondaryIndexManager.`getIndexesByNames(java.util.Set<java.lang.String> idxNames)`
    `java.util.Set<SecondaryIndex>` | SecondaryIndexManager.`getIndexesNotBackedByCfs()`
    `java.util.Set<SecondaryIndex>` | SecondaryIndexManager.`indexFor(CellName name)`
    `java.util.Set<SecondaryIndex>` | SecondaryIndexManager.`indexFor(CellName name, java.util.Collection<SecondaryIndex> indexes)`

    Method parameters in org.apache.cassandra.db.index with type arguments of type SecondaryIndex
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | SecondaryIndexManager.`indexes(CellName name, java.util.Collection<SecondaryIndex> indexes)`
    `java.util.Set<SecondaryIndex>` | SecondaryIndexManager.`indexFor(CellName name, java.util.Collection<SecondaryIndex> indexes)`

  - ### Uses of SecondaryIndex in org.apache.cassandra.db.index.composites

    Subclasses of SecondaryIndex in org.apache.cassandra.db.index.composites
    Modifier and Type | Class and Description
    --- | ---
    `class` | `CompositesIndex` Base class for secondary indexes where composites are involved.
    `class` | `CompositesIndexIncludingCollectionKey` Common superclass for indexes that capture collection keys, including indexes on such keys themselves.
    `class` | `CompositesIndexOnClusteringKey` Index on a CLUSTERING_COLUMN column definition.
    `class` | `CompositesIndexOnCollectionKey` Index on the collection element of the cell name of a collection.
    `class` | `CompositesIndexOnCollectionKeyAndValue` Index on the element and value of cells participating in a collection.
    `class` | `CompositesIndexOnCollectionValue` Index the value of a collection cell.
    `class` | `CompositesIndexOnPartitionKey` Index on a PARTITION_KEY column definition.
    `class` | `CompositesIndexOnRegular` Index on a REGULAR column definition on a composite type.

  - ### Uses of SecondaryIndex in org.apache.cassandra.db.index.keys

    Subclasses of SecondaryIndex in org.apache.cassandra.db.index.keys
    Modifier and Type | Class and Description
    --- | ---
    `class` | `KeysIndex` Implements a secondary index for a column family using a second column family.

Copyright © 2018 The Apache Software Foundation