org.opencypher.gremlin.client

Interface CypherGremlinClient

All Superinterfaces:

AutoCloseable, Closeable

public interface CypherGremlinClient
extends Closeable

This is a convenience wrapper around a Gremlin Client that configures the provided Client to be able to send Cypher queries to a Gremlin Server.

Method Summary

Modifier and Type	Method and Description
static CypherGremlinClient	bytecode(Client client) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.
static CypherGremlinClient	bytecode(Client client, Supplier<Translator<Bytecode,P>> translatorSupplier) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.
static CypherGremlinClient	bytecode(Client client, org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.
void	close() Closes the underlying Gremlin client.
static CypherGremlinClient	inMemory(GraphTraversalSource gts) Creates a CypherGremlinClient that executes Cypher queries directly on the configured GraphTraversalSource.
static CypherGremlinClient	plugin(Client client) Creates a CypherGremlinClient that can send Cypher queries to a remote Gremlin Server with Cypher plugin.
static CypherGremlinClient	retrieving(Client client, org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.
default CypherStatement.Submittable	statement(String cypher) Builder for Cypher statement advanced configuration.
default CypherResultSet	submit(String cypher) Submits a Cypher query.
default CypherResultSet	submit(String cypher, Map<String,?> parameters) Submits a Cypher query.
CompletableFuture<CypherResultSet>	submitAsync(CypherStatement statement) Submits a Cypher statement asynchronously.
default CompletableFuture<CypherResultSet>	submitAsync(String cypher) Submits a Cypher query asynchronously.
default CompletableFuture<CypherResultSet>	submitAsync(String cypher, Map<String,?> parameters) Submits a Cypher query asynchronously.
static CypherGremlinClient	translating(Client client) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.
static CypherGremlinClient	translating(Client client, Supplier<Translator<String,GroovyPredicate>> translatorSupplier) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.
static CypherGremlinClient	translating(Client client, org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor) Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.

Method Detail

plugin

static CypherGremlinClient plugin(Client client)

Creates a CypherGremlinClient that can send Cypher queries to a remote Gremlin Server with Cypher plugin.

Parameters:

client - Gremlin client

Returns:

Cypher-enabled client

translating

static CypherGremlinClient translating(Client client)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

Returns:

Cypher-enabled client

translating

static CypherGremlinClient translating(Client client,
                                       org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

flavor - translation flavor

Returns:

Cypher-enabled client

translating

static CypherGremlinClient translating(Client client,
                                       Supplier<Translator<String,GroovyPredicate>> translatorSupplier)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

translatorSupplier - translator configuration supplier

Returns:

Cypher-enabled client

bytecode

static CypherGremlinClient bytecode(Client client)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

Returns:

Cypher-enabled client

bytecode

static CypherGremlinClient bytecode(Client client,
                                    org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

flavor - translation flavor

Returns:

Cypher-enabled client

bytecode

static CypherGremlinClient bytecode(Client client,
                                    Supplier<Translator<Bytecode,P>> translatorSupplier)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin bytecode.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Parameters:

client - Gremlin client

translatorSupplier - translator configuration supplier

Returns:

Cypher-enabled client

inMemory

static CypherGremlinClient inMemory(GraphTraversalSource gts)

Creates a CypherGremlinClient that executes Cypher queries directly on the configured GraphTraversalSource.

Cypher to Gremlin translation is done on the client's thread. Graph traversal execution is not synchronized.

Parameters:

gts - source of GraphTraversal to translate to

Returns:

Cypher-enabled client

retrieving

static CypherGremlinClient retrieving(Client client,
                                      org.opencypher.gremlin.translation.translator.TranslatorFlavor flavor)

Creates a CypherGremlinClient that can send Cypher queries to any Gremlin Server or a compatible graph database as Gremlin-Groovy.

Cypher to Gremlin translation is done on the client's thread, before sending the query to Gremlin Server.

Difference with translating(Client, TranslatorFlavor) is that on request client retrieves and stores the entire result stream. See ResultSet.all().

This is not optimal for large result sets as the results will be held in memory at once. Use only for compatibility reasons.

Parameters:

client - Gremlin client

flavor - translation flavor

Returns:

Cypher-enabled client

See Also:

translating(Client, TranslatorFlavor)

close

void close()

Closes the underlying Gremlin client.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

submit

default CypherResultSet submit(String cypher)

Submits a Cypher query.

Parameters:

cypher - query text

Returns:

Cypher-style results

submit

default CypherResultSet submit(String cypher,
                               Map<String,?> parameters)

Submits a Cypher query.

Parameters:

cypher - query text

parameters - query parameters

Returns:

Cypher-style results

submitAsync

default CompletableFuture<CypherResultSet> submitAsync(String cypher)

Submits a Cypher query asynchronously.

Parameters:

cypher - query text

Returns:

Cypher-style results

statement

default CypherStatement.Submittable statement(String cypher)

Builder for Cypher statement advanced configuration.

Parameters:

cypher - query text

Returns:

statement builder

submitAsync

default CompletableFuture<CypherResultSet> submitAsync(String cypher,
                                                       Map<String,?> parameters)

Submits a Cypher query asynchronously.

Parameters:

cypher - query text

parameters - query parameters

Returns:

Cypher-style results

submitAsync

CompletableFuture<CypherResultSet> submitAsync(CypherStatement statement)

Submits a Cypher statement asynchronously.

Parameters:

statement - Cypher statement

Returns:

Cypher-style results

See Also:

statement(String)