Package com.alibaba.graphscope.interactive.client

Class Driver

java.lang.Object

com.alibaba.graphscope.interactive.client.Driver

public class Driver
extends Object

The entrypoint for all graphscope operations.

Method Summary

Modifier and Type	Method	Description
static Driver	connect()	Connect to the interactive service with the environment variables INTERACTIVE_ADMIN_ENDPOINT, INTERACTIVE_STORED_PROC_ENDPOINT, INTERACTIVE_CYPHER_ENDPOINT, INTERACTIVE_GREMLIN_ENDPOINT
static Driver	connect(String uri)	Should only be used internally.
static Driver	connect(String adminUri, String storedProcUri, String cypherUri, String gremlinUri)	Connect to the interactive service by specifying the URIs of the admin, stored procedure, cypher, and gremlin services.
Session	getDefaultSession()
org.apache.tinkerpop.gremlin.driver.Client	getGremlinClient()
org.apache.commons.lang3.tuple.Pair<String,Integer>	getGremlinEndpoint()	Get the gremlin endpoint.
String	getNeo4jEndpoint()
org.neo4j.driver.Session	getNeo4jSession()	Create a neo4j session with default session config.
org.neo4j.driver.Session	getNeo4jSession(org.neo4j.driver.SessionConfig sessionConfig)	Create a neo4j session with the given session config.
static QueryInterface	queryServiceOnly(String storedProcUri)
static QueryInterface	queryServiceOnly(String storedProcUri, Config config)
Session	session()	Create a GraphScope session
Session	session(Config config)

Methods inherited from class java.lang.Object

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

Method Detail

connect

public static Driver connect()

Connect to the interactive service with the environment variables INTERACTIVE_ADMIN_ENDPOINT, INTERACTIVE_STORED_PROC_ENDPOINT, INTERACTIVE_CYPHER_ENDPOINT, INTERACTIVE_GREMLIN_ENDPOINT

Returns:

The driver object.

queryServiceOnly

public static QueryInterface queryServiceOnly(String storedProcUri)

queryServiceOnly

public static QueryInterface queryServiceOnly(String storedProcUri,
                                              Config config)

connect

public static Driver connect(String adminUri,
                             String storedProcUri,
                             String cypherUri,
                             String gremlinUri)

Connect to the interactive service by specifying the URIs of the admin, stored procedure, cypher, and gremlin services.

Parameters:

adminUri - The URI of the admin service.

storedProcUri - The URI of the stored procedure service.

cypherUri - The URI of the cypher service.

gremlinUri - The URI of the gremlin service.

Returns:

The driver object.

connect

public static Driver connect(String uri)

Should only be used internally. Users should use method connect() or connect(admin_uri,storedProcUri,cypherUri,gremlinUri) which require the URIs of all services, or need all uris exported to the environment variables. Connect to the interactive service by only specifying the admin service's uri.

Parameters:

uri - The URI of the admin service.

Returns:

The driver object.

session

public Session session()

Create a GraphScope session

Returns:

session

public Session session(Config config)

getDefaultSession

public Session getDefaultSession()

getNeo4jSession

public org.neo4j.driver.Session getNeo4jSession(org.neo4j.driver.SessionConfig sessionConfig)

Create a neo4j session with the given session config.

Parameters:

sessionConfig -

Returns:

getNeo4jSession

public org.neo4j.driver.Session getNeo4jSession()

Create a neo4j session with default session config.

Returns:

a neo4j session

getNeo4jEndpoint

public String getNeo4jEndpoint()

getGremlinEndpoint

public org.apache.commons.lang3.tuple.Pair<String,Integer> getGremlinEndpoint()

Get the gremlin endpoint.

Returns:

a pair of host and port

getGremlinClient

public org.apache.tinkerpop.gremlin.driver.Client getGremlinClient()