com.datastax.bdp.graph.api.model

Interface VertexIndex

All Superinterfaces:

Identified, Named

public interface VertexIndex
extends Named, Identified

Vertex indexes allow quick retrieval of vertices by particular property keys through gremlin queries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VertexIndex.Builder
static interface	VertexIndex.IndexOption Options that determine how properties are being indexed
static class	VertexIndex.Type DSE Graph supports the following types of indexes which are distinguished by their underlying index structures.

Method Summary

Modifier and Type	Method and Description
void	drop() Drops the index
void	dropPropertyKey(java.lang.String propertyKey) Drops the property key from this index.
VertexIndex.Type	getType()
boolean	isUnique() Whether this index is a unique index, i.e.
java.util.Set<? extends IndexedPropertyKey>	propertyKeys()
VertexLabel	vertexLabel()

Methods inherited from interface com.datastax.bdp.graph.api.Named

name

Methods inherited from interface com.datastax.bdp.graph.api.Identified

id

Method Detail

propertyKeys

java.util.Set<? extends IndexedPropertyKey> propertyKeys()

Returns:

The PropertyKey's by which the vertex is indexed

getType

VertexIndex.Type getType()

Returns:

the type of this index

isUnique

boolean isUnique()

Whether this index is a unique index, i.e. it should only return at most one result per index hit.

Returns:

vertexLabel

VertexLabel vertexLabel()

Returns:

The vertex label that is indexed

drop

void drop()

Drops the index

dropPropertyKey

void dropPropertyKey(java.lang.String propertyKey)

Drops the property key from this index. Only supported for VertexIndex.Type.Search indexes.

Parameters:

propertyKey - Drop the property key from this index