org.janusgraph.graphdb.database

Class StandardJanusGraph

java.lang.Object

org.janusgraph.graphdb.tinkerpop.JanusGraphBlueprintsGraph

org.janusgraph.graphdb.database.StandardJanusGraph

All Implemented Interfaces:

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

public class StandardJanusGraph
extends JanusGraphBlueprintsGraph

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

Modifier and Type	Field and Description
protected EdgeSerializer	edgeSerializer
protected IndexSerializer	indexSerializer
protected Serializer	serializer
SliceQuery	vertexExistenceQuery

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

GRAPH

Constructor Summary

Constructors

Constructor and Description
StandardJanusGraph(GraphDatabaseConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
static boolean	acquireLock(CompositeIndexType index, boolean acquireLocksConfig)
static boolean	acquireLock(InternalRelation relation, int pos, boolean acquireLocksConfig)
void	assignID(InternalRelation relation)
void	assignID(InternalVertex vertex, VertexLabel label)
StandardTransactionBuilder	buildTransaction() Returns a TransactionBuilder to construct a new thread-independent JanusGraphTransaction.
void	close() Closes the graph database.
void	closeTransaction(StandardJanusGraphTx tx)
void	commit(Collection<InternalRelation> addedRelations, Collection<InternalRelation> deletedRelations, StandardJanusGraphTx tx)
List<EntryList>	edgeMultiQuery(List<Object> vertexIdsAsObjects, SliceQuery query, BackendTransaction tx)
Map<SliceQuery,Map<Object,EntryList>>	edgeMultiQuery(MultiKeysQueryGroups<Object,SliceQuery> groupedMultiSliceQueries, BackendTransaction tx)
EntryList	edgeQuery(Object vid, SliceQuery query, BackendTransaction tx)
Object	eval(String gremlinScript, boolean commit) Evaluate a gremlin query in plain string format and return the result.
org.apache.tinkerpop.gremlin.structure.Graph.Features	features()
Backend	getBackend()
GraphDatabaseConfiguration	getConfiguration()
Serializer	getDataSerializer()
CacheInvalidationService	getDBCacheInvalidationService()
EdgeSerializer	getEdgeSerializer()
String	getGraphName()
IDManager	getIDManager()
IndexSelectionStrategy	getIndexSelector()
IndexSerializer	getIndexSerializer()
Set<? extends JanusGraphTransaction>	getOpenTransactions()
SchemaCache	getSchemaCache()
static int	getTTL(InternalRelation rel) The TTL of a relation (edge or property) is the minimum of: 1) The TTL configured of the relation type (if exists) 2) The TTL configured for the label any of the relation end point vertices (if exists)
static int	getTTL(InternalVertex v)
RecordIterator<Object>	getVertexIDs(BackendTransaction tx)
boolean	isClosed() Checks whether the graph is closed.
boolean	isOpen() Checks whether the graph is open.
JanusGraphTransaction	newThreadBoundTransaction()
JanusGraphTransaction	newTransaction() Opens a new thread-independent JanusGraphTransaction.
StandardJanusGraphTx	newTransaction(TransactionConfiguration configuration)
JanusGraphManagement	openManagement() Returns the management system for this graph instance.
org.janusgraph.graphdb.database.StandardJanusGraph.ModificationSummary	prepareCommit(Collection<InternalRelation> addedRelations, Collection<InternalRelation> deletedRelations, Predicate<InternalRelation> filter, BackendTransaction mutator, StandardJanusGraphTx tx, boolean acquireLocks)

Methods inherited from class org.janusgraph.graphdb.tinkerpop.JanusGraphBlueprintsGraph

addConnection, addProperties, addProperties, addVertex, addVertex, compute, compute, configuration, containsEdgeLabel, containsPropertyKey, containsRelationType, containsVertexLabel, edges, getCurrentThreadTx, getEdgeLabel, getOrCreateEdgeLabel, getOrCreatePropertyKey, getOrCreateVertexLabel, getPropertyKey, getRelationType, getVertexLabel, indexQuery, io, makeEdgeLabel, makePropertyKey, makeVertexLabel, mixedIndexAggQuery, multiQuery, multiQuery, query, toString, tx, variables, vertices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.janusgraph.core.JanusGraph

main, version

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

getServiceRegistry, traversal, traversal, tx

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

getHostingVertex

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

getOrCreatePropertyKey, getOrCreatePropertyKey

Field Detail

indexSerializer

protected final IndexSerializer indexSerializer

edgeSerializer

protected final EdgeSerializer edgeSerializer

serializer

protected final Serializer serializer

vertexExistenceQuery

public final SliceQuery vertexExistenceQuery

Constructor Detail

StandardJanusGraph

public StandardJanusGraph(GraphDatabaseConfiguration configuration)

Method Detail

getGraphName

public String getGraphName()

eval

public Object eval(String gremlinScript,
                   boolean commit)

Description copied from interface: JanusGraph

Evaluate a gremlin query in plain string format and return the result. With this API, those who use JanusGraph as an embedded library rather than JanusGraph server could execute gremlin queries in plain string format.

Parameters:

gremlinScript - A gremlin query in string format

commit - Whether the script shall be committed or rolled back

Returns:

Evaluation result

isOpen

public boolean isOpen()

Description copied from interface: JanusGraph

Checks whether the graph is open.

Returns:

true, if the graph is open, else false.

See Also:

JanusGraph.close()

isClosed

public boolean isClosed()

Description copied from interface: JanusGraph

Checks whether the graph is closed.

Returns:

true, if the graph has been closed, else false

close

public void close()
           throws JanusGraphException

Description copied from interface: JanusGraph

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 JanusGraph

Specified by:

close in interface Transaction

Overrides:

close in class JanusGraphBlueprintsGraph

Throws:

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

getDBCacheInvalidationService

public CacheInvalidationService getDBCacheInvalidationService()

features

public org.apache.tinkerpop.gremlin.structure.Graph.Features features()

getIndexSerializer

public IndexSerializer getIndexSerializer()

getIndexSelector

public IndexSelectionStrategy getIndexSelector()

getBackend

public Backend getBackend()

getIDManager

public IDManager getIDManager()

getEdgeSerializer

public EdgeSerializer getEdgeSerializer()

getDataSerializer

public Serializer getDataSerializer()

getSchemaCache

public SchemaCache getSchemaCache()

getConfiguration

public GraphDatabaseConfiguration getConfiguration()

openManagement

public JanusGraphManagement openManagement()

Description copied from interface: JanusGraph

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:

getOpenTransactions

public Set<? extends JanusGraphTransaction> getOpenTransactions()

newTransaction

public JanusGraphTransaction newTransaction()

Description copied from interface: JanusGraph

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

public StandardTransactionBuilder buildTransaction()

Description copied from interface: JanusGraph

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

Returns:

a new TransactionBuilder

See Also:

TransactionBuilder, JanusGraph.newTransaction()

newThreadBoundTransaction

public JanusGraphTransaction newThreadBoundTransaction()

Specified by:

newThreadBoundTransaction in class JanusGraphBlueprintsGraph

newTransaction

public StandardJanusGraphTx newTransaction(TransactionConfiguration configuration)

closeTransaction

public void closeTransaction(StandardJanusGraphTx tx)

getVertexIDs

public RecordIterator<Object> getVertexIDs(BackendTransaction tx)

edgeQuery

public EntryList edgeQuery(Object vid,
                           SliceQuery query,
                           BackendTransaction tx)

edgeMultiQuery

public List<EntryList> edgeMultiQuery(List<Object> vertexIdsAsObjects,
                                      SliceQuery query,
                                      BackendTransaction tx)

edgeMultiQuery

public Map<SliceQuery,Map<Object,EntryList>> edgeMultiQuery(MultiKeysQueryGroups<Object,SliceQuery> groupedMultiSliceQueries,
                                                            BackendTransaction tx)

assignID

public void assignID(InternalRelation relation)

assignID

public void assignID(InternalVertex vertex,
                     VertexLabel label)

acquireLock

public static boolean acquireLock(InternalRelation relation,
                                  int pos,
                                  boolean acquireLocksConfig)

acquireLock

public static boolean acquireLock(CompositeIndexType index,
                                  boolean acquireLocksConfig)

getTTL

public static int getTTL(InternalRelation rel)

The TTL of a relation (edge or property) is the minimum of: 1) The TTL configured of the relation type (if exists) 2) The TTL configured for the label any of the relation end point vertices (if exists)

Parameters:

rel - relation to determine the TTL for

Returns:

TTL

getTTL

public static int getTTL(InternalVertex v)

prepareCommit

public org.janusgraph.graphdb.database.StandardJanusGraph.ModificationSummary prepareCommit(Collection<InternalRelation> addedRelations,
                                                                                            Collection<InternalRelation> deletedRelations,
                                                                                            Predicate<InternalRelation> filter,
                                                                                            BackendTransaction mutator,
                                                                                            StandardJanusGraphTx tx,
                                                                                            boolean acquireLocks)
                                                                                     throws BackendException

Throws:

BackendException

commit

public void commit(Collection<InternalRelation> addedRelations,
                   Collection<InternalRelation> deletedRelations,
                   StandardJanusGraphTx tx)
            throws BackendException

Throws:

BackendException