com.arangodb

Interface ArangoSearch

All Superinterfaces:

ArangoSerializationAccessor, ArangoView

public interface ArangoSearch
extends ArangoView

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
ViewEntity	create() Creates a view, then returns view information from the server.
ViewEntity	create(ArangoSearchCreateOptions options) Creates a view with the given options, then returns view information from the server.
ArangoSearchPropertiesEntity	getProperties() Reads the properties of the specified view.
ArangoSearchPropertiesEntity	replaceProperties(ArangoSearchPropertiesOptions options) Changes properties of the view.
ArangoSearchPropertiesEntity	updateProperties(ArangoSearchPropertiesOptions options) Partially changes properties of the view.

Methods inherited from interface com.arangodb.ArangoView

db, drop, exists, getInfo, name, rename

Methods inherited from interface com.arangodb.ArangoSerializationAccessor

util, util

Method Detail

create

ViewEntity create()
           throws ArangoDBException

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

Returns:

information about the view

Throws:

ArangoDBException

See Also:

API Documentation

create

ViewEntity create(ArangoSearchCreateOptions options)
           throws ArangoDBException

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

Throws:

ArangoDBException

See Also:

API Documentation

getProperties

ArangoSearchPropertiesEntity getProperties()
                                    throws ArangoDBException

Reads the properties of the specified view.

Returns:

properties of the view

Throws:

ArangoDBException

See Also:

API Documentation

updateProperties

ArangoSearchPropertiesEntity updateProperties(ArangoSearchPropertiesOptions options)
                                       throws ArangoDBException

Partially changes properties of the view.

Parameters:

options - properties to change

Returns:

properties of the view

Throws:

ArangoDBException

See Also:

API Documentation

replaceProperties

ArangoSearchPropertiesEntity replaceProperties(ArangoSearchPropertiesOptions options)
                                        throws ArangoDBException

Changes properties of the view.

Parameters:

options - properties to change

Returns:

properties of the view

Throws:

ArangoDBException

See Also:

API Documentation