StreamTransactionEntity |
C8Database.abortStreamTransaction(String id) |
Aborts a Stream Transaction.
|
GraphEntity |
C8Graph.addEdgeDefinition(EdgeDefinition definition) |
Adds the given edge definition to the graph.
|
GraphEntity |
C8Graph.addVertexCollection(String name) |
Adds a vertex collection to the set of collections of the graph.
|
StreamTransactionEntity |
C8Database.beginStreamTransaction(StreamTransactionOptions options) |
Begins a Stream Transaction.
|
CollectionPropertiesEntity |
C8Collection.changeProperties(CollectionPropertiesOptions options) |
Changes the properties of the collection
|
void |
C8Database.clearSlowQueries() |
Clears the list of slow AQL queries
|
StreamTransactionEntity |
C8Database.commitStreamTransaction(String id) |
Commits a Stream Transaction.
|
CollectionPropertiesEntity |
C8Collection.count() |
Counts the documents in a collection
|
CollectionPropertiesEntity |
C8Collection.count(CollectionCountOptions options) |
Counts the documents in a collection
|
CollectionEntity |
C8Collection.create() |
Creates a collection for this collection's name, then returns collection
information from the server.
|
CollectionEntity |
C8Collection.create(CollectionCreateOptions options) |
Creates a collection with the given options for this collection's
name, then returns collection information from the server.
|
Boolean |
C8Database.create() |
Creates the database
|
Boolean |
C8Database.create(String geoFabric) |
Create a geofabric/db in Demo tenant
|
GraphEntity |
C8Graph.create(Collection<EdgeDefinition> edgeDefinitions) |
Creates the graph in the graph module.
|
GraphEntity |
C8Graph.create(Collection<EdgeDefinition> edgeDefinitions,
GraphCreateOptions options) |
Creates the graph in the graph module.
|
AlertEntity |
C8DB.createAlerts(AlertEntity entity) |
Creates an Alert
|
CollectionEntity |
C8Database.createCollection(String name) |
Creates a collection for the given collection's name, then returns collection
information from the server.
|
CollectionEntity |
C8Database.createCollection(String name,
CollectionCreateOptions options) |
Creates a collection with the given options for this collection's
name, then returns collection information from the server.
|
Boolean |
C8DB.createGeoFabric(String tenant,
String name,
String spotDc,
String dcList,
String geoFabric) |
Creates a new database with the given name.
|
GraphEntity |
C8Database.createGraph(String name,
Collection<EdgeDefinition> edgeDefinitions) |
Create a new graph in the graph module.
|
GraphEntity |
C8Database.createGraph(String name,
Collection<EdgeDefinition> edgeDefinitions,
GraphCreateOptions options) |
Create a new graph in the graph module.
|
void |
C8Database.createPersistentStream(String name,
C8StreamCreateOptions options) |
Create asynchronously a persistent stream for a given fabric.
|
UserEntity |
C8DB.createUser(String user,
String passwd) |
Create a new user.
|
UserEntity |
C8DB.createUser(String user,
String passwd,
UserCreateOptions options) |
Create a new user.
|
UserQueryEntity |
C8Database.createUserQuery(UserQueryOptions userQueryDefinition) |
Creates user query as the current user
|
UserQueryEntity |
C8Database.createUserQuery(UserQueryOptions userQueryDefinition,
String user) |
Creates user query as a given user.
|
UserQueryEntity |
Restql.createUserQuery(UserQueryOptions userQueryDefinition) |
Saves a query for a user for a given fabric.
|
UserQueryEntity |
Restql.createUserQuery(UserQueryOptions userQueryDefinition,
String user) |
Saves a query for a user for a given fabric and a given user.
|
<T> C8Cursor<T> |
C8Database.cursor(String cursorId,
Class<T> type) |
Return an cursor from the given cursor-ID if still existing
|
DocumentDeleteEntity<Void> |
C8Collection.deleteDocument(String key) |
Deletes the document with the given key from the collection.
|
<T> DocumentDeleteEntity<T> |
C8Collection.deleteDocument(String key,
Class<T> type,
DocumentDeleteOptions options) |
Deletes the document with the given key from the collection.
|
MultiDocumentEntity<DocumentDeleteEntity<Void>> |
C8Collection.deleteDocuments(Collection<?> values) |
Deletes multiple documents from the collection.
|
<T> MultiDocumentEntity<DocumentDeleteEntity<T>> |
C8Collection.deleteDocuments(Collection<?> values,
Class<T> type,
DocumentDeleteOptions options) |
Deletes multiple documents from the collection.
|
void |
C8EdgeCollection.deleteEdge(String key) |
Removes a edge
|
void |
C8EdgeCollection.deleteEdge(String key,
EdgeDeleteOptions options) |
Removes a edge
|
void |
C8Event.deleteEvent(String key) |
Deletes the document with the given key from the collection.
|
void |
C8Event.deleteEvents(Collection<?> values) |
Deletes multiple documents from the collection.
|
String |
C8Collection.deleteIndex(String id) |
Deletes the index with the given id from the collection.
|
String |
C8Database.deleteIndex(String id) |
Deletes an index
|
void |
C8DB.deleteUser(String user) |
Removes an existing user, identified by user.
|
void |
C8VertexCollection.deleteVertex(String key) |
Deletes the vertex with the given key from the collection.
|
void |
C8VertexCollection.deleteVertex(String key,
VertexDeleteOptions options) |
Deletes the vertex with the given key from the collection.
|
<T> T |
VelocyJack.deserialize(com.arangodb.velocypack.VPackSlice vpack,
Type type) |
|
Boolean |
C8Collection.documentExists(String key,
DocumentExistsOptions options) |
Checks if the document exists by reading a single document head
|
void |
C8Collection.drop() |
Deletes the collection from the database.
|
void |
C8Collection.drop(boolean isSystem) |
Deletes the collection from the database.
|
Boolean |
C8Database.drop() |
Deletes the database from the server.
|
void |
C8Graph.drop() |
Deletes the graph from the database.
|
void |
C8Graph.drop(boolean dropCollections) |
Deletes the graph from the database.
|
void |
C8VertexCollection.drop() |
Removes a vertex collection from the graph and optionally deletes the
collection, if it is not used in any other graph
|
void |
Restql.drop(String name) |
Deletes user query from the database.
|
void |
Restql.drop(String name,
String user) |
Deletes user query from the database.
|
IndexEntity |
C8Collection.ensureFulltextIndex(Iterable<String> fields,
FulltextIndexOptions options) |
Creates a fulltext index for the collection, if it does not already exist.
|
IndexEntity |
C8Collection.ensureGeoIndex(Iterable<String> fields,
GeoIndexOptions options) |
Creates a geo-spatial index for the collection, if it does not already exist.
|
IndexEntity |
C8Collection.ensureHashIndex(Iterable<String> fields,
HashIndexOptions options) |
Creates a hash index for the collection if it does not already exist.
|
IndexEntity |
C8Collection.ensurePersistentIndex(Iterable<String> fields,
PersistentIndexOptions options) |
Creates a persistent index for the collection, if it does not already exist.
|
IndexEntity |
C8Collection.ensureSkiplistIndex(Iterable<String> fields,
SkiplistIndexOptions options) |
Creates a skip-list index for the collection, if it does not already exist.
|
IndexEntity |
C8Collection.ensureTTLIndex(Iterable<String> fields,
TTLIndexOptions options) |
Creates a ttl index for the collection, if it does not already exist.
|
Response |
C8DB.execute(Request request) |
Generic Execute.
|
Response |
C8DB.execute(Request request,
HostHandle hostHandle) |
Generic Execute.
|
<V,E> TraversalEntity<V,E> |
C8Database.executeTraversal(Class<V> vertexClass,
Class<E> edgeClass,
TraversalOptions options) |
Execute a server-side traversal
|
<T> C8Cursor<T> |
C8Database.executeUserQuery(String userName,
String name,
Map<String,Object> bindVars,
Class<T> type) |
Executes a saved using query using the given name and
bindVars, then returns a new C8Cursor instance for the result
list.
|
boolean |
C8Collection.exists() |
Checks whether the collection exists
|
boolean |
C8Database.exists() |
Checks whether the database exists
|
boolean |
C8Graph.exists() |
Checks whether the graph exists
|
C8qlExecutionExplainEntity |
C8Database.explainQuery(String query,
Map<String,Object> bindVars,
C8qlQueryExplainOptions options) |
Explain an AQL query and return information about it
|
Collection<String> |
C8Database.getAccessibleGeoFabrics() |
Retrieves a list of all databases the current user can access
|
Collection<String> |
C8DB.getAccessibleGeoFabrics() |
Retrieves a list of all databases the current user can access
|
Collection<String> |
C8DB.getAccessibleGeoFabricsFor(String user) |
List available database to the specified user
|
Collection<AlertEntity> |
C8DB.getAlerts(Map<String,String> queryParamMap) |
Gets Alerts
|
List<DcInfoEntity> |
C8DB.getAllEdgeLocations() |
Return a list of all Edge Locations (AKA Datacenters) deployed in the Macrometa Fabric.
|
Collection<CollectionEntity> |
C8Database.getCollections() |
Fetches all collections from the database and returns an list of collection
descriptions.
|
Collection<CollectionEntity> |
C8Database.getCollections(CollectionsReadOptions options) |
Fetches all collections from the database and returns an list of collection
descriptions.
|
Collection<QueryEntity> |
C8Database.getCurrentlyRunningQueries() |
Returns a list of currently running AQL queries
|
<T> T |
C8Collection.getDocument(String key,
Class<T> type) |
Retrieves the document with the given key from the collection.
|
<T> T |
C8Collection.getDocument(String key,
Class<T> type,
DocumentReadOptions options) |
Retrieves the document with the given key from the collection.
|
<T> T |
C8Database.getDocument(String id,
Class<T> type) |
Reads a single document
|
<T> T |
C8Database.getDocument(String id,
Class<T> type,
DocumentReadOptions options) |
Reads a single document
|
<T> MultiDocumentEntity<T> |
C8Collection.getDocuments(Collection<String> keys,
Class<T> type) |
Retrieves multiple documents with the given _key from the collection.
|
<T> MultiDocumentEntity<T> |
C8Collection.getDocuments(Collection<String> keys,
Class<T> type,
DocumentReadOptions options) |
Retrieves multiple documents with the given _key from the collection.
|
<T> T |
C8EdgeCollection.getEdge(String key,
Class<T> type) |
Fetches an existing edge
|
<T> T |
C8EdgeCollection.getEdge(String key,
Class<T> type,
GraphDocumentReadOptions options) |
Fetches an existing edge
|
Collection<String> |
C8Graph.getEdgeDefinitions() |
Fetches all edge collections from the graph and returns a list of collection
names.
|
DcInfoEntity |
C8DB.getEdgeLocation(String dcName) |
Fetches data about the specified Edge Location.
|
List<DataCenterEntity> |
C8DB.getEdgeLocations(String tenant) |
Lists Edge Location (AKA Datacenter) details for specified tenant
|
C8EventEntity |
C8Event.getEvent(String key) |
Retrieves the document with the given key from the collection.
|
C8EventEntity |
C8Event.getEvent(String key,
DocumentReadOptions options) |
Retrieves the document with the given key from the collection.
|
Collection<C8EventEntity> |
C8Event.getEvents(Collection<String> keys) |
Retrieves multiple documents with the given _key from the collection.
|
GeoFabricEntity |
C8DB.getGeoFabricInformation(String tenant,
String name) |
|
Collection<String> |
C8DB.getGeoFabrics() |
Retrieves a list of all existing databases
|
Collection<GraphEntity> |
C8Database.getGraphs() |
Lists all graphs known to the graph module
|
IndexEntity |
C8Collection.getIndex(String id) |
Fetches information about the index with the given id and returns it.
|
IndexEntity |
C8Database.getIndex(String id) |
Returns an index
|
Collection<IndexEntity> |
C8Collection.getIndexes() |
Fetches a list of all indexes on this collection.
|
CollectionEntity |
C8Collection.getInfo() |
Returns information about the collection
|
DatabaseEntity |
C8Database.getInfo() |
Retrieves information about the current database
|
GraphEntity |
C8Graph.getInfo() |
Retrieves general information about the graph.
|
DcInfoEntity |
C8DB.getLocalEdgeLocation() |
List details of Local Edge Location
|
LogLevelEntity |
C8DB.getLogLevel() |
Returns the server's current loglevel settings.
|
LogEntity |
C8DB.getLogs(LogOptions options) |
Returns fatal, error, warning or info log messages from the server's global
log.
|
Permissions |
C8Collection.getPermissions(String user) |
Get the collection access level
|
Permissions |
C8Database.getPermissions(String user) |
Get specific database access level
|
Collection<C8StreamEntity> |
C8Database.getPersistentStreams(C8StreamCreateOptions options) |
Get list of persistent streams under the given stream db.
|
CollectionPropertiesEntity |
C8Collection.getProperties() |
Reads the properties of the specified collection
|
QueryTrackingPropertiesEntity |
C8Database.getQueryTrackingProperties() |
Returns the configuration for the AQL query tracking
|
ServerRole |
C8DB.getRole() |
Returns the server role.
|
Collection<QueryEntity> |
C8Database.getSlowQueries() |
Returns a list of slow running AQL queries
|
Collection<C8StreamEntity> |
C8Database.getStreams() |
Get list of all streams under given database.
|
StreamTransactionEntity |
C8Database.getStreamTransaction(String id) |
Gets information about a Stream Transaction.
|
Collection<TransactionEntity> |
C8Database.getStreamTransactions() |
Gets all the currently running Stream Transactions.
|
TenantEntity |
C8Admin.getTenant(String tenant) |
Returns the requested tenant
|
FeaturesEntity |
C8Admin.getTenantFeatures(String tenant) |
Fetches all features associated with given tenant
|
LimitsEntity |
C8Admin.getTenantLimits(String tenant) |
Returns the tenant limits
|
TenantMetricsEntity |
C8Admin.getTenantMetrics(TenantMetricsOption options) |
Returns metrics for a tenant
|
List<TenantsEntity> |
C8Admin.getTenants() |
Returns the tenant limits
|
UserEntity |
C8DB.getUser(String user) |
Fetches data about the specified user.
|
UserEntity |
C8DB.getUser(String user,
String tenant) |
Fetches data about the specified user for a given tenant.
|
Collection<UserQueryEntity> |
Restql.getUserQueries() |
Fetches all user queries associated with the current user
|
Collection<UserQueryEntity> |
Restql.getUserQueries(String userName) |
Fetches all user queries associated with given user
|
Collection<UserEntity> |
C8DB.getUsers() |
Fetches data about all users.
|
C8DBVersion |
C8Database.getVersion() |
Returns the server name and version number.
|
C8DBVersion |
C8DB.getVersion() |
Returns the server name and version number.
|
<T> T |
C8VertexCollection.getVertex(String key,
Class<T> type) |
Retrieves the vertex document with the given key from the collection.
|
<T> T |
C8VertexCollection.getVertex(String key,
Class<T> type,
GraphDocumentReadOptions options) |
Retrieves the vertex document with the given key from the collection.
|
Collection<String> |
C8Graph.getVertexCollections() |
Fetches all vertex collections from the graph and returns a list of
collection names.
|
void |
C8Collection.grantAccess(String user,
Permissions permissions) |
Grants or revoke access to the collection for user user.
|
void |
C8Database.grantAccess(String user) |
Grants access to the database for user user.
|
void |
C8Database.grantAccess(String user,
Permissions permissions) |
Grants or revoke access to the database for user user.
|
void |
C8DB.grantDefaultCollectionAccess(String user,
Permissions permissions) |
Sets the default access level for collections for the user user.
|
void |
C8DB.grantDefaultDatabaseAccess(String user,
Permissions permissions) |
Sets the default access level for databases for the user user.
|
<T> DocumentCreateEntity<T> |
C8Collection.insertDocument(T value) |
Creates a new document from the given document, unless there is already a
document with the _key given.
|
<T> DocumentCreateEntity<T> |
C8Collection.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>> |
C8Collection.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>> |
C8Collection.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 |
C8EdgeCollection.insertEdge(T value) |
Creates a new edge in the collection
|
<T> EdgeEntity |
C8EdgeCollection.insertEdge(T value,
EdgeCreateOptions options) |
Creates a new edge in the collection
|
<T> C8EventEntity |
C8Event.insertEvent(T value) |
Creates a new document from the given document, unless there is already a
document with the _key given.
|
<T> C8EventEntity |
C8Event.insertEvent(T value,
EventCreateOptions options) |
Creates a new document from the given document, unless there is already a
document with the _key given.
|
<T> VertexEntity |
C8VertexCollection.insertVertex(T value) |
Creates a new vertex in the collection
|
<T> VertexEntity |
C8VertexCollection.insertVertex(T value,
VertexCreateOptions options) |
Creates a new vertex in the collection
|
void |
C8Database.killQuery(String id) |
Kills a running query.
|
C8DB.Builder |
C8DB.Builder.loadProperties(InputStream in) |
|
C8qlParseEntity |
C8Database.parseQuery(String query) |
Parse an AQL query and return information about it This method is for query
validation only.
|
<T> C8Cursor<T> |
C8Database.query(String query,
C8qlQueryOptions options,
Class<T> type) |
Performs a database query using the given query, then returns a new
ArangoCursor instance for the result list.
|
<T> C8Cursor<T> |
C8Database.query(String query,
Class<T> type) |
Performs a database query using the given query, then returns a new
ArangoCursor instance for the result list.
|
<T> C8Cursor<T> |
C8Database.query(String query,
Map<String,Object> bindVars,
C8qlQueryOptions options,
Class<T> type) |
Performs a database query using the given query and bindVars,
then returns a new C8Cursor instance for the result list.
|
<T> C8Cursor<T> |
C8Database.query(String query,
Map<String,Object> bindVars,
Class<T> type) |
Performs a database query using the given query and bindVars,
then returns a new ArangoCursor instance for the result list.
|
GraphEntity |
C8Graph.removeEdgeDefinition(String definitionName) |
Remove one edge definition from the graph.
|
CollectionEntity |
C8Collection.rename(String newName) |
Renames the collection
|
<T> DocumentUpdateEntity<T> |
C8Collection.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> |
C8Collection.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>> |
C8Collection.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>> |
C8Collection.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 |
C8EdgeCollection.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 |
C8EdgeCollection.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 |
C8Graph.replaceEdgeDefinition(EdgeDefinition definition) |
Change one specific edge definition.
|
UserEntity |
C8DB.replaceUser(String user,
UserUpdateOptions options) |
Replaces the data of an existing user.
|
<T> VertexUpdateEntity |
C8VertexCollection.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 |
C8VertexCollection.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 |
C8Collection.resetAccess(String user) |
Clear the collection access level, revert back to the default access level.
|
void |
C8Database.resetAccess(String user) |
Clear the database access level, revert back to the default access level.
|
void |
C8Collection.revokeAccess(String user) |
Revokes access to the collection for user user.
|
void |
C8Database.revokeAccess(String user) |
Revokes access to the database dbname for user user.
|
com.arangodb.velocypack.VPackSlice |
VelocyJack.serialize(Object entity) |
|
com.arangodb.velocypack.VPackSlice |
VelocyJack.serialize(Object entity,
C8Serializer.Options options) |
|
LogLevelEntity |
C8DB.setLogLevel(LogLevelEntity entity) |
Modifies and returns the server's current loglevel settings.
|
QueryTrackingPropertiesEntity |
C8Database.setQueryTrackingProperties(QueryTrackingPropertiesEntity properties) |
Changes the configuration for the AQL query tracking
|
void |
C8DB.shutdown() |
Releases all connections to the server and clear the connection pool.
|
<T> T |
C8Database.transaction(String action,
Class<T> type,
C8TransactionOptions options) |
Performs a server-side transaction and returns its return value.
|
CollectionEntity |
C8Collection.truncate() |
Removes all documents from the collection, but leaves the indexes intact
|
CollectionEntity |
C8Collection.truncate(CollectionTruncateOptions options) |
Removes all documents from the collection, but leaves the indexes intact
|
AlertEntity |
C8DB.updateAlerts(String updateParam,
Map<String,String> queryParamMap) |
Acknowledges or Resolves an alert
|
Boolean |
C8DB.updateDataCentersForGeoFabric(String tenant,
String name,
String dcList) |
Updated the data centers for the specified database
|
<T> DocumentUpdateEntity<T> |
C8Collection.updateDocument(String key,
T value) |
Partially updates the document identified by document-key.
|
<T> DocumentUpdateEntity<T> |
C8Collection.updateDocument(String key,
T value,
DocumentUpdateOptions options) |
Partially updates the document identified by document-key.
|
<T> MultiDocumentEntity<DocumentUpdateEntity<T>> |
C8Collection.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>> |
C8Collection.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 |
C8EdgeCollection.updateEdge(String key,
T value) |
Partially updates the edge identified by document-key.
|
<T> EdgeUpdateEntity |
C8EdgeCollection.updateEdge(String key,
T value,
EdgeUpdateOptions options) |
Partially updates the edge identified by document-key.
|
Boolean |
C8DB.updateSpotRegionForGeoFabric(String tenant,
String name,
String spotDc) |
Updates the edge location where on-spot operations will be performed.
|
UserEntity |
C8DB.updateUser(String user,
UserUpdateOptions options) |
Partially updates the data of an existing user.
|
<T> VertexUpdateEntity |
C8VertexCollection.updateVertex(String key,
T value) |
Partially updates the vertex identified by document-key.
|
<T> VertexUpdateEntity |
C8VertexCollection.updateVertex(String key,
T value,
VertexUpdateOptions options) |
Partially updates the vertex identified by document-key.
|