com.arangodb

Interface ArangoGraph

All Superinterfaces:

ArangoSerializationAccessor

public interface ArangoGraph
extends ArangoSerializationAccessor

Interface for operations on ArangoDB graph level.

Author:

Mark Vollmary

See Also:

API Documentation

Method Summary

Modifier and Type	Method and Description
GraphEntity	addEdgeDefinition(EdgeDefinition definition) Adds the given edge definition to the graph.
GraphEntity	addVertexCollection(String name) Adds a vertex collection to the set of collections of the graph.
GraphEntity	addVertexCollection(String name, VertexCollectionCreateOptions options) Adds a vertex collection to the set of collections of the graph.
GraphEntity	create(Collection<EdgeDefinition> edgeDefinitions) Creates the graph in the graph module.
GraphEntity	create(Collection<EdgeDefinition> edgeDefinitions, GraphCreateOptions options) Creates the graph in the graph module.
ArangoDatabase	db() The the handler of the database the named graph is within
void	drop() Deletes the graph from the database.
void	drop(boolean dropCollections) Deletes the graph from the database.
ArangoEdgeCollection	edgeCollection(String name) Returns a ArangoEdgeCollection instance for the given edge collection name.
boolean	exists() Checks whether the graph exists
Collection<String>	getEdgeDefinitions() Fetches all edge collections from the graph and returns a list of collection names.
GraphEntity	getInfo() Retrieves general information about the graph.
Collection<String>	getVertexCollections() Fetches all vertex collections from the graph and returns a list of collection names.
String	name() The name of the collection
GraphEntity	removeEdgeDefinition(String definitionName) Remove one edge definition from the graph.
GraphEntity	replaceEdgeDefinition(EdgeDefinition definition) Change one specific edge definition.
ArangoVertexCollection	vertexCollection(String name) Returns a ArangoVertexCollection instance for the given vertex collection name.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

db

ArangoDatabase 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

boolean exists()
        throws ArangoDBException

Checks whether the graph exists

Returns:

true if the graph exists, otherwise false

Throws:

ArangoDBException

create

GraphEntity create(Collection<EdgeDefinition> edgeDefinitions)
            throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

create

GraphEntity create(Collection<EdgeDefinition> edgeDefinitions,
                   GraphCreateOptions options)
            throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

drop

void drop()
   throws ArangoDBException

Deletes the graph from the database.

Throws:

ArangoDBException

See Also:

API Documentation

drop

void drop(boolean dropCollections)
   throws ArangoDBException

Deletes the graph from the database.

Parameters:

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

Throws:

ArangoDBException

See Also:

API Documentation

getInfo

GraphEntity getInfo()
             throws ArangoDBException

Retrieves general information about the graph.

Returns:

the definition content of this graph

Throws:

ArangoDBException

See Also:

API Documentation

getVertexCollections

Collection<String> getVertexCollections()
                                 throws ArangoDBException

Fetches all vertex collections from the graph and returns a list of collection names.

Returns:

all vertex collections within this graph

Throws:

ArangoDBException

See Also:

API Documentation

addVertexCollection

GraphEntity addVertexCollection(String name)
                         throws ArangoDBException

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

Parameters:

name - Name of the vertex collection

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation

addVertexCollection

GraphEntity addVertexCollection(String name,
                                VertexCollectionCreateOptions options)
                         throws ArangoDBException

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

Parameters:

name - Name of the vertex collection

options - additional options

Returns:

information about the graph

Throws:

ArangoDBException

Since:

ArangoDB 3.9

See Also:

API Documentation

vertexCollection

ArangoVertexCollection vertexCollection(String name)

Returns a ArangoVertexCollection instance for the given vertex collection name.

Parameters:

name - Name of the vertex collection

Returns:

collection handler

edgeCollection

ArangoEdgeCollection edgeCollection(String name)

Returns a ArangoEdgeCollection instance for the given edge collection name.

Parameters:

name - Name of the edge collection

Returns:

collection handler

getEdgeDefinitions

Collection<String> getEdgeDefinitions()
                               throws ArangoDBException

Fetches all edge collections from the graph and returns a list of collection names.

Returns:

all edge collections within this graph

Throws:

ArangoDBException

See Also:

API Documentation

addEdgeDefinition

GraphEntity addEdgeDefinition(EdgeDefinition definition)
                       throws ArangoDBException

Adds the given edge definition to the graph.

Parameters:

definition - The edge definition

Returns:

information about the graph

Throws:

ArangoDBException

See Also:

API Documentation

replaceEdgeDefinition

GraphEntity replaceEdgeDefinition(EdgeDefinition definition)
                           throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

removeEdgeDefinition

GraphEntity removeEdgeDefinition(String definitionName)
                          throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation