com.datastax.bdp.graph.api

Interface DseGraph

All Superinterfaces:

java.lang.AutoCloseable, org.apache.tinkerpop.gremlin.structure.Graph, org.apache.tinkerpop.gremlin.structure.util.Host

public interface DseGraph
extends org.apache.tinkerpop.gremlin.structure.Graph

A Datastax Graph. Allows access to config and schema.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DseGraph.Exceptions

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

org.apache.tinkerpop.gremlin.structure.Graph.Features, org.apache.tinkerpop.gremlin.structure.Graph.Hidden, org.apache.tinkerpop.gremlin.structure.Graph.OptIn, org.apache.tinkerpop.gremlin.structure.Graph.OptIns, org.apache.tinkerpop.gremlin.structure.Graph.OptOut, org.apache.tinkerpop.gremlin.structure.Graph.OptOuts, org.apache.tinkerpop.gremlin.structure.Graph.Variables

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME The key that represents the graph name that must be specified in the configuration.
static java.lang.String	USER The user name for the connection

Fields inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

GRAPH

Method Summary

Modifier and Type	Method and Description
boolean	getEffectiveAllowScan() Returns the allow_scan option value for this graph's internal, automatically-managed transaction.
boolean	isOpen() Checks whether the graph is open.
java.lang.String	name() Returns the name of this graph which uniquely identifies this graph within the cluster.
com.datastax.bdp.graph.api.schema.Schema	schema() Returns a schema handle for the graph schema.
SnapshotBuilder	snapshot() Returns a builder that makes durable snapshots of specific vertex and edge labels.

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

addVertex, addVertex, close, compute, compute, configuration, edges, features, io, traversal, traversal, tx, variables, vertices

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.util.Host

getHostingVertex

Field Detail

NAME

static final java.lang.String NAME

The key that represents the graph name that must be specified in the configuration.

See Also:

Constant Field Values

USER

static final java.lang.String USER

The user name for the connection

See Also:

Constant Field Values

Method Detail

name

java.lang.String name()

Returns the name of this graph which uniquely identifies this graph within the cluster.

Returns:

the name of this graph database

isOpen

boolean isOpen()

Checks whether the graph is open.

Returns:

true, if the graph is open, else false.

See Also:

Graph.close()

schema

com.datastax.bdp.graph.api.schema.Schema schema()

Returns a schema handle for the graph schema. This handle can be used to inspect the schema as well as modify it. The schema handle is tied to the current transactional context. In particular, any changes to the schema will only be migrated with the enclosing transaction commits.

Returns:

The schema of the graph.

snapshot

SnapshotBuilder snapshot()

Returns a builder that makes durable snapshots of specific vertex and edge labels.

Returns:

a new snapshot builder

getEffectiveAllowScan

boolean getEffectiveAllowScan()

Returns the allow_scan option value for this graph's internal, automatically-managed transaction. Schema.getEffectiveAllowScan() is preferred over this method. This method is only necessary when the user overrides the allow_scan value at the transaction level.