com.datastax.bdp.graph.api.model

Interface Schema

public interface Schema

Interface for defining the schema of a graph. Schema changes are only visible to the current transaction until the transaction is committed.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Schema.Mode The schema mode dictates how the schema may be changed and allows the user to control the tradeoff between flexibility and safety.

Method Summary

Modifier and Type	Method and Description
EdgeLabel.Builder	buildEdgeLabel(java.lang.String name) Build an edge label.
PropertyKey.Builder	buildPropertyKey(java.lang.String name, java.lang.Class<?> type) Build a property key that may be used on vertex labels or edge labels.
PropertyKey.Builder	buildPropertyKey(java.lang.String name, ValueType type) Build a property key that may be used on vertex labels or edge labels.
VertexLabel.Builder	buildVertexLabel(java.lang.String name) Build a vertex label.
GraphConfig	configuration()
void	drop() Drop all labels and property keys.
EdgeLabel	edgeLabel(java.lang.String name) Retrieve an edge label by name.
java.util.Collection<? extends EdgeLabel>	edgeLabels()
boolean	getEffectiveAllowScan() Get the effective value of the allow_scan option, considering graph-level configuration, the effective schema_mode value, and the default, in that order.
java.lang.String	getEffectiveSchemaMode() Get the effective value of the schema_mode option, considering graph-level configuration, dse.yaml configuration, and the default, in that order.
boolean	isStandardIdKey(PropertyKey key)
Schema.Mode	mode()
PropertyKey	propertyKey(java.lang.String name) Retrieve a property key by name.
java.util.Collection<? extends PropertyKey>	propertyKeys()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource	traversal() Start a traversal from the graph representation of this schema.
VertexLabel	vertexLabel(java.lang.String name) Retrieve a vertex label by name.
java.util.Collection<? extends VertexLabel>	vertexLabels()

Method Detail

propertyKey

PropertyKey propertyKey(java.lang.String name)

Retrieve a property key by name.

Parameters:

name - The name of the property key.

Returns:

The property key or null if it is not present.

vertexLabel

VertexLabel vertexLabel(java.lang.String name)

Retrieve a vertex label by name.

Parameters:

name - The name of the vertex label.

Returns:

The vertex label or null if it is not present.

edgeLabel

EdgeLabel edgeLabel(java.lang.String name)

Retrieve an edge label by name.

Parameters:

name - The name of the edge label.

Returns:

The edge label or null if it is not present.

vertexLabels

java.util.Collection<? extends VertexLabel> vertexLabels()

Returns:

All vertex labels defined.

edgeLabels

java.util.Collection<? extends EdgeLabel> edgeLabels()

Returns:

All edge labels defined.

propertyKeys

java.util.Collection<? extends PropertyKey> propertyKeys()

Returns:

All property keys defined.

mode

Schema.Mode mode()

Returns:

The mode of this schema.

buildPropertyKey

PropertyKey.Builder buildPropertyKey(java.lang.String name,
                                     ValueType type)

Build a property key that may be used on vertex labels or edge labels.

Parameters:

name - The name of the property key.

type - The data type of the property's value.

Returns:

The builder for the property. Note that PropertyKey.Builder.add() must be called for the property to be added.

buildPropertyKey

PropertyKey.Builder buildPropertyKey(java.lang.String name,
                                     java.lang.Class<?> type)

Build a property key that may be used on vertex labels or edge labels.

Parameters:

name - The name of the property key.

type - The data type of the property's value.

Returns:

The builder for the property. Note that PropertyKey.Builder.add() must be called for the property to be added.

buildVertexLabel

VertexLabel.Builder buildVertexLabel(java.lang.String name)

Build a vertex label.

Parameters:

name - The name of the vertex label.

Returns:

The builder for the vertex label. Note that VertexLabel.Builder.add() must be called for the vertex label to be added.

buildEdgeLabel

EdgeLabel.Builder buildEdgeLabel(java.lang.String name)

Build an edge label.

Parameters:

name - The name of the edge label.

Returns:

The builder for the edge label. Note that EdgeLabel.Builder.add() must be called for the edge label to be added.

drop

void drop()

Drop all labels and property keys.

traversal

org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal()

Start a traversal from the graph representation of this schema.

Returns:

The graph traversal.

configuration

GraphConfig configuration()

Returns:

The graph configuration for the graph associated with this schema. A schema commit triggers config changes to be persisted.

getEffectiveSchemaMode

java.lang.String getEffectiveSchemaMode()

Get the effective value of the schema_mode option, considering graph-level configuration, dse.yaml configuration, and the default, in that order.

getEffectiveAllowScan

boolean getEffectiveAllowScan()

Get the effective value of the allow_scan option, considering graph-level configuration, the effective schema_mode value, and the default, in that order. This method does not consider any transaction-level override that the user may have applied to the allow_scan option.

isStandardIdKey

boolean isStandardIdKey(PropertyKey key)