com.datastax.bdp.graph.api.model.system

Interface GraphSystem

public interface GraphSystem

User facing interface that provides information on the graph system and all the graph instances that are available and provides methods to add and remove graphs in the cluster.

Method Summary

Modifier and Type	Method and Description
GraphBuilder	createGraph(java.lang.String graphName) Creates a new graph instance
void	dropGraph(java.lang.String graphName) Removes the graph of the specified name (and all its associated data as well as meta-data) from the cluster.
java.util.Set<java.lang.String>	getGraphs() Get all graph names in the cluster.
boolean	graphExists(java.lang.String graphName) Check if a graph exists.
void	truncateGraph(java.lang.String graphName) Removes all vertex, property and edge data belonging to the specified graph (meta-data is not affected) from the cluster.

Method Detail

getGraphs

java.util.Set<java.lang.String> getGraphs()

Get all graph names in the cluster.

Returns:

The names of all graphs in the cluster

graphExists

boolean graphExists(java.lang.String graphName)

Check if a graph exists.

Parameters:

graphName - The name of the graph to check

Returns:

TRUE, if a graph with the given name exists, else FALSE

createGraph

GraphBuilder createGraph(java.lang.String graphName)

Creates a new graph instance

Parameters:

graphName - The name of the graph to be created

Returns:

A GraphBuilder to construct the graph

dropGraph

void dropGraph(java.lang.String graphName)

Removes the graph of the specified name (and all its associated data as well as meta-data) from the cluster. THIS DATA CANNOT BE RECOVERED!!

Parameters:

graphName - The name of the graph to drop

truncateGraph

void truncateGraph(java.lang.String graphName)

Removes all vertex, property and edge data belonging to the specified graph (meta-data is not affected) from the cluster. THIS DATA CANNOT BE RECOVERED!!

Parameters:

graphName - The name of the graph to truncate