org.janusgraph.core

Class JanusGraphFactory

java.lang.Object

org.janusgraph.core.JanusGraphFactory

public class JanusGraphFactory
extends Object

JanusGraphFactory is used to open or instantiate a JanusGraph graph database.

Author:

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

See Also:

JanusGraph

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JanusGraphFactory.Builder

Constructor Summary

Constructors

Constructor and Description
JanusGraphFactory()

Method Summary

Modifier and Type	Method and Description
static JanusGraphFactory.Builder	build() Returns a JanusGraphFactory.Builder that allows to set the configuration options for opening a JanusGraph graph database.
static void	close(org.apache.tinkerpop.gremlin.structure.Graph graph) Removes Graph from JanusGraphManager graph reference tracker, if exists there.
static void	drop(JanusGraph graph) Drop graph database, deleting all data in storage and indexing backends.
static Set<String>	getGraphNames() Return a Set of graph names stored in the JanusGraphManager
static JanusGraph	open(BasicConfiguration configuration) Opens a JanusGraph database configured according to the provided configuration.
static JanusGraph	open(org.apache.commons.configuration2.Configuration configuration) Opens a JanusGraph database configured according to the provided configuration.
static JanusGraph	open(ReadConfiguration configuration) Opens a JanusGraph database configured according to the provided configuration.
static JanusGraph	open(ReadConfiguration configuration, String backupName) Opens a JanusGraph database configured according to the provided configuration.
static JanusGraph	open(String shortcutOrFile) Opens a JanusGraph database.
static JanusGraph	open(String shortcutOrFile, String backupName) Opens a JanusGraph database.
static LogProcessorFramework	openTransactionLog(JanusGraph graph) Returns a LogProcessorFramework for processing transaction log entries against the provided graph instance.
static TransactionRecovery	startTransactionRecovery(JanusGraph graph, Instant start) Returns a TransactionRecovery process for recovering partially failed transactions.

Methods inherited from class java.lang.Object

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

Constructor Detail

JanusGraphFactory

public JanusGraphFactory()

Method Detail

open

public static JanusGraph open(String shortcutOrFile)

Opens a JanusGraph database.

If the argument points to a configuration file, the configuration file is loaded to configure the JanusGraph graph If the string argument is a configuration short-cut, then the short-cut is parsed and used to configure the returned JanusGraph graph.

A configuration short-cut is of the form: [STORAGE_BACKEND_NAME]:[DIRECTORY_OR_HOST]

Parameters:

shortcutOrFile - Configuration file name or configuration short-cut

Returns:

JanusGraph graph database configured according to the provided configuration

See Also:

"Configuration" manual chapter, Configuration Reference

open

public static JanusGraph open(String shortcutOrFile,
                              String backupName)

Opens a JanusGraph database.

If the argument points to a configuration file, the configuration file is loaded to configure the JanusGraph graph If the string argument is a configuration short-cut, then the short-cut is parsed and used to configure the returned JanusGraph graph. This method shouldn't be called by end users; it is used by internal server processes to open graphs defined at server start that do not include the graphname property.

A configuration short-cut is of the form: [STORAGE_BACKEND_NAME]:[DIRECTORY_OR_HOST]

Parameters:

shortcutOrFile - Configuration file name or configuration short-cut

backupName - Backup name for graph

Returns:

JanusGraph graph database configured according to the provided configuration

See Also:

"Configuration" manual chapter, Configuration Reference

open

public static JanusGraph open(org.apache.commons.configuration2.Configuration configuration)

Opens a JanusGraph database configured according to the provided configuration.

Parameters:

configuration - Configuration for the graph database

Returns:

JanusGraph graph database

See Also:

"Configuration" manual chapter, Configuration Reference

open

public static JanusGraph open(BasicConfiguration configuration)

Opens a JanusGraph database configured according to the provided configuration.

Parameters:

configuration - Configuration for the graph database

Returns:

JanusGraph graph database

open

public static JanusGraph open(ReadConfiguration configuration)

Opens a JanusGraph database configured according to the provided configuration.

Parameters:

configuration - Configuration for the graph database

Returns:

JanusGraph graph database

open

public static JanusGraph open(ReadConfiguration configuration,
                              String backupName)

Opens a JanusGraph database configured according to the provided configuration. This method shouldn't be called by end users; it is used by internal server processes to open graphs defined at server start that do not include the graphname property.

Parameters:

configuration - Configuration for the graph database

backupName - Backup name for graph

Returns:

JanusGraph graph database

getGraphNames

public static Set<String> getGraphNames()

Return a Set of graph names stored in the JanusGraphManager

Returns:

Set<String>

close

public static void close(org.apache.tinkerpop.gremlin.structure.Graph graph)
                  throws Exception

Removes Graph from JanusGraphManager graph reference tracker, if exists there.

Parameters:

graph - Graph

Throws:

Exception

drop

public static void drop(JanusGraph graph)
                 throws BackendException

Drop graph database, deleting all data in storage and indexing backends. Graph can be open or closed (will be closed as part of the drop operation). The graph is also removed from the JanusGraphManager graph reference tracker, if there.

WARNING: This is an irreversible operation that will delete all graph and index data.

Parameters:

graph - JanusGraph graph database. Can be open or closed.

Throws:

BackendException - If an error occurs during deletion

build

public static JanusGraphFactory.Builder build()

Returns a JanusGraphFactory.Builder that allows to set the configuration options for opening a JanusGraph graph database.

In the builder, the configuration options for the graph can be set individually. Once all options are configured, the graph can be opened with JanusGraphFactory.Builder.open().

Returns:

openTransactionLog

public static LogProcessorFramework openTransactionLog(JanusGraph graph)

Returns a LogProcessorFramework for processing transaction log entries against the provided graph instance.

Parameters:

graph -

Returns:

startTransactionRecovery

public static TransactionRecovery startTransactionRecovery(JanusGraph graph,
                                                           Instant start)

Returns a TransactionRecovery process for recovering partially failed transactions. The recovery process will start processing the write-ahead transaction log at the specified transaction time.

Parameters:

graph -

start -

Returns: