com.arangodb.async

Interface ArangoSearchAsync

All Superinterfaces:

ArangoSerializationAccessor, ArangoViewAsync

All Known Implementing Classes:

ArangoSearchAsyncImpl

public interface ArangoSearchAsync
extends ArangoViewAsync

Interface for operations on ArangoDB view level for ArangoSearch views.

Since:

ArangoDB 3.4.0

Author:

Mark Vollmary

See Also:

View API Documentation

Method Summary

Modifier and Type	Method and Description
CompletableFuture<ViewEntity>	create() Creates a view, then returns view information from the server.
CompletableFuture<ViewEntity>	create(ArangoSearchCreateOptions options) Creates a view with the given options, then returns view information from the server.
CompletableFuture<ArangoSearchPropertiesEntity>	getProperties() Reads the properties of the specified view.
CompletableFuture<ArangoSearchPropertiesEntity>	replaceProperties(ArangoSearchPropertiesOptions options) Changes properties of the view.
CompletableFuture<ArangoSearchPropertiesEntity>	updateProperties(ArangoSearchPropertiesOptions options) Partially changes properties of the view.

Methods inherited from interface com.arangodb.async.ArangoViewAsync

db, drop, exists, getInfo, name, rename

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

create

CompletableFuture<ViewEntity> create()

Creates a view, then returns view information from the server.

Returns:

information about the view @

See Also:

API Documentation

create

CompletableFuture<ViewEntity> create(ArangoSearchCreateOptions options)

Creates a view with the given options, then returns view information from the server.

Parameters:

options - Additional options, can be null

Returns:

information about the view @

See Also:

API Documentation

getProperties

CompletableFuture<ArangoSearchPropertiesEntity> getProperties()

Reads the properties of the specified view.

Returns:

properties of the view @

See Also:

API Documentation

updateProperties

CompletableFuture<ArangoSearchPropertiesEntity> updateProperties(ArangoSearchPropertiesOptions options)

Partially changes properties of the view.

Parameters:

options - properties to change

Returns:

properties of the view @

See Also:

API Documentation

replaceProperties

CompletableFuture<ArangoSearchPropertiesEntity> replaceProperties(ArangoSearchPropertiesOptions options)

Changes properties of the view.

Parameters:

options - properties to change

Returns:

properties of the view @

See Also:

API Documentation