Uses of Class org.apache.cassandra.schema.IndexMetadata (apache-cassandra API)
Date: 2018-02-14

## Uses of Class
org.apache.cassandra.schema.IndexMetadata

- Packages that use IndexMetadata
  Package | Description
  --- | ---
  org.apache.cassandra.config |
  org.apache.cassandra.db |
  org.apache.cassandra.db.filter |
  org.apache.cassandra.index |
  org.apache.cassandra.index.internal |
  org.apache.cassandra.index.internal.composites |
  org.apache.cassandra.index.internal.keys |
  org.apache.cassandra.index.sasi |
  org.apache.cassandra.index.sasi.conf |
  org.apache.cassandra.schema |

- - ### Uses of IndexMetadata in org.apache.cassandra.config

    Methods in org.apache.cassandra.config with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | CFMetaData.`indexColumnFamilyName(IndexMetadata info)` generate a column family name for an index corresponding to the given column.

  - ### Uses of IndexMetadata in org.apache.cassandra.db

    Methods in org.apache.cassandra.db that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | ReadCommand.`indexMetadata()` Index (metadata) chosen for this query.

    Methods in org.apache.cassandra.db with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `static SinglePartitionReadCommand` | SinglePartitionReadCommand.`create(boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, DecoratedKey partitionKey, ClusteringIndexFilter clusteringIndexFilter, IndexMetadata indexMetadata)` Creates a new read command on a single partition.
    `abstract ReadCommand` | ReadCommand.SelectionDeserializer.`deserialize(DataInputPlus in, int version, boolean isDigest, int digestVersion, boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, IndexMetadata index)`

    Constructors in org.apache.cassandra.db with parameters of type IndexMetadata
    Constructor and Description
    `ReadCommand(ReadCommand.Kind kind, boolean isDigestQuery, int digestVersion, boolean isForThrift, CFMetaData metadata, int nowInSec, ColumnFilter columnFilter, RowFilter rowFilter, DataLimits limits, IndexMetadata index)`

  - ### Uses of IndexMetadata in org.apache.cassandra.db.filter

    Methods in org.apache.cassandra.db.filter that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | RowFilter.CustomExpression.`getTargetIndex()`

    Methods in org.apache.cassandra.db.filter with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `void` | RowFilter.`addCustomIndexExpression(CFMetaData cfm, IndexMetadata targetIndex, java.nio.ByteBuffer value)`

    Constructors in org.apache.cassandra.db.filter with parameters of type IndexMetadata
    Constructor and Description
    `CustomExpression(CFMetaData cfm, IndexMetadata targetIndex, java.nio.ByteBuffer value)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index

    Methods in org.apache.cassandra.index that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | Index.`getIndexMetadata()` Returns the IndexMetadata which configures and defines the index instance.

    Methods in org.apache.cassandra.index that return types with arguments of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Set<IndexMetadata>` | SecondaryIndexManager.`getDependentIndexes(ColumnDefinition column)`

    Methods in org.apache.cassandra.index with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.util.concurrent.Future<?>` | SecondaryIndexManager.`addIndex(IndexMetadata indexDef)` Adds and builds a index
    `Index` | IndexRegistry.`getIndex(IndexMetadata indexMetadata)`
    `Index` | SecondaryIndexManager.`getIndex(IndexMetadata metadata)`
    `java.util.concurrent.Callable<?>` | Index.`getMetadataReloadTask(IndexMetadata indexMetadata)` Return a task to reload the internal metadata of an index.
    `static Pair<ColumnDefinition,IndexTarget.Type>` | TargetParser.`parse(CFMetaData cfm, IndexMetadata indexDef)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index.internal

    Fields in org.apache.cassandra.index.internal declared as IndexMetadata
    Modifier and Type | Field and Description
    --- | ---
    `protected IndexMetadata` | CassandraIndex.`metadata`

    Methods in org.apache.cassandra.index.internal that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | CassandraIndex.`getIndexMetadata()`

    Methods in org.apache.cassandra.index.internal with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.util.concurrent.Callable<?>` | CassandraIndex.`getMetadataReloadTask(IndexMetadata indexDef)`
    `static CFMetaData` | CassandraIndex.`indexCfsMetadata(CFMetaData baseCfsMetadata, IndexMetadata indexMetadata)` Construct the CFMetadata for an index table, the clustering columns in the index table vary dependent on the kind of the indexed value.
    `static CassandraIndex` | CassandraIndex.`newIndex(ColumnFamilyStore baseCfs, IndexMetadata indexMetadata)` Factory method for new CassandraIndex instances
    `CassandraIndex` | CassandraIndexFunctions.`newIndexInstance(ColumnFamilyStore baseCfs, IndexMetadata indexMetadata)`

    Constructors in org.apache.cassandra.index.internal with parameters of type IndexMetadata
    Constructor and Description
    `CassandraIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index.internal.composites

    Constructors in org.apache.cassandra.index.internal.composites with parameters of type IndexMetadata
    Constructor and Description
    `ClusteringColumnIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `CollectionEntryIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `CollectionKeyIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `CollectionKeyIndexBase(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `CollectionValueIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `PartitionKeyIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`
    `RegularColumnIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index.internal.keys

    Constructors in org.apache.cassandra.index.internal.keys with parameters of type IndexMetadata
    Constructor and Description
    `KeysIndex(ColumnFamilyStore baseCfs, IndexMetadata indexDef)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index.sasi

    Methods in org.apache.cassandra.index.sasi that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | SASIIndex.`getIndexMetadata()`

    Methods in org.apache.cassandra.index.sasi with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.util.concurrent.Callable<?>` | SASIIndex.`getMetadataReloadTask(IndexMetadata indexMetadata)`

    Constructors in org.apache.cassandra.index.sasi with parameters of type IndexMetadata
    Constructor and Description
    `SASIIndex(ColumnFamilyStore baseCfs, IndexMetadata config)`

  - ### Uses of IndexMetadata in org.apache.cassandra.index.sasi.conf

    Method parameters in org.apache.cassandra.index.sasi.conf with type arguments of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `static IndexMode` | IndexMode.`getMode(ColumnDefinition column, java.util.Optional<IndexMetadata> config)`

    Constructors in org.apache.cassandra.index.sasi.conf with parameters of type IndexMetadata
    Constructor and Description
    `ColumnIndex(AbstractType<?> keyValidator, ColumnDefinition column, IndexMetadata metadata)`

  - ### Uses of IndexMetadata in org.apache.cassandra.schema

    Methods in org.apache.cassandra.schema that return IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `IndexMetadata` | IndexMetadata.Serializer.`deserialize(DataInputPlus in, int version, CFMetaData cfm)`
    `static IndexMetadata` | IndexMetadata.`fromIndexTargets(CFMetaData cfm, java.util.List<IndexTarget> targets, java.lang.String name, IndexMetadata.Kind kind, java.util.Map<java.lang.String,java.lang.String> options)`
    `static IndexMetadata` | IndexMetadata.`fromLegacyMetadata(CFMetaData cfm, ColumnDefinition column, java.lang.String name, IndexMetadata.Kind kind, java.util.Map<java.lang.String,java.lang.String> options)`
    `static IndexMetadata` | IndexMetadata.`fromSchemaMetadata(java.lang.String name, IndexMetadata.Kind kind, java.util.Map<java.lang.String,java.lang.String> options)`

    Methods in org.apache.cassandra.schema that return types with arguments of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `java.util.Optional<IndexMetadata>` | Indexes.`get(java.lang.String name)` Get the index with the specified name
    `java.util.Optional<IndexMetadata>` | Indexes.`get(java.util.UUID id)` Get the index with the specified id
    `java.util.Iterator<IndexMetadata>` | Indexes.`iterator()`

    Methods in org.apache.cassandra.schema with parameters of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `Indexes.Builder` | Indexes.Builder.`add(IndexMetadata index)`
    `boolean` | IndexMetadata.`equalsWithoutName(IndexMetadata other)`
    `Indexes` | Indexes.`replace(IndexMetadata index)` Creates a SecondaryIndexes instance which contains an updated index definition
    `void` | IndexMetadata.Serializer.`serialize(IndexMetadata metadata, DataOutputPlus out, int version)`
    `long` | IndexMetadata.Serializer.`serializedSize(IndexMetadata metadata, int version)`
    `Indexes` | Indexes.`with(IndexMetadata index)` Create a SecondaryIndexes instance with the provided index added

    Method parameters in org.apache.cassandra.schema with type arguments of type IndexMetadata
    Modifier and Type | Method and Description
    --- | ---
    `Indexes.Builder` | Indexes.Builder.`add(java.lang.Iterable<IndexMetadata> indexes)`

Copyright © 2018 The Apache Software Foundation