com.datastax.driver.core

Class ColumnMetadata.IndexMetadata

java.lang.Object

com.datastax.driver.core.ColumnMetadata.IndexMetadata

Enclosing class:

ColumnMetadata

public static class ColumnMetadata.IndexMetadata
extends Object

Metadata on a column index.

Method Summary

Modifier and Type	Method and Description
String	asCQLQuery() Returns a CQL query representing this index.
String	getIndexClassName() The name of the class used to implement the custom index, if it is one.
ColumnMetadata	getIndexedColumn() Returns the column this index metadata refers to.
String	getName() Returns the index name.
String	getOption(String name) Return the value for the given option name.
boolean	isCustomIndex() Returns whether this index is a custom one.
boolean	isEntries() Return whether this index is a 'ENTRIES' index on a map, e.g., CREATE INDEX ON mytable (ENTRIES(mymap))
boolean	isFull() Return whether this index is a 'FULL' index on a frozen collection, e.g., CREATE INDEX ON mytable (FULL(mymap))
boolean	isKeys() Return whether this index is a 'KEYS' index on a map, e.g., CREATE INDEX ON mytable (KEYS(mymap))

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getIndexedColumn

public ColumnMetadata getIndexedColumn()

Returns the column this index metadata refers to.

Returns:

the column this index metadata refers to.

getName

public String getName()

Returns the index name.

Returns:

the index name.

isCustomIndex

public boolean isCustomIndex()

Returns whether this index is a custom one.

If it is indeed a custom index, getIndexClassName() will return the name of the class used in Cassandra to implement that index.

Returns:

true if this metadata represents a custom index.

getIndexClassName

public String getIndexClassName()

The name of the class used to implement the custom index, if it is one.

Returns:

the name of the class used Cassandra side to implement this custom index if isCustomIndex() == true, null otherwise.

isKeys

public boolean isKeys()

Return whether this index is a 'KEYS' index on a map, e.g., CREATE INDEX ON mytable (KEYS(mymap))

Returns:

true if this is a 'KEYS' index on a map.

isFull

public boolean isFull()

Return whether this index is a 'FULL' index on a frozen collection, e.g., CREATE INDEX ON mytable (FULL(mymap))

Returns:

true if this is a 'FULL' index on a frozen collection.

isEntries

public boolean isEntries()

Return whether this index is a 'ENTRIES' index on a map, e.g., CREATE INDEX ON mytable (ENTRIES(mymap))

Returns:

true if this is an 'ENTRIES' index on a map.

getOption

public String getOption(String name)

Return the value for the given option name.

Parameters:

name - Option name

Returns:

Option value

asCQLQuery

public String asCQLQuery()

Returns a CQL query representing this index. This method returns a single 'CREATE INDEX' query corresponding to this index definition.

Returns:

the 'CREATE INDEX' query corresponding to this index.