Package | Description |
---|---|
com.arangodb | |
com.arangodb.util |
Modifier and Type | Method and Description |
---|---|
GraphEntity |
ArangoGraph.addEdgeDefinition(EdgeDefinition definition)
Add a new edge definition to the graph
|
GraphEntity |
ArangoGraph.addVertexCollection(String name)
Adds a vertex collection to the set of collections of the graph.
|
CollectionPropertiesEntity |
ArangoCollection.changeProperties(CollectionPropertiesOptions options)
Changes the properties of a collection
|
void |
ArangoDatabase.clearQueryCache()
Clears the AQL query cache
|
void |
ArangoDatabase.clearSlowQueries()
Clears the list of slow AQL queries
|
CollectionPropertiesEntity |
ArangoCollection.count()
Counts the documents in a collection
|
Boolean |
ArangoDatabase.create()
Creates the database
|
CollectionEntity |
ArangoCollection.create()
Creates the collection
|
GraphEntity |
ArangoGraph.create(Collection<EdgeDefinition> edgeDefinitions)
Creates the graph in the graph module.
|
GraphEntity |
ArangoGraph.create(Collection<EdgeDefinition> edgeDefinitions,
GraphCreateOptions options)
Creates the graph in the graph module.
|
CollectionEntity |
ArangoCollection.create(CollectionCreateOptions options)
Creates the collection
|
void |
ArangoDatabase.createAqlFunction(String name,
String code,
AqlFunctionCreateOptions options)
Create a new AQL user function
|
CollectionEntity |
ArangoDatabase.createCollection(String name)
Creates a collection
|
CollectionEntity |
ArangoDatabase.createCollection(String name,
CollectionCreateOptions options)
Creates a collection
|
Boolean |
ArangoDB.createDatabase(String name)
Creates a new database
|
GraphEntity |
ArangoDatabase.createGraph(String name,
Collection<EdgeDefinition> edgeDefinitions)
Create a new graph in the graph module.
|
GraphEntity |
ArangoDatabase.createGraph(String name,
Collection<EdgeDefinition> edgeDefinitions,
GraphCreateOptions options)
Create a new graph in the graph module.
|
UserEntity |
ArangoDB.createUser(String user,
String passwd)
Create a new user.
|
UserEntity |
ArangoDB.createUser(String user,
String passwd,
UserCreateOptions options)
Create a new user.
|
<T> ArangoCursor<T> |
ArangoDatabase.cursor(String cursorId,
Class<T> type)
Return an cursor from the given cursor-ID if still existing
|
Integer |
ArangoDatabase.deleteAqlFunction(String name,
AqlFunctionDeleteOptions options)
Remove an existing AQL user function
|
DocumentDeleteEntity<Void> |
ArangoCollection.deleteDocument(String key)
Removes a document
|
<T> DocumentDeleteEntity<T> |
ArangoCollection.deleteDocument(String key,
Class<T> type,
DocumentDeleteOptions options)
Removes a document
|
MultiDocumentEntity<DocumentDeleteEntity<Void>> |
ArangoCollection.deleteDocuments(Collection<?> values)
Removes multiple document
|
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> |
ArangoCollection.deleteDocuments(Collection<?> values,
Class<T> type,
DocumentDeleteOptions options)
Removes multiple document
|
void |
ArangoEdgeCollection.deleteEdge(String key)
Removes a edge
|
void |
ArangoEdgeCollection.deleteEdge(String key,
EdgeDeleteOptions options)
Removes a edge
|
String |
ArangoDatabase.deleteIndex(String id)
Deletes an index
|
String |
ArangoCollection.deleteIndex(String id)
Deletes an index
|
void |
ArangoDB.deleteUser(String user)
Removes an existing user, identified by user.
|
void |
ArangoVertexCollection.deleteVertex(String key)
Removes a vertex
|
void |
ArangoVertexCollection.deleteVertex(String key,
VertexDeleteOptions options)
Removes a vertex
|
Boolean |
ArangoCollection.documentExists(String key,
DocumentExistsOptions options)
Checks if the document exists by reading a single document head
|
void |
ArangoVertexCollection.drop()
Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other
graph
|
void |
ArangoGraph.drop()
Delete an existing graph
|
Boolean |
ArangoDatabase.drop()
Drop an existing database
|
void |
ArangoCollection.drop()
Drops the collection
|
void |
ArangoCollection.drop(boolean isSystem)
Drops the collection
|
IndexEntity |
ArangoCollection.ensureFulltextIndex(Iterable<String> fields,
FulltextIndexOptions options)
Creates a fulltext index for the collection, if it does not already exist.
|
IndexEntity |
ArangoCollection.ensureGeoIndex(Iterable<String> fields,
GeoIndexOptions options)
Creates a geo-spatial index for the collection, if it does not already exist.
|
IndexEntity |
ArangoCollection.ensureHashIndex(Iterable<String> fields,
HashIndexOptions options)
Creates a hash index for the collection if it does not already exist.
|
IndexEntity |
ArangoCollection.ensurePersistentIndex(Iterable<String> fields,
PersistentIndexOptions options)
Creates a persistent index for the collection, if it does not already exist.
|
IndexEntity |
ArangoCollection.ensureSkiplistIndex(Iterable<String> fields,
SkiplistIndexOptions options)
Creates a skip-list index for the collection, if it does not already exist.
|
Response |
ArangoDB.execute(Request request)
Generic Execute.
|
Response |
ArangoDB.execute(Request request,
com.arangodb.internal.net.HostHandle hostHandle)
Generic Execute.
|
<V,E> TraversalEntity<V,E> |
ArangoDatabase.executeTraversal(Class<V> vertexClass,
Class<E> edgeClass,
TraversalOptions options)
Execute a server-side traversal
|
boolean |
ArangoGraph.exists()
Checks whether the graph exists
|
boolean |
ArangoDatabase.exists()
Checks whether the database exists
|
boolean |
ArangoCollection.exists()
Checks whether the collection exists
|
AqlExecutionExplainEntity |
ArangoDatabase.explainQuery(String query,
Map<String,Object> bindVars,
AqlQueryExplainOptions options)
Explain an AQL query and return information about it
|
Collection<String> |
ArangoDB.getAccessibleDatabases()
Retrieves a list of all databases the current user can access
|
Collection<String> |
ArangoDatabase.getAccessibleDatabases()
Retrieves a list of all databases the current user can access
|
Collection<String> |
ArangoDB.getAccessibleDatabasesFor(String user)
List available database to the specified user
|
Collection<AqlFunctionEntity> |
ArangoDatabase.getAqlFunctions(AqlFunctionGetOptions options)
Gets all reqistered AQL user functions
|
Collection<CollectionEntity> |
ArangoDatabase.getCollections()
Returns all collections
|
Collection<CollectionEntity> |
ArangoDatabase.getCollections(CollectionsReadOptions options)
Returns all collections
|
Collection<QueryEntity> |
ArangoDatabase.getCurrentlyRunningQueries()
Returns a list of currently running AQL queries
|
Collection<String> |
ArangoDB.getDatabases()
Retrieves a list of all existing databases
|
<T> T |
ArangoDatabase.getDocument(String id,
Class<T> type)
Reads a single document
|
<T> T |
ArangoCollection.getDocument(String key,
Class<T> type)
Reads a single document
|
<T> T |
ArangoDatabase.getDocument(String id,
Class<T> type,
DocumentReadOptions options)
Reads a single document
|
<T> T |
ArangoCollection.getDocument(String key,
Class<T> type,
DocumentReadOptions options)
Reads a single document
|
<T> MultiDocumentEntity<T> |
ArangoCollection.getDocuments(Collection<String> keys,
Class<T> type)
Reads multiple documents
|
<T> T |
ArangoEdgeCollection.getEdge(String key,
Class<T> type)
Fetches an existing edge
|
<T> T |
ArangoEdgeCollection.getEdge(String key,
Class<T> type,
DocumentReadOptions options)
Fetches an existing edge
|
Collection<String> |
ArangoGraph.getEdgeDefinitions()
Lists all edge collections used in this graph
|
Collection<GraphEntity> |
ArangoDatabase.getGraphs()
Lists all graphs known to the graph module
|
IndexEntity |
ArangoDatabase.getIndex(String id)
Returns an index
|
IndexEntity |
ArangoCollection.getIndex(String id)
Returns an index
|
Collection<IndexEntity> |
ArangoCollection.getIndexes()
Returns all indexes of the collection
|
GraphEntity |
ArangoGraph.getInfo()
Get a graph from the graph module
|
DatabaseEntity |
ArangoDatabase.getInfo()
Retrieves information about the current database
|
CollectionEntity |
ArangoCollection.getInfo()
Returns information about the collection
|
LogLevelEntity |
ArangoDB.getLogLevel()
Returns the server's current loglevel settings.
|
LogEntity |
ArangoDB.getLogs(LogOptions options)
Returns fatal, error, warning or info log messages from the server's global log.
|
Permissions |
ArangoDatabase.getPermissions(String user)
Get specific database access level
|
Permissions |
ArangoCollection.getPermissions(String user)
Get the collection access level
|
CollectionPropertiesEntity |
ArangoCollection.getProperties()
Reads the properties of the specified collection
|
QueryCachePropertiesEntity |
ArangoDatabase.getQueryCacheProperties()
Returns the global configuration for the AQL query cache
|
QueryTrackingPropertiesEntity |
ArangoDatabase.getQueryTrackingProperties()
Returns the configuration for the AQL query tracking
|
CollectionRevisionEntity |
ArangoCollection.getRevision()
Retrieve the collections revision
|
ServerRole |
ArangoDB.getRole()
Returns the server role.
|
Collection<QueryEntity> |
ArangoDatabase.getSlowQueries()
Returns a list of slow running AQL queries
|
UserEntity |
ArangoDB.getUser(String user)
Fetches data about the specified user.
|
Collection<UserEntity> |
ArangoDB.getUsers()
Fetches data about all users.
|
ArangoDBVersion |
ArangoDB.getVersion()
Returns the server name and version number.
|
ArangoDBVersion |
ArangoDatabase.getVersion()
Returns the server name and version number.
|
<T> T |
ArangoVertexCollection.getVertex(String key,
Class<T> type)
Fetches an existing vertex
|
<T> T |
ArangoVertexCollection.getVertex(String key,
Class<T> type,
DocumentReadOptions options)
Fetches an existing vertex
|
Collection<String> |
ArangoGraph.getVertexCollections()
Lists all vertex collections used in this graph
|
void |
ArangoDatabase.grantAccess(String user)
Grants access to the database for user
user . |
void |
ArangoDatabase.grantAccess(String user,
Permissions permissions)
Grants or revoke access to the database for user
user . |
void |
ArangoCollection.grantAccess(String user,
Permissions permissions)
Grants or revoke access to the collection for user user.
|
void |
ArangoDB.grantDefaultCollectionAccess(String user,
Permissions permissions)
Sets the default access level for collections for the user
user . |
void |
ArangoDatabase.grantDefaultCollectionAccess(String user,
Permissions permissions)
Sets the default access level for collections within this database for the user
user . |
void |
ArangoDB.grantDefaultDatabaseAccess(String user,
Permissions permissions)
Sets the default access level for databases for the user
user . |
DocumentImportEntity |
ArangoCollection.importDocuments(Collection<?> values)
Imports documents
|
DocumentImportEntity |
ArangoCollection.importDocuments(Collection<?> values,
DocumentImportOptions options)
Imports documents
|
DocumentImportEntity |
ArangoCollection.importDocuments(String values)
Imports documents
|
DocumentImportEntity |
ArangoCollection.importDocuments(String values,
DocumentImportOptions options)
Imports documents
|
<T> DocumentCreateEntity<T> |
ArangoCollection.insertDocument(T value)
Creates a new document from the given document, unless there is already a document with the _key given.
|
<T> DocumentCreateEntity<T> |
ArangoCollection.insertDocument(T value,
DocumentCreateOptions options)
Creates a new document from the given document, unless there is already a document with the _key given.
|
<T> MultiDocumentEntity<DocumentCreateEntity<T>> |
ArangoCollection.insertDocuments(Collection<T> values)
Creates new documents from the given documents, unless there is already a document with the _key given.
|
<T> MultiDocumentEntity<DocumentCreateEntity<T>> |
ArangoCollection.insertDocuments(Collection<T> values,
DocumentCreateOptions options)
Creates new documents from the given documents, unless there is already a document with the _key given.
|
<T> EdgeEntity |
ArangoEdgeCollection.insertEdge(T value)
Creates a new edge in the collection
|
<T> EdgeEntity |
ArangoEdgeCollection.insertEdge(T value,
EdgeCreateOptions options)
Creates a new edge in the collection
|
<T> VertexEntity |
ArangoVertexCollection.insertVertex(T value)
Creates a new vertex in the collection
|
<T> VertexEntity |
ArangoVertexCollection.insertVertex(T value,
VertexCreateOptions options)
Creates a new vertex in the collection
|
void |
ArangoDatabase.killQuery(String id)
Kills a running query.
|
CollectionEntity |
ArangoCollection.load()
Loads a collection into memory.
|
ArangoDB.Builder |
ArangoDB.Builder.loadProperties(InputStream in) |
AqlParseEntity |
ArangoDatabase.parseQuery(String query)
Parse an AQL query and return information about it This method is for query validation only.
|
<T> ArangoCursor<T> |
ArangoDatabase.query(String query,
Map<String,Object> bindVars,
AqlQueryOptions options,
Class<T> type)
Create a cursor and return the first results
|
void |
ArangoDatabase.reloadRouting()
Reload the routing table.
|
GraphEntity |
ArangoGraph.removeEdgeDefinition(String definitionName)
Remove one edge definition from the graph.
|
CollectionEntity |
ArangoCollection.rename(String newName)
Renames a collection
|
<T> DocumentUpdateEntity<T> |
ArangoCollection.replaceDocument(String key,
T value)
Replaces the document with key with the one in the body, provided there is such a document and no precondition is
violated
|
<T> DocumentUpdateEntity<T> |
ArangoCollection.replaceDocument(String key,
T value,
DocumentReplaceOptions options)
Replaces the document with key with the one in the body, provided there is such a document and no precondition is
violated
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
ArangoCollection.replaceDocuments(Collection<T> values)
Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
specified by the _key attributes in the documents in values.
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
ArangoCollection.replaceDocuments(Collection<T> values,
DocumentReplaceOptions options)
Replaces multiple documents in the specified collection with the ones in the values, the replaced documents are
specified by the _key attributes in the documents in values.
|
<T> EdgeUpdateEntity |
ArangoEdgeCollection.replaceEdge(String key,
T value)
Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is
violated
|
<T> EdgeUpdateEntity |
ArangoEdgeCollection.replaceEdge(String key,
T value,
EdgeReplaceOptions options)
Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is
violated
|
GraphEntity |
ArangoGraph.replaceEdgeDefinition(EdgeDefinition definition)
Change one specific edge definition.
|
UserEntity |
ArangoDB.replaceUser(String user,
UserUpdateOptions options)
Replaces the data of an existing user.
|
<T> VertexUpdateEntity |
ArangoVertexCollection.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> VertexUpdateEntity |
ArangoVertexCollection.replaceVertex(String key,
T value,
VertexReplaceOptions options)
Replaces the vertex with key with the one in the body, provided there is such a vertex and no precondition is
violated
|
void |
ArangoDatabase.resetAccess(String user)
Clear the database access level, revert back to the default access level.
|
void |
ArangoCollection.resetAccess(String user)
Clear the collection access level, revert back to the default access level.
|
void |
ArangoDatabase.revokeAccess(String user)
Revokes access to the database dbname for user
user . |
void |
ArangoCollection.revokeAccess(String user)
Revokes access to the collection for user user.
|
LogLevelEntity |
ArangoDB.setLogLevel(LogLevelEntity entity)
Modifies and returns the server's current loglevel settings.
|
QueryCachePropertiesEntity |
ArangoDatabase.setQueryCacheProperties(QueryCachePropertiesEntity properties)
Changes the configuration for the AQL query cache.
|
QueryTrackingPropertiesEntity |
ArangoDatabase.setQueryTrackingProperties(QueryTrackingPropertiesEntity properties)
Changes the configuration for the AQL query tracking
|
void |
ArangoDB.shutdown()
Releases all connections to the server and clear the connection pool.
|
<T> T |
ArangoDatabase.transaction(String action,
Class<T> type,
TransactionOptions options)
Execute a server-side transaction
|
CollectionEntity |
ArangoCollection.truncate()
Removes all documents from the collection, but leaves the indexes intact
|
CollectionEntity |
ArangoCollection.unload()
Removes a collection from memory.
|
<T> DocumentUpdateEntity<T> |
ArangoCollection.updateDocument(String key,
T value)
Partially updates the document identified by document-key.
|
<T> DocumentUpdateEntity<T> |
ArangoCollection.updateDocument(String key,
T value,
DocumentUpdateOptions options)
Partially updates the document identified by document-key.
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
ArangoCollection.updateDocuments(Collection<T> values)
Partially updates documents, the documents to update are specified by the _key attributes in the objects on
values.
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
ArangoCollection.updateDocuments(Collection<T> values,
DocumentUpdateOptions options)
Partially updates documents, the documents to update are specified by the _key attributes in the objects on
values.
|
<T> EdgeUpdateEntity |
ArangoEdgeCollection.updateEdge(String key,
T value)
Partially updates the edge identified by document-key.
|
<T> EdgeUpdateEntity |
ArangoEdgeCollection.updateEdge(String key,
T value,
EdgeUpdateOptions options)
Partially updates the edge identified by document-key.
|
UserEntity |
ArangoDB.updateUser(String user,
UserUpdateOptions options)
Partially updates the data of an existing user.
|
<T> VertexUpdateEntity |
ArangoVertexCollection.updateVertex(String key,
T value)
Partially updates the vertex identified by document-key.
|
<T> VertexUpdateEntity |
ArangoVertexCollection.updateVertex(String key,
T value,
VertexUpdateOptions options)
Partially updates the vertex identified by document-key.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
ArangoDeserializer.deserialize(com.arangodb.velocypack.VPackSlice vpack,
Type type)
Deserialze a given VelocPack to an instance of a given type
|
com.arangodb.velocypack.VPackSlice |
ArangoSerializer.serialize(Object entity)
Serialize a given Object to VelocyPack
|
com.arangodb.velocypack.VPackSlice |
ArangoSerializer.serialize(Object entity,
ArangoSerializer.Options options)
Serialize a given Object to VelocyPack
|
Copyright © 2016–2018 ArangoDB GmbH. All rights reserved.