com.arangodb.async

Interface ArangoGraphAsync

All Superinterfaces:

ArangoSerializationAccessor

All Known Implementing Classes:

ArangoGraphAsyncImpl

public interface ArangoGraphAsync
extends ArangoSerializationAccessor

Interface for operations on ArangoDB graph level.

Author:

Mark Vollmary

See Also:

API Documentation

Method Summary

Modifier and Type	Method and Description
CompletableFuture<GraphEntity>	addEdgeDefinition(EdgeDefinition definition) Add a new edge definition to the graph
CompletableFuture<GraphEntity>	addVertexCollection(String name) Adds a vertex collection to the set of collections of the graph.
CompletableFuture<GraphEntity>	create(Collection<EdgeDefinition> edgeDefinitions) Creates the graph in the graph module.
CompletableFuture<GraphEntity>	createGraph(Collection<EdgeDefinition> edgeDefinitions, GraphCreateOptions options) Creates the graph in the graph module.
ArangoDatabaseAsync	db() The the handler of the database the named graph is within
CompletableFuture<Void>	drop() Delete an existing graph
CompletableFuture<Void>	drop(boolean dropCollections) Delete an existing graph including
ArangoEdgeCollectionAsync	edgeCollection(String name) Returns a handler of the edge collection by the given name
CompletableFuture<Boolean>	exists() Checks whether the graph exists
CompletableFuture<Collection<String>>	getEdgeDefinitions() Lists all edge collections used in this graph
CompletableFuture<GraphEntity>	getInfo() Get a graph from the graph module
CompletableFuture<Collection<String>>	getVertexCollections() Lists all vertex collections used in this graph
String	name() The name of the collection
CompletableFuture<GraphEntity>	removeEdgeDefinition(String definitionName) Remove one edge definition from the graph.
CompletableFuture<GraphEntity>	replaceEdgeDefinition(EdgeDefinition definition) Change one specific edge definition.
ArangoVertexCollectionAsync	vertexCollection(String name) Returns a handler of the vertex collection by the given name

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

db

ArangoDatabaseAsync db()

The the handler of the database the named graph is within

Returns:

database handler

name

String name()

The name of the collection

Returns:

collection name

exists

CompletableFuture<Boolean> exists()

Checks whether the graph exists

Returns:

true if the graph exists, otherwise false

create

CompletableFuture<GraphEntity> create(Collection<EdgeDefinition> edgeDefinitions)

Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Parameters:

edgeDefinitions - An array of definitions for the edge

Returns:

information about the graph

See Also:

API Documentation

createGraph

CompletableFuture<GraphEntity> createGraph(Collection<EdgeDefinition> edgeDefinitions,
                                           GraphCreateOptions options)

Creates the graph in the graph module. The creation of a graph requires the name of the graph and a definition of its edges.

Parameters:

edgeDefinitions - An array of definitions for the edge

options - Additional options, can be null

Returns:

information about the graph

See Also:

API Documentation

drop

CompletableFuture<Void> drop()

Delete an existing graph

Returns:

void

See Also:

API Documentation

drop

CompletableFuture<Void> drop(boolean dropCollections)

Delete an existing graph including

Parameters:

dropCollections - Drop collections of this graph as well. Collections will only be dropped if they are not used in other graphs.

Returns:

void

See Also:

API Documentation

getInfo

CompletableFuture<GraphEntity> getInfo()

Get a graph from the graph module

Returns:

the definition content of this graph

See Also:

API Documentation

getVertexCollections

CompletableFuture<Collection<String>> getVertexCollections()

Lists all vertex collections used in this graph

Returns:

all vertex collections within this graph

See Also:

API Documentation

addVertexCollection

CompletableFuture<GraphEntity> addVertexCollection(String name)

Adds a vertex collection to the set of collections of the graph. If the collection does not exist, it will be created.

Parameters:

name - The name of the collection

Returns:

information about the graph

See Also:

API Documentation

vertexCollection

ArangoVertexCollectionAsync vertexCollection(String name)

Returns a handler of the vertex collection by the given name

Parameters:

name - Name of the vertex collection

Returns:

collection handler

edgeCollection

ArangoEdgeCollectionAsync edgeCollection(String name)

Returns a handler of the edge collection by the given name

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

CompletableFuture<Collection<String>> getEdgeDefinitions()

Lists all edge collections used in this graph

Returns:

all edge collections within this graph

See Also:

API Documentation

addEdgeDefinition

CompletableFuture<GraphEntity> addEdgeDefinition(EdgeDefinition definition)

Add a new edge definition to the graph

Parameters:

definition -

Returns:

information about the graph

See Also:

API Documentation

replaceEdgeDefinition

CompletableFuture<GraphEntity> replaceEdgeDefinition(EdgeDefinition definition)

Change one specific edge definition. This will modify all occurrences of this definition in all graphs known to your database

Parameters:

definition - The edge definition

Returns:

information about the graph

See Also:

API Documentation

removeEdgeDefinition

CompletableFuture<GraphEntity> removeEdgeDefinition(String definitionName)

Remove one edge definition from the graph. This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries

Parameters:

definitionName - The name of the edge collection used in the definition

Returns:

information about the graph

See Also:

API Documentation