public interface Schema
| 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.
|
| 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() |
PropertyKey propertyKey(java.lang.String name)
name - The name of the property key.VertexLabel vertexLabel(java.lang.String name)
name - The name of the vertex label.EdgeLabel edgeLabel(java.lang.String name)
name - The name of the edge label.java.util.Collection<? extends VertexLabel> vertexLabels()
java.util.Collection<? extends EdgeLabel> edgeLabels()
java.util.Collection<? extends PropertyKey> propertyKeys()
Schema.Mode mode()
PropertyKey.Builder buildPropertyKey(java.lang.String name, ValueType type)
name - The name of the property key.type - The data type of the property's value.PropertyKey.Builder.add() must be called
for the property to be added.PropertyKey.Builder buildPropertyKey(java.lang.String name, java.lang.Class<?> type)
name - The name of the property key.type - The data type of the property's value.PropertyKey.Builder.add() must be called
for the property to be added.VertexLabel.Builder buildVertexLabel(java.lang.String name)
name - The name of the vertex label.VertexLabel.Builder.add() must be called
for the vertex label to be added.EdgeLabel.Builder buildEdgeLabel(java.lang.String name)
name - The name of the edge label.EdgeLabel.Builder.add() must be called
for the edge label to be added.void drop()
org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversalSource traversal()
GraphConfig configuration()
java.lang.String getEffectiveSchemaMode()
boolean getEffectiveAllowScan()
boolean isStandardIdKey(PropertyKey key)