trait ArangoDatabase[F[_]] extends AnyRef
ArangoDB database API
- F
effect
- Self Type
- ArangoDatabase[F]
- See also
https://www.arangodb.com/docs/stable/http/database-database-management.html
- Alphabetic
- By Inheritance
- ArangoDatabase
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
collection(name: CollectionName): ArangoCollection[F]
collection api
-
abstract
def
collections(excludeSystem: Boolean = false): F[ArangoResponse[Vector[CollectionInfo]]]
Returns all collections
Returns all collections
- excludeSystem
Whether or not system collections should be excluded from the result
- returns
array of collection informations
-
abstract
def
create(users: User*): F[ArangoResponse[Boolean]]
Creates a new database
Creates a new database
- 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:
-
abstract
def
document(handle: DocumentHandle): ArangoDocument[F]
document api
-
abstract
def
drop(): F[ArangoResponse[Boolean]]
Drops the database along with all data stored in it.
Drops the database along with all data stored in it.
- returns
result
- Note
dropping a database is only possible from within the _system database. The _system database itself cannot be dropped.
-
abstract
def
info(): F[ArangoResponse[DatabaseInfo]]
Retrieves the properties of the current database
Retrieves the properties of the current database
- returns
database information
-
abstract
def
name: DatabaseName
database name
-
abstract
def
query[V](query: Query[V])(implicit arg0: VPackEncoder[V]): ArangoQuery[F, V]
Builds a AQL query
Builds a AQL query
- V
bind type
- query
query
- returns
query api
-
abstract
def
transactions: ArangoTransactions[F]
transaction api
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
query(qs: String): ArangoQuery[F, VObject]
Build a AQL query with empty bind parameters
Build a AQL query with empty bind parameters
- qs
the query string to be executed
- returns
query api
-
def
query[V](qs: String, bindVars: V)(implicit arg0: VPackEncoder[V]): ArangoQuery[F, V]
Builds a AQL query with bind parameters
Builds a AQL query with bind parameters
- V
bind type
- qs
the query string to be executed
- bindVars
key/value pairs representing the bind parameters.
- returns
query api
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()