ai.grakn

Class Grakn

java.lang.Object

ai.grakn.Grakn

public class Grakn
extends Object

Grakn is the main entry point to connect to a Grakn Knowledge Graph.

To connect to a knowledge graph, first make sure you have a Grakn Engine server running. You can also instantiate an in-memory knowledge graph for testing or experimentation purposes.

To establish a connection, you first need to obtain a GraknGraphFactory by calling the factory(String, String) method. A GraknGraphFactory to a given physical location and specific database instance within that location. Once you've instantiated a factory, you can obtain multiple concurrent graph connections, represented by the GraknGraph interface.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_URI Constant to be passed to factory(String, String) to specify the default localhost Grakn Engine location.
static String	IN_MEMORY Constant to be passed to factory(String, String) to specify an in-memory graph.

Constructor Summary

Constructors

Constructor and Description
Grakn()

Method Summary

Modifier and Type	Method and Description
static GraknGraphFactory	factory(String location, String keyspace) Returns a factory instances to produce concurrent connections to the Grakn knowledge graph.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_URI

public static final String DEFAULT_URI

Constant to be passed to factory(String, String) to specify the default localhost Grakn Engine location.

See Also:

Constant Field Values

IN_MEMORY

public static final String IN_MEMORY

Constant to be passed to factory(String, String) to specify an in-memory graph.

See Also:

Constant Field Values

Constructor Detail

Grakn

public Grakn()

Method Detail

factory

public static GraknGraphFactory factory(String location,
                                        String keyspace)

Returns a factory instances to produce concurrent connections to the Grakn knowledge graph.

This method obtains the GraknGraphFactory for the specified location and keyspace.

Parameters:

location - The location from which to create the graph. For an in-memory graph, use the IN_MEMORY constant defined in this class. For the default, localhost Grakn Engine location, use the DEFAULT_URI constant provided in this class.

keyspace - The keyspace, or database name, where the knowledge graph is stored. A given database server will support multiple database instances. You need to explicitly name the instance to be used. In general, if one doesn't exist, it will be created for you.

Returns:

A factory instance that can produce concurrent connection to the knowledge graph.