org.janusgraph.core.schema

Interface JanusGraphManagement

All Superinterfaces:

JanusGraphConfiguration, SchemaInspector, SchemaManager

All Known Implementing Classes:

ManagementSystem

public interface JanusGraphManagement
extends JanusGraphConfiguration, SchemaManager

The JanusGraphManagement interface provides methods to define, update, and inspect the schema of a JanusGraph graph. It wraps a JanusGraphTransaction and therefore copies many of its methods as they relate to schema inspection and definition.

JanusGraphManagement behaves like a transaction in that it opens a transactional scope for reading the schema and making changes to it. As such, it needs to be explicitly closed via its commit() or rollback() methods. A JanusGraphManagement transaction is opened on a graph via JanusGraph.openManagement().

JanusGraphManagement provides methods to:

• Schema Types: View, update, and create vertex labels, edge labels, and property keys
• Relation Type Index: View and create vertex-centric indexes on edge labels and property keys
• Graph Index: View and create graph-wide indexes for efficient element retrieval
• Consistency Management: Set the consistency level of individual schema elements

Author:

Matthias Broecheler ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	JanusGraphManagement.IndexBuilder Builder for JanusGraphIndex.
static interface	JanusGraphManagement.IndexJobFuture

Method Summary

Modifier and Type	Method and Description
void	addIndexKey(JanusGraphIndex index, PropertyKey key, Parameter... parameters)
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(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 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	containsGraphIndex(String name) Whether the graph has a graph index defined with the given name.
boolean	containsRelationIndex(RelationType type, String name) Whether a RelationTypeIndex with the given name has been defined for the provided RelationType
void	forceCloseInstance(String instanceId) Forcefully removes a JanusGraph instance from this graph cluster as identified by its name.
ConsistencyModifier	getConsistency(JanusGraphSchemaElement element) Retrieves the consistency modifier for the given JanusGraphSchemaElement.
JanusGraphIndex	getGraphIndex(String name) Returns the graph index with the given name or null if it does not exist
Iterable<JanusGraphIndex>	getGraphIndexes(Class<? extends org.apache.tinkerpop.gremlin.structure.Element> elementType) Returns all graph indexes that index the given element type.
JanusGraphManagement.IndexJobFuture	getIndexJobStatus(Index index) If an index update job was triggered through updateIndex(Index, 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 JanusGraph instances that are currently part of this graph cluster.
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
<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).
Duration	getTTL(JanusGraphSchemaType type) Retrieves the time-to-live for the given JanusGraphSchemaType as a Duration.
Iterable<VertexLabel>	getVertexLabels() Returns an Iterable over all defined VertexLabels.
boolean	isOpen() Whether this management transaction is open or has been closed (i.e.
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.
void	rollback() Closes this management transaction and discards all changes.
void	setConsistency(JanusGraphSchemaElement element, ConsistencyModifier consistency) Sets the consistency modifier for the given JanusGraphSchemaElement.
void	setTTL(JanusGraphSchemaType type, Duration duration) Sets the time-to-live for the given JanusGraphSchemaType.
JanusGraphManagement.IndexJobFuture	updateIndex(Index index, SchemaAction updateAction) Updates the provided index according to the given SchemaAction

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

get, set

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

addConnection, addProperties, addProperties, makeEdgeLabel, makePropertyKey, makeVertexLabel

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

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

Method Detail

buildEdgeIndex

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

Identical to 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.

Parameters:

label -

name -

direction -

sortKeys -

Returns:

the created RelationTypeIndex

buildEdgeIndex

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. 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.

Parameters:

label -

name -

direction -

sortOrder -

sortKeys -

Returns:

the created RelationTypeIndex

buildPropertyIndex

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

Identical to buildPropertyIndex(org.janusgraph.core.PropertyKey, String, org.apache.tinkerpop.gremlin.process.traversal.Order, org.janusgraph.core.PropertyKey...) with default sort order Order.asc.

Parameters:

key -

name -

sortKeys -

Returns:

the created RelationTypeIndex

buildPropertyIndex

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

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.

Parameters:

key -

name -

sortOrder -

sortKeys -

Returns:

the created RelationTypeIndex

containsRelationIndex

boolean containsRelationIndex(RelationType type,
                              String name)

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

Parameters:

type -

name -

Returns:

getRelationIndex

RelationTypeIndex getRelationIndex(RelationType type,
                                   String name)

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

Parameters:

type -

name -

Returns:

getRelationIndexes

Iterable<RelationTypeIndex> getRelationIndexes(RelationType type)

Returns an Iterable over all RelationTypeIndexes defined for the provided RelationType

Parameters:

type -

Returns:

containsGraphIndex

boolean containsGraphIndex(String name)

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

Parameters:

name -

Returns:

getGraphIndex

JanusGraphIndex getGraphIndex(String name)

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

Parameters:

name -

Returns:

getGraphIndexes

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

Returns all graph indexes that index the given element type.

Parameters:

elementType -

Returns:

buildIndex

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. The index to-be-created has the provided name and indexes elements of the given type.

Parameters:

indexName -

elementType -

Returns:

addIndexKey

void addIndexKey(JanusGraphIndex index,
                 PropertyKey key,
                 Parameter... parameters)

getConsistency

ConsistencyModifier getConsistency(JanusGraphSchemaElement element)

Retrieves the consistency modifier for the given JanusGraphSchemaElement. If none has been explicitly defined, ConsistencyModifier.DEFAULT is returned.

Parameters:

element -

Returns:

setConsistency

void setConsistency(JanusGraphSchemaElement element,
                    ConsistencyModifier consistency)

Sets the consistency modifier for the given JanusGraphSchemaElement. Note, that only RelationTypes and composite graph indexes allow changing of the consistency level.

Parameters:

element -

consistency -

getTTL

Duration getTTL(JanusGraphSchemaType type)

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").

Parameters:

type -

Returns:

setTTL

void setTTL(JanusGraphSchemaType type,
            Duration duration)

Sets the time-to-live for the given JanusGraphSchemaType. The most granular time unit used for TTL values is seconds. Any argument will be rounded to seconds if it is more granular than that. The ttl must be non-negative. When ttl is zero, any existing TTL on type is removed ("lives forever"). Positive ttl values are interpreted literally.

Parameters:

type - the affected type

duration - time-to-live

changeName

void changeName(JanusGraphSchemaElement element,
                String newName)

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.

Parameters:

element -

newName -

updateIndex

JanusGraphManagement.IndexJobFuture updateIndex(Index index,
                                                SchemaAction updateAction)

Updates the provided index according to the given SchemaAction

Parameters:

index -

updateAction -

Returns:

a future that completes when the index action is done

getIndexJobStatus

JanusGraphManagement.IndexJobFuture getIndexJobStatus(Index index)

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

Parameters:

index -

Returns:

A message that reflects the status of the index job

getOpenInstances

Set<String> getOpenInstances()

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

Returns:

forceCloseInstance

void forceCloseInstance(String instanceId)

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.

Parameters:

instanceId -

getRelationTypes

<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).

Type Parameters:

T -

Parameters:

clazz - RelationType or sub-interface

Returns:

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

getVertexLabels

Iterable<VertexLabel> getVertexLabels()

Returns an Iterable over all defined VertexLabels.

Returns:

isOpen

boolean isOpen()

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

Returns:

commit

void commit()

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

See Also:

JanusGraphTransaction.commit()

rollback

void rollback()

Closes this management transaction and discards all changes.

See Also:

JanusGraphTransaction.rollback()

printSchema

String printSchema()

Prints out schema information related to vertex and edge labels, indexes, and property keys.

Returns:

a collection of all the mgmt API schema printing methods

printVertexLabels

String printVertexLabels()

Prints out schema information related to vertex labels.

Returns:

String with vertex label schema information

printEdgeLabels

String printEdgeLabels()

Prints out schema information related to edge labels.

Returns:

String with edge label schema information

printPropertyKeys

String printPropertyKeys()

Prints out schema information related to property keys.

Returns:

String with property key schema information

printIndexes

String printIndexes()

Prints out schema information related to indexes

Returns:

String with graph index information