com.arangodb

Interface ArangoVertexCollectionAsync

All Superinterfaces:

com.arangodb.ArangoSerializationAccessor

public interface ArangoVertexCollectionAsync
extends com.arangodb.ArangoSerializationAccessor

Interface for operations on ArangoDB vertex collection level.

Author:

Mark Vollmary

See Also:

API Documentation

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	deleteVertex(String key) Removes a vertex
CompletableFuture<Void>	deleteVertex(String key, com.arangodb.model.VertexDeleteOptions options) Removes a vertex
CompletableFuture<Void>	drop() Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph
<T> CompletableFuture<T>	getVertex(String key, Class<T> type) Fetches an existing vertex
<T> CompletableFuture<T>	getVertex(String key, Class<T> type, com.arangodb.model.DocumentReadOptions options) Fetches an existing vertex
ArangoGraphAsync	graph() The the handler of the named graph the edge collection is within
<T> CompletableFuture<com.arangodb.entity.VertexEntity>	insertVertex(T value) Creates a new vertex in the collection
<T> CompletableFuture<com.arangodb.entity.VertexEntity>	insertVertex(T value, com.arangodb.model.VertexCreateOptions options) Creates a new vertex in the collection
String	name() The name of the edge collection
<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity>	replaceVertex(String key, T value) Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated
<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity>	replaceVertex(String key, T value, com.arangodb.model.VertexReplaceOptions options) Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated
<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity>	updateVertex(String key, T value) Partially updates the vertex identified by document-key.
<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity>	updateVertex(String key, T value, com.arangodb.model.VertexUpdateOptions options) Partially updates the vertex identified by document-key.

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

graph

ArangoGraphAsync graph()

The the handler of the named graph the edge collection is within

Returns:

graph handler

name

String name()

The name of the edge collection

Returns:

collection name

drop

CompletableFuture<Void> drop()

Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph

Returns:

void

See Also:

API Documentation

insertVertex

<T> CompletableFuture<com.arangodb.entity.VertexEntity> insertVertex(T value)

Creates a new vertex in the collection

Parameters:

value - A representation of a single vertex (POJO, VPackSlice or String for Json)

Returns:

information about the vertex

See Also:

API Documentation

insertVertex

<T> CompletableFuture<com.arangodb.entity.VertexEntity> insertVertex(T value,
                                                                     com.arangodb.model.VertexCreateOptions options)

Creates a new vertex in the collection

Parameters:

value - A representation of a single vertex (POJO, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

See Also:

API Documentation

getVertex

<T> CompletableFuture<T> getVertex(String key,
                                   Class<T> type)

Fetches an existing vertex

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

the vertex identified by the key

See Also:

API Documentation

getVertex

<T> CompletableFuture<T> getVertex(String key,
                                   Class<T> type,
                                   com.arangodb.model.DocumentReadOptions options)

Fetches an existing vertex

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

the vertex identified by the key

See Also:

API Documentation

replaceVertex

<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity> replaceVertex(String key,
                                                                            T value)

Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

information about the vertex

See Also:

API Documentation

replaceVertex

<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity> replaceVertex(String key,
                                                                            T value,
                                                                            com.arangodb.model.VertexReplaceOptions options)

Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is violated

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

See Also:

API Documentation

updateVertex

<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity> updateVertex(String key,
                                                                           T value)
                                                                    throws com.arangodb.ArangoDBException

Partially updates the vertex identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

updateVertex

<T> CompletableFuture<com.arangodb.entity.VertexUpdateEntity> updateVertex(String key,
                                                                           T value,
                                                                           com.arangodb.model.VertexUpdateOptions options)
                                                                    throws com.arangodb.ArangoDBException

Partially updates the vertex identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Parameters:

key - The key of the vertex

type - The type of the vertex-document (POJO class, VPackSlice or String for Json)

options - Additional options, can be null

Returns:

information about the vertex

Throws:

ArangoDBException

See Also:

API Documentation

deleteVertex

CompletableFuture<Void> deleteVertex(String key)

Removes a vertex

Parameters:

key - The key of the vertex

See Also:

API Documentation

deleteVertex

CompletableFuture<Void> deleteVertex(String key,
                                     com.arangodb.model.VertexDeleteOptions options)

Removes a vertex

Parameters:

key - The key of the vertex

options - Additional options, can be null

See Also:

API Documentation