Packages

trait ArangoDatabase[F[_]] extends AnyRef

Scala wrapper for ar.ArangoDatabaseAsync

F

The effect type

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ArangoDatabase
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def accessibleDatabases: F[Iterable[String]]

    Returns a list of all accessible datbases

  2. abstract def arango: ArangoDB[F]

    Returns the arangodb server ref on which this db runs

  3. abstract def collection(name: String, createOptions: Option[CollectionCreateOptions] = None): F[ArangoCollection[F]]

    Returns a collection (and creates it, if not exists)

  4. abstract def collections: F[Iterable[CollectionEntity]]

    Returns all collections

  5. abstract def create: F[Unit]

    Creates the database on server

    Creates the database on server

    See also

    exists

    drop

  6. abstract def cursor[T](cursorId: String)(implicit codec: DocumentCodec[T]): F[Option[ArangoCursor[T]]]
  7. abstract def deleteIndex(id: String): F[Unit]

    Deletes an index

  8. abstract def drop: F[Unit]

    Drops the database

    Drops the database

    See also

    exists

    create

  9. abstract def exists: F[Boolean]

    Returns true if the database exists

    Returns true if the database exists

    See also

    create

    drop

  10. abstract def explainQuery(query: String, bindVars: Map[String, Any] = Map.empty, options: AqlQueryExplainOptions = new AqlQueryExplainOptions): F[AqlExecutionExplainEntity]
  11. abstract def grantAccess(user: String, permissions: Permissions = Permissions.RW): F[Unit]

    Grants access to the database dbname for user user.

    Grants access to the database dbname for user user. You need permission to the _system database in order to execute this call.

  12. abstract def grantDefaultCollectionAccess(user: String, permissions: Permissions): F[Unit]

    Sets the default access level for collections within this database for the user user.

    Sets the default access level for collections within this database for the user user. You need permission to the _system database in order to execute this call.

  13. abstract def index(id: String): F[Option[IndexEntity]]

    Returns an index for the given id

  14. abstract def info: F[DatabaseEntity]

    Returns db info

    Returns db info

    See also

    com.arangodb.ArangoDatabase#getInfo()

  15. abstract def name: String

    Returns db name

    Returns db name

    See also

    com.arangodb.ArangoDatabase#name()

  16. abstract def permissions(user: String): F[Option[Permissions]]
  17. abstract def query[T](query: String, bindVars: Map[String, Any] = Map.empty, options: AqlQueryOptions = new AqlQueryOptions)(implicit codec: DocumentCodec[T]): F[ArangoCursor[T]]
  18. abstract def resetAccess(user: String): F[Unit]

    Clear the database access level, revert back to the default access level.

  19. abstract def unwrap: ArangoDatabaseAsync

    Access to underlying java driver

  20. abstract def version: F[ArangoDBVersion]

    Returns arango version details

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def revokeAccess(user: String): F[Unit]

    Revokes access to the database dbname for user user.

    Revokes access to the database dbname for user user. You need permission to the _system database in order to execute this call.

  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped