public class IndexMetadata extends Object
Modifier and Type | Class and Description |
---|---|
static class |
IndexMetadata.Kind |
Modifier and Type | Field and Description |
---|---|
static String |
CUSTOM_INDEX_OPTION_NAME
The name of the option used to specify a custom index class name.
|
static String |
INDEX_ENTRIES_OPTION_NAME
The name of the option used to specify that the index is on the collection (map) entries.
|
static String |
INDEX_KEYS_OPTION_NAME
The name of the option used to specify that the index is on the collection (map) keys.
|
static String |
TARGET_OPTION_NAME
The name of the option used to specify the index target (Cassandra 3.0 onwards).
|
Modifier and Type | Method and Description |
---|---|
String |
asCQLQuery()
Returns a CQL query representing this index.
|
boolean |
equals(Object obj) |
String |
getIndexClassName()
The name of the class used to implement the custom index, if it is one.
|
IndexMetadata.Kind |
getKind()
Returns the index kind.
|
String |
getName()
Returns the index name.
|
String |
getOption(String name)
Return the value for the given option name.
|
TableMetadata |
getTable()
Returns the metadata of the table this index is part of.
|
String |
getTarget()
Returns the index target.
|
int |
hashCode() |
boolean |
isCustomIndex()
Returns whether this index is a custom one.
|
public static final String TARGET_OPTION_NAME
public static final String CUSTOM_INDEX_OPTION_NAME
public static final String INDEX_KEYS_OPTION_NAME
public static final String INDEX_ENTRIES_OPTION_NAME
public TableMetadata getTable()
public String getName()
public IndexMetadata.Kind getKind()
public String getTarget()
public boolean isCustomIndex()
getIndexClassName()
will
return the name of the class used in Cassandra to implement that
index.true
if this metadata represents a custom index.public String getIndexClassName()
isCustomIndex() == true
, null
otherwise.public String getOption(String name)
name
- Option namepublic String asCQLQuery()
Copyright © 2012–2017. All rights reserved.