ManagementSystem (JanusGraph-Core: Core Library for JanusGraph 1.0.0 API)

java.lang.Object
- org.janusgraph.graphdb.database.management.ManagementSystem

All Implemented Interfaces:

JanusGraphConfiguration, JanusGraphManagement, SchemaInspector, SchemaManager
```
public class ManagementSystem
extends Object
implements JanusGraphManagement
```
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
Modifier and Type	Class and Description
`static class`	`ManagementSystem.IndexJobStatus`

Field Summary

Fields
Modifier and Type Field and Description

static String CURRENT_INSTANCE_SUFFIX

Fields
Modifier and Type	Field and Description
`static String`	`CURRENT_INSTANCE_SUFFIX`

Constructor Summary

Constructors
Constructor and Description
`ManagementSystem(StandardJanusGraph graph, KCVSConfiguration config, Log sysLog, ManagementLogger managementLogger, SchemaCache schemaCache)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EdgeLabel`	`addConnection(EdgeLabel edgeLabel, VertexLabel outVLabel, VertexLabel inVLabel)` Add a constraint on which vertices the given edge label can connect.
`void`	`addIndexKey(JanusGraphIndex index, PropertyKey key, Parameter... parameters)`
`EdgeLabel`	`addProperties(EdgeLabel edgeLabel, PropertyKey... keys)` Add property constraints for a given edge label.
`VertexLabel`	`addProperties(VertexLabel vertexLabel, PropertyKey... keys)` Add property constraints for a given vertex label.
`static GraphIndexStatusWatcher`	`awaitGraphIndexStatus(JanusGraph g, String graphIndexName)` Returns a `GraphIndexStatusWatcher` configured to watch `graphIndexName` through graph `g`.
`static RelationIndexStatusWatcher`	`awaitRelationIndexStatus(JanusGraph 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 `JanusGraphManagement.buildEdgeIndex(org.janusgraph.core.EdgeLabel, String, org.apache.tinkerpop.gremlin.structure.Direction, org.apache.tinkerpop.gremlin.process.traversal.Order, org.janusgraph.core.PropertyKey...)` with default sort order `Order.asc`.
`JanusGraphManagement.IndexBuilder`	`buildIndex(String indexName, Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)` Returns an `JanusGraphManagement.IndexBuilder` to add a graph index to this JanusGraph 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 `JanusGraphManagement.buildPropertyIndex(org.janusgraph.core.PropertyKey, String, org.apache.tinkerpop.gremlin.process.traversal.Order, org.janusgraph.core.PropertyKey...)` with default sort order `Order.asc`.
`void`	`changeName(JanusGraphSchemaElement element, String newName)` Changes the name of a `JanusGraphSchemaElement` 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 JanusGraph 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 JanusGraph 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`	`evictGraphFromCache()` Upon the open managementsystem's commit, this graph will be asynchronously evicted from the cache on all JanusGraph nodes in your cluster, once there are no open transactions on this graph on each respective JanusGraph node and assuming each node is correctly configured to use the `JanusGraphManager`.
`void`	`evictGraphFromCache(Callable<Boolean> trigger)` Upon the open managementsystem's commit, this graph will be asynchronously evicted from the cache on all JanusGraph nodes in your cluster, once there are no open transactions on this graph on each respective JanusGraph node and assuming each node is correctly configured to use the `JanusGraphManager`.
`void`	`forceCloseInstance(String instanceId)` Forcefully removes a JanusGraph 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(JanusGraphSchemaElement 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.
`JanusGraphIndex`	`getGraphIndex(String name)` Returns the graph index with the given name or null if it does not exist
`static IndexType`	`getGraphIndexDirect(String name, StandardJanusGraphTx transaction)`
`Iterable<JanusGraphIndex>`	`getGraphIndexes(Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)` Returns all graph indexes that index the given element type.
`ScanJobFuture`	`getIndexJobStatus(Index index)` If an index update job was triggered through `JanusGraphManagement.updateIndex(Index, SchemaAction)` with schema actions `SchemaAction.REINDEX` or `SchemaAction.DISCARD_INDEX` then this method can be used to track the status of this asynchronous process.
`JanusGraphSchemaType`	`getIndexOnlyConstraint(String indexName)` Returns the indexOnly constraint for the index with given name or null if such constraint does not exist
`Set<String>`	`getOpenInstances()` Returns a set of unique instance ids for all JanusGraph 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 `RelationTypeIndex`es 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).
`JanusGraphSchemaElement`	`getSchemaElement(long id)`
`JanusGraphSchemaVertex`	`getSchemaVertex(JanusGraphSchemaElement element)`
`Duration`	`getTTL(JanusGraphSchemaType type)` Retrieves the time-to-live for the given `JanusGraphSchemaType` as a `Duration`.
`VertexLabel`	`getVertexLabel(String name)` Returns the vertex label with the given name.
`Iterable<VertexLabel>`	`getVertexLabels()` Returns an `Iterable` over all defined `VertexLabel`s.
`StandardJanusGraphTx`	`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.
`String`	`printEdgeLabels()` Prints out schema information related to edge labels.
`String`	`printIndexes()` Prints out schema information related to indexes
`String`	`printPropertyKeys()` Prints out schema information related to property keys.
`String`	`printSchema()` Prints out schema information related to vertex and edge labels, indexes, and property keys.
`String`	`printVertexLabels()` Prints out schema information related to vertex labels.
`JanusGraphConfiguration`	`remove(String path)` Remove the configuration option identified by the provided path.
`ScanJobFuture`	`removeGhostVertices()` Remove all ghost vertices (a.k.a.
`ScanJobFuture`	`removeGhostVertices(int numOfThreads)` Remove all ghost vertices (a.k.a.
`void`	`rollback()` Closes this management transaction and discards all changes.
`JanusGraphConfiguration`	`set(String path, Object value)` Sets the configuration option identified by the provided path to the given value.
`void`	`setConsistency(JanusGraphSchemaElement element, ConsistencyModifier consistency)` Sets the consistency level for those schema elements that support it (types and internal indexes)
`void`	`setTTL(JanusGraphSchemaType type, Duration duration)` Sets time-to-live for those schema types that support it
`ScanJobFuture`	`updateIndex(Index index, SchemaAction updateAction)` Updates the provided index according to the given `SchemaAction`.
`ScanJobFuture`	`updateIndex(Index index, SchemaAction updateAction, int numOfThreads)` Updates the provided index according to the given `SchemaAction`, using given number of threads if applicable (REINDEX and DISCARD_INDEX).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

- Field Detail
  - CURRENT_INSTANCE_SUFFIX
```
public static final String CURRENT_INSTANCE_SUFFIX
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ManagementSystem
```
public ManagementSystem(StandardJanusGraph graph,
                        KCVSConfiguration config,
                        Log sysLog,
                        ManagementLogger managementLogger,
                        SchemaCache schemaCache)
```
- Method Detail
  - getOpenInstancesInternal
```
public Set<String> getOpenInstancesInternal()
```
  - getOpenInstances
```
public Set<String> getOpenInstances()
```
    Description copied from interface: JanusGraphManagement
    
    Returns a set of unique instance ids for all JanusGraph instances that are currently part of this graph cluster.
    
    Specified by:
    
    getOpenInstances in interface JanusGraphManagement
    
    Returns:
  - forceCloseInstance
```
public void forceCloseInstance(String instanceId)
```
    Description copied from interface: JanusGraphManagement
    
    Forcefully removes a JanusGraph instance from this graph cluster as identified by its name.
    This method should be used with great care and only in cases where a JanusGraph 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 JanusGraphManagement
  - commit
```
public void commit()
```
    Description copied from interface: JanusGraphManagement
    
    Commits this management transaction and persists all schema changes. Closes this transaction.
    
    Specified by:
    
    commit in interface JanusGraphManagement
    
    See Also:
    
    JanusGraphTransaction.commit()
  - rollback
```
public void rollback()
```
    Description copied from interface: JanusGraphManagement
    
    Closes this management transaction and discards all changes.
    
    Specified by:
    
    rollback in interface JanusGraphManagement
    
    See Also:
    
    JanusGraphTransaction.rollback()
  - isOpen
```
public boolean isOpen()
```
    Description copied from interface: JanusGraphManagement
    
    Whether this management transaction is open or has been closed (i.e. committed or rolled-back)
    
    Specified by:
    
    isOpen in interface JanusGraphManagement
    
    Returns:
  - getWrappedTx
```
public StandardJanusGraphTx getWrappedTx()
```
  - getSchemaElement
```
public JanusGraphSchemaElement getSchemaElement(long id)
```
  - buildEdgeIndex
```
public RelationTypeIndex buildEdgeIndex(EdgeLabel label,
                                        String name,
                                        org.apache.tinkerpop.gremlin.structure.Direction direction,
                                        PropertyKey... sortKeys)
```
    Description copied from interface: JanusGraphManagement
    
    Identical to JanusGraphManagement.buildEdgeIndex(org.janusgraph.core.EdgeLabel, String, org.apache.tinkerpop.gremlin.structure.Direction, org.apache.tinkerpop.gremlin.process.traversal.Order, org.janusgraph.core.PropertyKey...) with default sort order Order.asc.
    
    Specified by:
    
    buildEdgeIndex in interface JanusGraphManagement
    
    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: JanusGraphManagement
    
    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 JanusGraphManagement
    
    Returns:
    
    the created RelationTypeIndex
  - buildPropertyIndex
```
public RelationTypeIndex buildPropertyIndex(PropertyKey key,
                                            String name,
                                            PropertyKey... sortKeys)
```
    Description copied from interface: JanusGraphManagement
    
    Identical to JanusGraphManagement.buildPropertyIndex(org.janusgraph.core.PropertyKey, String, org.apache.tinkerpop.gremlin.process.traversal.Order, org.janusgraph.core.PropertyKey...) with default sort order Order.asc.
    
    Specified by:
    
    buildPropertyIndex in interface JanusGraphManagement
    
    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: JanusGraphManagement
    
    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 JanusGraphManagement
    
    Returns:
    
    the created RelationTypeIndex
  - containsRelationIndex
```
public boolean containsRelationIndex(RelationType type,
                                     String name)
```
    Description copied from interface: JanusGraphManagement
    
    Whether a RelationTypeIndex with the given name has been defined for the provided RelationType
    
    Specified by:
    
    containsRelationIndex in interface JanusGraphManagement
    
    Returns:
  - getRelationIndex
```
public RelationTypeIndex getRelationIndex(RelationType type,
                                          String name)
```
    Description copied from interface: JanusGraphManagement
    
    Returns the RelationTypeIndex with the given name for the provided RelationType or null if it does not exist
    
    Specified by:
    
    getRelationIndex in interface JanusGraphManagement
    
    Returns:
  - getRelationIndexes
```
public Iterable<RelationTypeIndex> getRelationIndexes(RelationType type)
```
    Description copied from interface: JanusGraphManagement
    
    Returns an Iterable over all RelationTypeIndexes defined for the provided RelationType
    
    Specified by:
    
    getRelationIndexes in interface JanusGraphManagement
    
    Returns:
  - getGraphIndexDirect
```
public static IndexType getGraphIndexDirect(String name,
                                            StandardJanusGraphTx transaction)
```
  - containsGraphIndex
```
public boolean containsGraphIndex(String name)
```
    Description copied from interface: JanusGraphManagement
    
    Whether the graph has a graph index defined with the given name.
    
    Specified by:
    
    containsGraphIndex in interface JanusGraphManagement
    
    Returns:
  - getGraphIndex
```
public JanusGraphIndex getGraphIndex(String name)
```
    Description copied from interface: JanusGraphManagement
    
    Returns the graph index with the given name or null if it does not exist
    
    Specified by:
    
    getGraphIndex in interface JanusGraphManagement
    
    Returns:
  - getGraphIndexes
```
public Iterable<JanusGraphIndex> getGraphIndexes(Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)
```
    Description copied from interface: JanusGraphManagement
    
    Returns all graph indexes that index the given element type.
    
    Specified by:
    
    getGraphIndexes in interface JanusGraphManagement
    
    Returns:
  - getIndexOnlyConstraint
```
public JanusGraphSchemaType getIndexOnlyConstraint(String indexName)
```
    Description copied from interface: JanusGraphManagement
    
    Returns the indexOnly constraint for the index with given name or null if such constraint does not exist
    
    Specified by:
    
    getIndexOnlyConstraint in interface JanusGraphManagement
    
    Returns:
  - printSchema
```
public String printSchema()
```
    Description copied from interface: JanusGraphManagement
    
    Prints out schema information related to vertex and edge labels, indexes, and property keys.
    
    Specified by:
    
    printSchema in interface JanusGraphManagement
    
    Returns:
    
    a collection of all the mgmt API schema printing methods
  - printVertexLabels
```
public String printVertexLabels()
```
    Description copied from interface: JanusGraphManagement
    
    Prints out schema information related to vertex labels.
    
    Specified by:
    
    printVertexLabels in interface JanusGraphManagement
    
    Returns:
    
    String with vertex label schema information
  - printEdgeLabels
```
public String printEdgeLabels()
```
    Description copied from interface: JanusGraphManagement
    
    Prints out schema information related to edge labels.
    
    Specified by:
    
    printEdgeLabels in interface JanusGraphManagement
    
    Returns:
    
    String with edge label schema information
  - printPropertyKeys
```
public String printPropertyKeys()
```
    Description copied from interface: JanusGraphManagement
    
    Prints out schema information related to property keys.
    
    Specified by:
    
    printPropertyKeys in interface JanusGraphManagement
    
    Returns:
    
    String with property key schema information
  - printIndexes
```
public String printIndexes()
```
    Description copied from interface: JanusGraphManagement
    
    Prints out schema information related to indexes
    
    Specified by:
    
    printIndexes in interface JanusGraphManagement
    
    Returns:
    
    String with graph index and relation index information
  - awaitGraphIndexStatus
```
public static GraphIndexStatusWatcher awaitGraphIndexStatus(JanusGraph 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(JanusGraph 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(JanusGraphIndex index,
                        PropertyKey key,
                        Parameter... parameters)
```
    Specified by:
    
    addIndexKey in interface JanusGraphManagement
  - buildIndex
```
public JanusGraphManagement.IndexBuilder buildIndex(String indexName,
                                                    Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType)
```
    Description copied from interface: JanusGraphManagement
    
    Returns an JanusGraphManagement.IndexBuilder to add a graph index to this JanusGraph graph. The index to-be-created has the provided name and indexes elements of the given type.
    
    Specified by:
    
    buildIndex in interface JanusGraphManagement
    
    Returns:
  - updateIndex
```
public ScanJobFuture updateIndex(Index index,
                                 SchemaAction updateAction)
```
    Description copied from interface: JanusGraphManagement
    
    Updates the provided index according to the given SchemaAction. If action is REINDEX or DISCARD_INDEX, then number of threads running the action will be the number of available processors running on current JVM.
    
    Specified by:
    
    updateIndex in interface JanusGraphManagement
    
    Returns:
    
    a future that completes when the index action is done
  - updateIndex
```
public ScanJobFuture updateIndex(Index index,
                                 SchemaAction updateAction,
                                 int numOfThreads)
```
    Description copied from interface: JanusGraphManagement
    
    Updates the provided index according to the given SchemaAction, using given number of threads if applicable (REINDEX and DISCARD_INDEX).
    
    Specified by:
    
    updateIndex in interface JanusGraphManagement
    
    Returns:
  - evictGraphFromCache
```
public void evictGraphFromCache()
```
    Upon the open managementsystem's commit, this graph will be asynchronously evicted from the cache on all JanusGraph nodes in your cluster, once there are no open transactions on this graph on each respective JanusGraph node and assuming each node is correctly configured to use the JanusGraphManager.
  - evictGraphFromCache
```
public void evictGraphFromCache(Callable<Boolean> trigger)
```
    Upon the open managementsystem's commit, this graph will be asynchronously evicted from the cache on all JanusGraph nodes in your cluster, once there are no open transactions on this graph on each respective JanusGraph node and assuming each node is correctly configured to use the JanusGraphManager.
    
    Parameters:
    
    trigger - A Callable that will be called once the eviction is complete in the cluster. Return boolean value indicating trigger status.
  - getIndexJobStatus
```
public ScanJobFuture getIndexJobStatus(Index index)
```
    Description copied from interface: JanusGraphManagement
    
    If an index update job was triggered through JanusGraphManagement.updateIndex(Index, SchemaAction) with schema actions SchemaAction.REINDEX or SchemaAction.DISCARD_INDEX then this method can be used to track the status of this asynchronous process.
    
    Specified by:
    
    getIndexJobStatus in interface JanusGraphManagement
    
    Returns:
    
    A message that reflects the status of the index job
  - changeName
```
public void changeName(JanusGraphSchemaElement element,
                       String newName)
```
    Description copied from interface: JanusGraphManagement
    
    Changes the name of a JanusGraphSchemaElement 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 JanusGraphManagement
  - getSchemaVertex
```
public JanusGraphSchemaVertex getSchemaVertex(JanusGraphSchemaElement element)
```
  - getConsistency
```
public ConsistencyModifier getConsistency(JanusGraphSchemaElement element)
```
    Retrieves the consistency level for a schema element (types and internal indexes)
    
    Specified by:
    
    getConsistency in interface JanusGraphManagement
    
    Parameters:
    
    element -
    
    Returns:
  - setConsistency
```
public void setConsistency(JanusGraphSchemaElement 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 JanusGraphManagement
    
    Parameters:
    
    element -
    
    consistency -
  - getTTL
```
public Duration getTTL(JanusGraphSchemaType type)
```
    Description copied from interface: JanusGraphManagement
    
    Retrieves the time-to-live for the given JanusGraphSchemaType as a Duration. If no TTL has been defined, the returned Duration will be zero-length ("lives forever").
    
    Specified by:
    
    getTTL in interface JanusGraphManagement
    
    Returns:
  - setTTL
```
public void setTTL(JanusGraphSchemaType type,
                   Duration duration)
```
    Sets time-to-live for those schema types that support it
    
    Specified by:
    
    setTTL in interface JanusGraphManagement
    
    Parameters:
    
    type -
    
    duration - Note that only 'seconds' granularity is supported
  - removeGhostVertices
```
public ScanJobFuture removeGhostVertices(int numOfThreads)
```
    Description copied from interface: JanusGraphManagement
    
    Remove all ghost vertices (a.k.a. phantom vertices) from the graph, with the given concurrency level
    
    Specified by:
    
    removeGhostVertices in interface JanusGraphManagement
  - removeGhostVertices
```
public ScanJobFuture removeGhostVertices()
```
    Description copied from interface: JanusGraphManagement
    
    Remove all ghost vertices (a.k.a. phantom vertices) from the graph
    
    Specified by:
    
    removeGhostVertices in interface JanusGraphManagement
  - 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 JanusGraph 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 JanusGraph 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: JanusGraphManagement
    
    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 JanusGraphManagement
    
    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:
  - addProperties
```
public VertexLabel addProperties(VertexLabel vertexLabel,
                                 PropertyKey... keys)
```
    Description copied from interface: SchemaManager
    
    Add property constraints for a given vertex label.
    
    Specified by:
    
    addProperties in interface SchemaManager
    
    Parameters:
    
    vertexLabel - to which the constraints applies.
    
    keys - defines the properties which should be added to the VertexLabel as constraints.
    
    Returns:
    
    a VertexLabel edited which contains the added constraints.
  - addProperties
```
public EdgeLabel addProperties(EdgeLabel edgeLabel,
                               PropertyKey... keys)
```
    Description copied from interface: SchemaManager
    
    Add property constraints for a given edge label.
    
    Specified by:
    
    addProperties in interface SchemaManager
    
    Parameters:
    
    edgeLabel - to which the constraints applies.
    
    keys - defines the properties which should be added to the EdgeLabel as constraints.
    
    Returns:
    
    a EdgeLabel edited which contains the added constraints.
  - addConnection
```
public EdgeLabel addConnection(EdgeLabel edgeLabel,
                               VertexLabel outVLabel,
                               VertexLabel inVLabel)
```
    Description copied from interface: SchemaManager
    
    Add a constraint on which vertices the given edge label can connect.
    
    Specified by:
    
    addConnection in interface SchemaManager
    
    Parameters:
    
    edgeLabel - to which the constraint applies.
    
    outVLabel - specifies the outgoing vertex for this connection.
    
    inVLabel - specifies the incoming vertex for this connection.
    
    Returns:
    
    a EdgeLabel edited which contains the added constraint.
  - getVertexLabels
```
public Iterable<VertexLabel> getVertexLabels()
```
    Description copied from interface: JanusGraphManagement
    
    Returns an Iterable over all defined VertexLabels.
    
    Specified by:
    
    getVertexLabels in interface JanusGraphManagement
    
    Returns:
  - get
```
public String get(String path)
```
    Description copied from interface: JanusGraphConfiguration
    
    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 JanusGraphConfiguration
    
    Returns:
  - set
```
public JanusGraphConfiguration set(String path,
                                   Object value)
```
    Description copied from interface: JanusGraphConfiguration
    
    Sets the configuration option identified by the provided path to the given value.
    
    Specified by:
    
    set in interface JanusGraphConfiguration
  - remove
```
public JanusGraphConfiguration remove(String path)
```
    Description copied from interface: JanusGraphConfiguration
    
    Remove the configuration option identified by the provided path.
    
    Specified by:
    
    remove in interface JanusGraphConfiguration

Class ManagementSystem

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CURRENT_INSTANCE_SUFFIX

Constructor Detail

ManagementSystem

Method Detail

getOpenInstancesInternal

getOpenInstances

forceCloseInstance

commit

rollback

isOpen

getWrappedTx

getSchemaElement

buildEdgeIndex

buildEdgeIndex

buildPropertyIndex

buildPropertyIndex

containsRelationIndex

getRelationIndex

getRelationIndexes

getGraphIndexDirect

containsGraphIndex

getGraphIndex

getGraphIndexes

getIndexOnlyConstraint

printSchema

printVertexLabels

printEdgeLabels

printPropertyKeys

printIndexes

awaitGraphIndexStatus

awaitRelationIndexStatus

addIndexKey

buildIndex

updateIndex

updateIndex

evictGraphFromCache

evictGraphFromCache

getIndexJobStatus

changeName

getSchemaVertex

getConsistency

setConsistency

getTTL

setTTL

removeGhostVertices

removeGhostVertices

containsRelationType

getRelationType

containsPropertyKey

getPropertyKey

containsEdgeLabel

getOrCreateEdgeLabel

getOrCreatePropertyKey

getEdgeLabel

makePropertyKey

makeEdgeLabel

getRelationTypes

containsVertexLabel

getVertexLabel

getOrCreateVertexLabel

makeVertexLabel

addProperties

addProperties

addConnection

getVertexLabels

get

set

remove