com.thinkaurelius.titan.graphdb.database.management

Class ManagementSystem

java.lang.Object

com.thinkaurelius.titan.graphdb.database.management.ManagementSystem

All Implemented Interfaces:

SchemaInspector, SchemaManager, TitanConfiguration, TitanManagement

public class ManagementSystem
extends Object
implements TitanManagement

Author:

Matthias Broecheler (me@matthiasb.com), Joshua Shinavier (http://fortytwo.net)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ManagementSystem.IndexJobStatus

Nested classes/interfaces inherited from interface com.thinkaurelius.titan.core.schema.TitanManagement

TitanManagement.IndexJobFuture

Constructor Summary

Constructors

Constructor and Description
ManagementSystem(StandardTitanGraph graph, KCVSConfiguration config, Log sysLog, ManagementLogger mgmtLogger, SchemaCache schemaCache)

Method Summary

Modifier and Type	Method and Description
void	addIndexKey(TitanGraphIndex index, PropertyKey key, Parameter... parameters)
static GraphIndexStatusWatcher	awaitGraphIndexStatus(TitanGraph g, String graphIndexName) Returns a GraphIndexStatusWatcher configured to watch graphIndexName through graph g.
static RelationIndexStatusWatcher	awaitRelationIndexStatus(TitanGraph g, String relationIndexName, String relationTypeName) Returns a RelationIndexStatusWatcher configured to watch the index specified by relationIndexName and relationIndexType through graph g.
RelationTypeIndex	buildEdgeIndex(EdgeLabel label, String name, org.apache.tinkerpop.gremlin.structure.Direction direction, org.apache.tinkerpop.gremlin.process.traversal.Order sortOrder, PropertyKey... sortKeys) Creates a RelationTypeIndex for the provided edge label.
RelationTypeIndex	buildEdgeIndex(EdgeLabel label, String name, org.apache.tinkerpop.gremlin.structure.Direction direction, PropertyKey... sortKeys) Identical to #buildEdgeIndex(com.thinkaurelius.titan.core.EdgeLabel, String, com.tinkerpop.gremlin.structure.Direction, com.tinkerpop.gremlin.structure.Order, com.thinkaurelius.titan.core.PropertyKey...) with default sort order Order.incr.
TitanManagement.IndexBuilder	buildIndex(String indexName, Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType) Returns an TitanManagement.IndexBuilder to add a graph index to this Titan graph.
RelationTypeIndex	buildPropertyIndex(PropertyKey key, String name, org.apache.tinkerpop.gremlin.process.traversal.Order sortOrder, PropertyKey... sortKeys) Creates a RelationTypeIndex for the provided property key.
RelationTypeIndex	buildPropertyIndex(PropertyKey key, String name, PropertyKey... sortKeys) Identical to #buildPropertyIndex(com.thinkaurelius.titan.core.PropertyKey, String, com.tinkerpop.gremlin.structure.Order, com.thinkaurelius.titan.core.PropertyKey...) with default sort order com.tinkerpop.gremlin.structure.Order#incr.
void	changeName(TitanSchemaElement element, String newName) Changes the name of a TitanSchemaElement to the provided new name.
void	commit() Commits this management transaction and persists all schema changes.
boolean	containsEdgeLabel(String name) Checks whether an edge label of the given name has been defined in the Titan schema.
boolean	containsGraphIndex(String name) Whether the graph has a graph index defined with the given name.
boolean	containsPropertyKey(String name) Checks whether a property key of the given name has been defined in the Titan schema.
boolean	containsRelationIndex(RelationType type, String name) Whether a RelationTypeIndex with the given name has been defined for the provided RelationType
boolean	containsRelationType(String name) Checks whether a type with the specified name exists.
boolean	containsVertexLabel(String name) Whether a vertex label with the given name exists in the graph.
void	forceCloseInstance(String instanceId) Forcefully removes a Titan instance from this graph cluster as identified by its name.
String	get(String path) Returns a string representation of the provided configuration option or namespace for inspection.
ConsistencyModifier	getConsistency(TitanSchemaElement element) Retrieves the consistency level for a schema element (types and internal indexes)
EdgeLabel	getEdgeLabel(String name) Returns the edge label with the given name.
TitanGraphIndex	getGraphIndex(String name) Returns the graph index with the given name or null if it does not exist
static IndexType	getGraphIndexDirect(String name, StandardTitanTx transaction)
Iterable<TitanGraphIndex>	getGraphIndexes(Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType) Returns all graph indexes that index the given element type.
TitanManagement.IndexJobFuture	getIndexJobStatus(TitanIndex index) If an index update job was triggered through TitanManagement.updateIndex(TitanIndex, SchemaAction) with schema actions SchemaAction.REINDEX or SchemaAction.REMOVE_INDEX then this method can be used to track the status of this asynchronous process.
Set<String>	getOpenInstances() Returns a set of unique instance ids for all Titan instances that are currently part of this graph cluster.
Set<String>	getOpenInstancesInternal()
EdgeLabel	getOrCreateEdgeLabel(String name) Returns the edge label with the given name.
PropertyKey	getOrCreatePropertyKey(String name) Returns the property key with the given name.
VertexLabel	getOrCreateVertexLabel(String name) Returns the vertex label with the given name.
PropertyKey	getPropertyKey(String name) Returns the property key with the given name.
RelationTypeIndex	getRelationIndex(RelationType type, String name) Returns the RelationTypeIndex with the given name for the provided RelationType or null if it does not exist
Iterable<RelationTypeIndex>	getRelationIndexes(RelationType type) Returns an Iterable over all RelationTypeIndexes defined for the provided RelationType
RelationType	getRelationType(String name) Returns the type with the given name.
<T extends RelationType> Iterable<T>	getRelationTypes(Class<T> clazz) Returns an iterable over all defined types that have the given clazz (either EdgeLabel which returns all labels, PropertyKey which returns all keys, or RelationType which returns all types).
TitanSchemaElement	getSchemaElement(long id)
TitanSchemaVertex	getSchemaVertex(TitanSchemaElement element)
java.time.Duration	getTTL(TitanSchemaType type) Retrieves the time-to-live for the given TitanSchemaType as a Duration.
VertexLabel	getVertexLabel(String name) Returns the vertex label with the given name.
Iterable<VertexLabel>	getVertexLabels() Returns an Iterable over all defined VertexLabels.
StandardTitanTx	getWrappedTx()
boolean	isOpen() Whether this management transaction is open or has been closed (i.e.
EdgeLabelMaker	makeEdgeLabel(String name) Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name.
PropertyKeyMaker	makePropertyKey(String name) Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name.
VertexLabelMaker	makeVertexLabel(String name) Returns a VertexLabelMaker to define a new vertex label with the given name.
void	rollback() Closes this management transaction and discards all changes.
TitanConfiguration	set(String path, Object value) Sets the configuration option identified by the provided path to the given value.
void	setConsistency(TitanSchemaElement element, ConsistencyModifier consistency) Sets the consistency level for those schema elements that support it (types and internal indexes)
void	setTTL(TitanSchemaType type, java.time.Duration duration) Sets time-to-live for those schema types that support it
TitanManagement.IndexJobFuture	updateIndex(TitanIndex index, SchemaAction updateAction) Updates the provided index according to the given SchemaAction

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagementSystem

public ManagementSystem(StandardTitanGraph graph,
                        KCVSConfiguration config,
                        Log sysLog,
                        ManagementLogger mgmtLogger,
                        SchemaCache schemaCache)

Method Detail

getOpenInstancesInternal

public Set<String> getOpenInstancesInternal()

getOpenInstances

public Set<String> getOpenInstances()

Description copied from interface: TitanManagement

Returns a set of unique instance ids for all Titan instances that are currently part of this graph cluster.

Specified by:

getOpenInstances in interface TitanManagement

Returns:

forceCloseInstance

public void forceCloseInstance(String instanceId)

Description copied from interface: TitanManagement

Forcefully removes a Titan instance from this graph cluster as identified by its name.

This method should be used with great care and only in cases where a Titan instance has been abnormally terminated (i.e. killed instead of properly shut-down). If this happens, the instance will continue to be listed as an open instance which means that 1) a new instance with the same id cannot be started and 2) schema updates will fail because the killed instance cannot acknowledge the schema update.

Throws an exception if the instance is not part of this cluster or if the instance has been started after the start of this management transaction which is indicative of the instance having been restarted successfully.

Specified by:

forceCloseInstance in interface TitanManagement

commit

public void commit()

Description copied from interface: TitanManagement

Commits this management transaction and persists all schema changes. Closes this transaction.

Specified by:

commit in interface TitanManagement

See Also:

TitanTransaction.commit()

rollback

public void rollback()

Description copied from interface: TitanManagement

Closes this management transaction and discards all changes.

Specified by:

rollback in interface TitanManagement

See Also:

TitanTransaction.rollback()

isOpen

public boolean isOpen()

Description copied from interface: TitanManagement

Whether this management transaction is open or has been closed (i.e. committed or rolled-back)

Specified by:

isOpen in interface TitanManagement

Returns:

getWrappedTx

public StandardTitanTx getWrappedTx()

getSchemaElement

public TitanSchemaElement getSchemaElement(long id)

buildEdgeIndex

public RelationTypeIndex buildEdgeIndex(EdgeLabel label,
                                        String name,
                                        org.apache.tinkerpop.gremlin.structure.Direction direction,
                                        PropertyKey... sortKeys)

Description copied from interface: TitanManagement

Identical to #buildEdgeIndex(com.thinkaurelius.titan.core.EdgeLabel, String, com.tinkerpop.gremlin.structure.Direction, com.tinkerpop.gremlin.structure.Order, com.thinkaurelius.titan.core.PropertyKey...) with default sort order Order.incr.

Specified by:

buildEdgeIndex in interface TitanManagement

Returns:

the created RelationTypeIndex

buildEdgeIndex

public RelationTypeIndex buildEdgeIndex(EdgeLabel label,
                                        String name,
                                        org.apache.tinkerpop.gremlin.structure.Direction direction,
                                        org.apache.tinkerpop.gremlin.process.traversal.Order sortOrder,
                                        PropertyKey... sortKeys)

Description copied from interface: TitanManagement

Creates a RelationTypeIndex for the provided edge label. That means, that all edges of that label will be indexed according to this index definition which will speed up certain vertex-centric queries.

An indexed is defined by its name, the direction in which the index should be created (can be restricted to one direction or both), the sort order and - most importantly - the sort keys which define the index key.

Specified by:

buildEdgeIndex in interface TitanManagement

Returns:

the created RelationTypeIndex

buildPropertyIndex

public RelationTypeIndex buildPropertyIndex(PropertyKey key,
                                            String name,
                                            PropertyKey... sortKeys)

Description copied from interface: TitanManagement

Identical to #buildPropertyIndex(com.thinkaurelius.titan.core.PropertyKey, String, com.tinkerpop.gremlin.structure.Order, com.thinkaurelius.titan.core.PropertyKey...) with default sort order com.tinkerpop.gremlin.structure.Order#incr.

Specified by:

buildPropertyIndex in interface TitanManagement

Returns:

the created RelationTypeIndex

buildPropertyIndex

public RelationTypeIndex buildPropertyIndex(PropertyKey key,
                                            String name,
                                            org.apache.tinkerpop.gremlin.process.traversal.Order sortOrder,
                                            PropertyKey... sortKeys)

Description copied from interface: TitanManagement

Creates a RelationTypeIndex for the provided property key. That means, that all properties of that key will be indexed according to this index definition which will speed up certain vertex-centric queries.

An indexed is defined by its name, the sort order and - most importantly - the sort keys which define the index key.

Specified by:

buildPropertyIndex in interface TitanManagement

Returns:

the created RelationTypeIndex

containsRelationIndex

public boolean containsRelationIndex(RelationType type,
                                     String name)

Description copied from interface: TitanManagement

Whether a RelationTypeIndex with the given name has been defined for the provided RelationType

Specified by:

containsRelationIndex in interface TitanManagement

Returns:

getRelationIndex

public RelationTypeIndex getRelationIndex(RelationType type,
                                          String name)

Description copied from interface: TitanManagement

Returns the RelationTypeIndex with the given name for the provided RelationType or null if it does not exist

Specified by:

getRelationIndex in interface TitanManagement

Returns:

getRelationIndexes

public Iterable<RelationTypeIndex> getRelationIndexes(RelationType type)

Description copied from interface: TitanManagement

Returns an Iterable over all RelationTypeIndexes defined for the provided RelationType

Specified by:

getRelationIndexes in interface TitanManagement

Returns:

getGraphIndexDirect

public static IndexType getGraphIndexDirect(String name,
                                            StandardTitanTx transaction)

containsGraphIndex

public boolean containsGraphIndex(String name)

Description copied from interface: TitanManagement

Whether the graph has a graph index defined with the given name.

Specified by:

containsGraphIndex in interface TitanManagement

Returns:

getGraphIndex

public TitanGraphIndex getGraphIndex(String name)

Description copied from interface: TitanManagement

Returns the graph index with the given name or null if it does not exist

Specified by:

getGraphIndex in interface TitanManagement

Returns:

getGraphIndexes

public Iterable<TitanGraphIndex> getGraphIndexes(Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)

Description copied from interface: TitanManagement

Returns all graph indexes that index the given element type.

Specified by:

getGraphIndexes in interface TitanManagement

Returns:

awaitGraphIndexStatus

public static GraphIndexStatusWatcher awaitGraphIndexStatus(TitanGraph g,
                                                            String graphIndexName)

Returns a GraphIndexStatusWatcher configured to watch graphIndexName through graph g.

This method just instantiates an object. Invoke GraphIndexStatusWatcher.call() to wait.

Parameters:

g - the graph through which to read index information

graphIndexName - the name of a graph index to watch

Returns:

awaitRelationIndexStatus

public static RelationIndexStatusWatcher awaitRelationIndexStatus(TitanGraph g,
                                                                  String relationIndexName,
                                                                  String relationTypeName)

Returns a RelationIndexStatusWatcher configured to watch the index specified by relationIndexName and relationIndexType through graph g.

This method just instantiates an object. Invoke RelationIndexStatusWatcher.call() to wait.

Parameters:

g - the graph through which to read index information

relationIndexName - the name of the relation index to watch

relationTypeName - the type on the relation index to watch

Returns:

addIndexKey

public void addIndexKey(TitanGraphIndex index,
                        PropertyKey key,
                        Parameter... parameters)

Specified by:

addIndexKey in interface TitanManagement

buildIndex

public TitanManagement.IndexBuilder buildIndex(String indexName,
                                               Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)

Description copied from interface: TitanManagement

Returns an TitanManagement.IndexBuilder to add a graph index to this Titan graph. The index to-be-created has the provided name and indexes elements of the given type.

Specified by:

buildIndex in interface TitanManagement

Returns:

updateIndex

public TitanManagement.IndexJobFuture updateIndex(TitanIndex index,
                                                  SchemaAction updateAction)

Description copied from interface: TitanManagement

Updates the provided index according to the given SchemaAction

Specified by:

updateIndex in interface TitanManagement

Returns:

a future that completes when the index action is done

getIndexJobStatus

public TitanManagement.IndexJobFuture getIndexJobStatus(TitanIndex index)

Description copied from interface: TitanManagement

If an index update job was triggered through TitanManagement.updateIndex(TitanIndex, SchemaAction) with schema actions SchemaAction.REINDEX or SchemaAction.REMOVE_INDEX then this method can be used to track the status of this asynchronous process.

Specified by:

getIndexJobStatus in interface TitanManagement

Returns:

A message that reflects the status of the index job

changeName

public void changeName(TitanSchemaElement element,
                       String newName)

Description copied from interface: TitanManagement

Changes the name of a TitanSchemaElement to the provided new name. The new name must be valid and not already in use, otherwise an IllegalArgumentException is thrown.

Specified by:

changeName in interface TitanManagement

getSchemaVertex

public TitanSchemaVertex getSchemaVertex(TitanSchemaElement element)

getConsistency

public ConsistencyModifier getConsistency(TitanSchemaElement element)

Retrieves the consistency level for a schema element (types and internal indexes)

Specified by:

getConsistency in interface TitanManagement

Parameters:

element -

Returns:

setConsistency

public void setConsistency(TitanSchemaElement element,
                           ConsistencyModifier consistency)

Sets the consistency level for those schema elements that support it (types and internal indexes)

Note, that it is possible to have a race condition here if two threads simultaneously try to change the consistency level. However, this is resolved when the consistency level is being read by taking the first one and deleting all existing attached consistency levels upon modification.

Specified by:

setConsistency in interface TitanManagement

Parameters:

element -

consistency -

getTTL

public java.time.Duration getTTL(TitanSchemaType type)

Description copied from interface: TitanManagement

Retrieves the time-to-live for the given TitanSchemaType as a Duration. If no TTL has been defined, the returned Duration will be zero-length ("lives forever").

Specified by:

getTTL in interface TitanManagement

Returns:

setTTL

public void setTTL(TitanSchemaType type,
                   java.time.Duration duration)

Sets time-to-live for those schema types that support it

Specified by:

setTTL in interface TitanManagement

Parameters:

type -

duration - Note that only 'seconds' granularity is supported

containsRelationType

public boolean containsRelationType(String name)

Description copied from interface: SchemaInspector

Checks whether a type with the specified name exists.

Specified by:

containsRelationType in interface SchemaInspector

Parameters:

name - name of the type

Returns:

true, if a type with the given name exists, else false

getRelationType

public RelationType getRelationType(String name)

Description copied from interface: SchemaInspector

Returns the type with the given name. Note, that type names must be unique.

Specified by:

getRelationType in interface SchemaInspector

Parameters:

name - name of the type to return

Returns:

The type with the given name, or null if such does not exist

See Also:

RelationType

containsPropertyKey

public boolean containsPropertyKey(String name)

Description copied from interface: SchemaInspector

Checks whether a property key of the given name has been defined in the Titan schema.

Specified by:

containsPropertyKey in interface SchemaInspector

Parameters:

name - name of the property key

Returns:

true, if the property key exists, else false

getPropertyKey

public PropertyKey getPropertyKey(String name)

Description copied from interface: SchemaInspector

Returns the property key with the given name. If it does not exist, NULL is returned

Specified by:

getPropertyKey in interface SchemaInspector

Returns:

containsEdgeLabel

public boolean containsEdgeLabel(String name)

Description copied from interface: SchemaInspector

Checks whether an edge label of the given name has been defined in the Titan schema.

Specified by:

containsEdgeLabel in interface SchemaInspector

Parameters:

name - name of the edge label

Returns:

true, if the edge label exists, else false

getOrCreateEdgeLabel

public EdgeLabel getOrCreateEdgeLabel(String name)

Description copied from interface: SchemaInspector

Returns the edge label with the given name. If automatic type making is enabled, it will make the edge label using the configured default type maker if a label with the given name does not exist.

Specified by:

getOrCreateEdgeLabel in interface SchemaInspector

Parameters:

name - name of the edge label to return

Returns:

the edge label with the given name

See Also:

EdgeLabel

getOrCreatePropertyKey

public PropertyKey getOrCreatePropertyKey(String name)

Description copied from interface: SchemaInspector

Returns the property key with the given name. If automatic type making is enabled, it will make the property key using the configured default type maker if a key with the given name does not exist.

Specified by:

getOrCreatePropertyKey in interface SchemaInspector

Parameters:

name - name of the property key to return

Returns:

the property key with the given name

See Also:

PropertyKey

getEdgeLabel

public EdgeLabel getEdgeLabel(String name)

Description copied from interface: SchemaInspector

Returns the edge label with the given name. If it does not exist, NULL is returned

Specified by:

getEdgeLabel in interface SchemaInspector

Returns:

makePropertyKey

public PropertyKeyMaker makePropertyKey(String name)

Description copied from interface: SchemaManager

Returns a PropertyKeyMaker instance to define a new PropertyKey with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the key and associated consistency constraints.

The key constructed with this maker will be created in the context of this transaction.

Specified by:

makePropertyKey in interface SchemaManager

Returns:

a PropertyKeyMaker linked to this transaction.

See Also:

PropertyKeyMaker, PropertyKey

makeEdgeLabel

public EdgeLabelMaker makeEdgeLabel(String name)

Description copied from interface: SchemaManager

Returns a EdgeLabelMaker instance to define a new EdgeLabel with the given name. By defining types explicitly (rather than implicitly through usage) one can control various aspects of the label and associated consistency constraints.

The label constructed with this maker will be created in the context of this transaction.

Specified by:

makeEdgeLabel in interface SchemaManager

Returns:

a EdgeLabelMaker linked to this transaction.

See Also:

EdgeLabelMaker, EdgeLabel

getRelationTypes

public <T extends RelationType> Iterable<T> getRelationTypes(Class<T> clazz)

Description copied from interface: TitanManagement

Returns an iterable over all defined types that have the given clazz (either EdgeLabel which returns all labels, PropertyKey which returns all keys, or RelationType which returns all types).

Specified by:

getRelationTypes in interface TitanManagement

Parameters:

clazz - RelationType or sub-interface

Returns:

Iterable over all types for the given category (label, key, or both)

containsVertexLabel

public boolean containsVertexLabel(String name)

Description copied from interface: SchemaInspector

Whether a vertex label with the given name exists in the graph.

Specified by:

containsVertexLabel in interface SchemaInspector

Returns:

getVertexLabel

public VertexLabel getVertexLabel(String name)

Description copied from interface: SchemaInspector

Returns the vertex label with the given name. If such does not exist, NULL is returned.

Specified by:

getVertexLabel in interface SchemaInspector

Returns:

getOrCreateVertexLabel

public VertexLabel getOrCreateVertexLabel(String name)

Description copied from interface: SchemaInspector

Returns the vertex label with the given name. If a vertex label with this name does not exist, the label is automatically created through the registered DefaultSchemaMaker.

Attempting to automatically create a vertex label might cause an exception depending on the configuration.

Specified by:

getOrCreateVertexLabel in interface SchemaInspector

Returns:

makeVertexLabel

public VertexLabelMaker makeVertexLabel(String name)

Description copied from interface: SchemaManager

Returns a VertexLabelMaker to define a new vertex label with the given name. Note, that the name must be unique.

Specified by:

makeVertexLabel in interface SchemaManager

Returns:

getVertexLabels

public Iterable<VertexLabel> getVertexLabels()

Description copied from interface: TitanManagement

Returns an Iterable over all defined VertexLabels.

Specified by:

getVertexLabels in interface TitanManagement

Returns:

get

public String get(String path)

Description copied from interface: TitanConfiguration

Returns a string representation of the provided configuration option or namespace for inspection.

An exception is thrown if the path is invalid.

Specified by:

get in interface TitanConfiguration

Returns:

set

public TitanConfiguration set(String path,
                              Object value)

Description copied from interface: TitanConfiguration

Sets the configuration option identified by the provided path to the given value.

Specified by:

set in interface TitanConfiguration