ArangoDB database API
Type parameters
- F
-
effect
Attributes
- See also
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
Members list
Value members
Abstract methods
collection api
collection api
Attributes
Returns all collections
Returns all collections
Value parameters
- excludeSystem
-
Whether or not system collections should be excluded from the result
Attributes
- Returns
-
array of collection informations
Creates a new database
Creates a new database
Value parameters
- users
-
Has to be an array of user objects to initially create for the new database. User information will not be changed for users that already exist. If users is not specified or does not contain any users, a default user root will be created with an empty string password. This ensures that the new database will be accessible after it is created. Each user object can contain the following attributes:
Attributes
document api
document api
Attributes
Drops the database along with all data stored in it.
Drops the database along with all data stored in it.
Attributes
- Returns
-
result
- Note
-
dropping a database is only possible from within the _system database. The _system database itself cannot be dropped.
graph api
graph api
Attributes
List all graphs
List all graphs
Attributes
- Returns
-
all graphs known to the graph module
Retrieves the properties of the current database
Retrieves the properties of the current database
Attributes
- Returns
-
database information
database name
database name
Attributes
Builds a AQL query
Builds a AQL query
Type parameters
- V
-
bind type
Value parameters
- query
-
query
Attributes
- Returns
-
query api
transaction api
transaction api
Attributes
Concrete methods
Builds a AQL query with bind parameters
Builds a AQL query with bind parameters
Type parameters
- V
-
bind type
Value parameters
- bindVars
-
key/value pairs representing the bind parameters.
- qs
-
the query string to be executed
Attributes
- Returns
-
query api
Build a AQL query with empty bind parameters
Build a AQL query with empty bind parameters
Value parameters
- qs
-
the query string to be executed
Attributes
- Returns
-
query api