org.janusgraph.core

Interface JanusGraph

All Superinterfaces:

AutoCloseable, org.apache.tinkerpop.gremlin.structure.Graph, org.apache.tinkerpop.gremlin.structure.util.Host, SchemaInspector, SchemaManager, Transaction

All Known Implementing Classes:

JanusGraphBlueprintsGraph, StandardJanusGraph

public interface JanusGraph
extends Transaction

JanusGraph graph database implementation of the Blueprint's interface. Use JanusGraphFactory to open and configure JanusGraph instances.

Author:

Matthias Bröcheler (http://www.matthiasb.com)

See Also:

JanusGraphFactory, JanusGraphTransaction

Nested Class Summary

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

org.apache.tinkerpop.gremlin.structure.Graph.Exceptions, 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 inherited from interface org.apache.tinkerpop.gremlin.structure.Graph

GRAPH

Method Summary

Modifier and Type	Method and Description
TransactionBuilder	buildTransaction() Returns a TransactionBuilder to construct a new thread-independent JanusGraphTransaction.
void	close() Closes the graph database.
boolean	isClosed() Checks whether the graph is closed.
boolean	isOpen() Checks whether the graph is open.
static void	main(String[] args)
JanusGraphTransaction	newTransaction() Opens a new thread-independent JanusGraphTransaction.
JanusGraphManagement	openManagement() Returns the management system for this graph instance.
static String	version() The version of this JanusGraph graph database

Methods inherited from interface org.janusgraph.core.Transaction

addVertex, addVertex, indexQuery, multiQuery, multiQuery, query

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

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

Methods inherited from interface org.janusgraph.core.schema.SchemaManager

makeEdgeLabel, makePropertyKey, makeVertexLabel

Methods inherited from interface org.janusgraph.core.schema.SchemaInspector

containsEdgeLabel, containsPropertyKey, containsRelationType, containsVertexLabel, getEdgeLabel, getOrCreateEdgeLabel, getOrCreatePropertyKey, getOrCreatePropertyKey, getOrCreateVertexLabel, getPropertyKey, getRelationType, getVertexLabel

Method Detail

newTransaction

JanusGraphTransaction newTransaction()

Opens a new thread-independent JanusGraphTransaction.

The transaction is open when it is returned but MUST be explicitly closed by calling JanusGraphTransaction.commit() or JanusGraphTransaction.rollback() when it is no longer needed.

Note, that this returns a thread independent transaction object. It is not necessary to call this method to use Blueprint's standard transaction framework which will automatically start a transaction with the first operation on the graph.

Returns:

Transaction object representing a transactional context.

buildTransaction

TransactionBuilder buildTransaction()

Returns a TransactionBuilder to construct a new thread-independent JanusGraphTransaction.

Returns:

a new TransactionBuilder

See Also:

TransactionBuilder, newTransaction()

openManagement

JanusGraphManagement openManagement()

Returns the management system for this graph instance. The management system provides functionality to change global configuration options, install indexes and inspect the graph schema.

The management system operates in its own transactional context which must be explicitly closed.

Returns:

isOpen

boolean isOpen()

Checks whether the graph is open.

Returns:

true, if the graph is open, else false.

See Also:

close()

isClosed

boolean isClosed()

Checks whether the graph is closed.

Returns:

true, if the graph has been closed, else false

close

void close()
    throws JanusGraphException

Closes the graph database.

Closing the graph database causes a disconnect and possible closing of the underlying storage backend and a release of all occupied resources by this graph database. Closing a graph database requires that all open thread-independent transactions have been closed - otherwise they will be left abandoned.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.tinkerpop.gremlin.structure.Graph

Specified by:

close in interface Transaction

Throws:

JanusGraphException - if closing the graph database caused errors in the storage backend

version

static String version()

The version of this JanusGraph graph database

Returns:

main

static void main(String[] args)