com.arangodb

Interface InternalCursorDriver

All Superinterfaces:

BaseDriverInterface

All Known Implementing Classes:

InternalCursorDriverImpl

public interface InternalCursorDriver
extends BaseDriverInterface

Created by fbartels on 10/27/14.

Method Summary

Modifier and Type	Method and Description
<T> CursorEntity<T>	continueQuery(String database, long cursorId, Class<?>... clazz)
DefaultEntity	deleteSlowQueries(String database)
<T> CursorResult<T>	executeAqlQuery(String database, String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<T> clazz)
String	executeAqlQueryJSON(String database, String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions)
CursorRawResult	executeAqlQueryRaw(String database, String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions)
<T,S extends DocumentEntity<T>> DocumentCursorResult<T,S>	executeBaseCursorQuery(String database, String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<S> classDocumentEntity, Class<T> clazz)
<T> CursorEntity<T>	executeCursorEntityQuery(String database, String query, Map<String,Object> bindVars, AqlQueryOptions aqlQueryOptions, Class<?>... clazz)
DefaultEntity	finishQuery(String database, long cursorId)
QueriesResultEntity	getCurrentlyRunningQueries(String database)
QueryTrackingPropertiesEntity	getQueryTrackingProperties(String database)
<V,E> ShortestPathEntity<V,E>	getShortestPath(String database, String graphName, Object startVertexExample, Object endVertexExample, ShortestPathOptions shortestPathOptions, AqlQueryOptions aqlQueryOptions, Class<V> vertexClass, Class<E> edgeClass, ArangoDriver driver) Get the shortest path from a vertex to another vertex
QueriesResultEntity	getSlowQueries(String database)
DefaultEntity	killQuery(String database, String id)
QueryTrackingPropertiesEntity	setQueryTrackingProperties(String database, QueryTrackingPropertiesEntity properties)
CursorEntity<?>	validateQuery(String database, String query)

Methods inherited from interface com.arangodb.impl.BaseDriverInterface

getHttpManager, setHttpManager

Method Detail

validateQuery

CursorEntity<?> validateQuery(String database,
                              String query)
                       throws ArangoException

Throws:

ArangoException

executeCursorEntityQuery

<T> CursorEntity<T> executeCursorEntityQuery(String database,
                                             String query,
                                             Map<String,Object> bindVars,
                                             AqlQueryOptions aqlQueryOptions,
                                             Class<?>... clazz)
                                      throws ArangoException

Throws:

ArangoException

continueQuery

<T> CursorEntity<T> continueQuery(String database,
                                  long cursorId,
                                  Class<?>... clazz)
                           throws ArangoException

Throws:

ArangoException

finishQuery

DefaultEntity finishQuery(String database,
                          long cursorId)
                   throws ArangoException

Throws:

ArangoException

executeAqlQuery

<T> CursorResult<T> executeAqlQuery(String database,
                                    String query,
                                    Map<String,Object> bindVars,
                                    AqlQueryOptions aqlQueryOptions,
                                    Class<T> clazz)
                             throws ArangoException

Throws:

ArangoException

executeAqlQueryRaw

CursorRawResult executeAqlQueryRaw(String database,
                                   String query,
                                   Map<String,Object> bindVars,
                                   AqlQueryOptions aqlQueryOptions)
                            throws ArangoException

Throws:

ArangoException

executeAqlQueryJSON

String executeAqlQueryJSON(String database,
                           String query,
                           Map<String,Object> bindVars,
                           AqlQueryOptions aqlQueryOptions)
                    throws ArangoException

Throws:

ArangoException

executeBaseCursorQuery

<T,S extends DocumentEntity<T>> DocumentCursorResult<T,S> executeBaseCursorQuery(String database,
                                                                                 String query,
                                                                                 Map<String,Object> bindVars,
                                                                                 AqlQueryOptions aqlQueryOptions,
                                                                                 Class<S> classDocumentEntity,
                                                                                 Class<T> clazz)
                                                                          throws ArangoException

Throws:

ArangoException

getShortestPath

<V,E> ShortestPathEntity<V,E> getShortestPath(String database,
                                              String graphName,
                                              Object startVertexExample,
                                              Object endVertexExample,
                                              ShortestPathOptions shortestPathOptions,
                                              AqlQueryOptions aqlQueryOptions,
                                              Class<V> vertexClass,
                                              Class<E> edgeClass,
                                              ArangoDriver driver)
                                       throws ArangoException

Get the shortest path from a vertex to another vertex

Parameters:

database - the database name

graphName - the graph name

startVertexExample - a start vertex example object (or null)

endVertexExample - a start vertex example object (or null)

shortestPathOptions - shortest path options

aqlQueryOptions - AQL query options

vertexClass - the vertex class

edgeClass - the edge class

Returns:

a ShortestPathEntity object

Throws:

ArangoException

getQueryTrackingProperties

QueryTrackingPropertiesEntity getQueryTrackingProperties(String database)
                                                  throws ArangoException

Throws:

ArangoException

setQueryTrackingProperties

QueryTrackingPropertiesEntity setQueryTrackingProperties(String database,
                                                         QueryTrackingPropertiesEntity properties)
                                                  throws ArangoException

Throws:

ArangoException

getCurrentlyRunningQueries

QueriesResultEntity getCurrentlyRunningQueries(String database)
                                        throws ArangoException

Throws:

ArangoException

getSlowQueries

QueriesResultEntity getSlowQueries(String database)
                            throws ArangoException

Throws:

ArangoException

deleteSlowQueries

DefaultEntity deleteSlowQueries(String database)
                         throws ArangoException

Throws:

ArangoException

killQuery

DefaultEntity killQuery(String database,
                        String id)
                 throws ArangoException

Throws:

ArangoException