Packages

class DocumentClient extends ArangoClient with Auth

Manages Document API operations

Linear Supertypes
ArangoClient, proteus.Auth, ArangoConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentClient
  2. ArangoClient
  3. Auth
  4. ArangoConfig
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentClient(host: String = "localhost", port: Int = 8529, https: Boolean = false, databaseName: String)

Type Members

  1. case class Auth(username: String, password: String) extends Product with Serializable
    Definition Classes
    Auth
  2. case class Jwt(jwt: String, must_change_password: Boolean) extends Product with Serializable
    Definition Classes
    Auth
  3. type DatabaseName = String
    Definition Classes
    ArangoClient
  4. type JWT = String
    Definition Classes
    ArangoClient

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. implicit val arangoHost: String
    Attributes
    protected
    Definition Classes
    ArangoClient
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def auth(request: HttpRequest)(implicit arangoHost: String): HttpRequest
    Definition Classes
    Auth
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. val conf: Config
    Definition Classes
    ArangoConfig
  9. def createCollection(dbName: String, collectionName: String): Future[Either[Throwable, CollectionResponse]]

    Creates a new collection

    Creates a new collection

    Definition Classes
    ArangoClient
  10. def createDatabase(dbName: String, users: Option[List[User]]): Future[Either[Throwable, Unit]]

    Creates a new database

    Creates a new database

    Definition Classes
    ArangoClient
  11. def createDocument(dbName: String, collectionName: String, documentString: String): Future[Either[Throwable, String]]

    Creates a new document in the collection named collection

    Creates a new document in the collection named collection

    returns

    document key

  12. def deleteDatabase(dbName: String): Future[Either[Throwable, Unit]]

    Deletes the database along with all data stored in it

    Deletes the database along with all data stored in it

    Definition Classes
    ArangoClient
  13. def deleteDocument(dbName: String, collectionName: String, documentID: String): Future[Either[Throwable, Unit]]

    Deletes a document using its unique URI

  14. def dropCollection(dbName: String, collectionName: String): Future[Either[Throwable, CollectionResponse]]

    Drops a collection

    Drops a collection

    Definition Classes
    ArangoClient
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getAllDocuments(dbName: String, collectionName: String): Future[Either[Throwable, List[String]]]

    Returns a list of all URI for all documents from the collection identified by collectionName.

  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def getCurrentDatabase: Future[Either[Throwable, CurrentDatabase]]
    Definition Classes
    ArangoClient
  21. def getDatabaseList: Future[Either[Throwable, List[DatabaseName]]]

    Retrieves the list of all existing databases

    Retrieves the list of all existing databases

    Definition Classes
    ArangoClient
  22. def getDocument(dbName: String, collectionName: String, documentID: String): Future[Either[Throwable, String]]

    Retrieve a document using its unique URI:

    Retrieve a document using its unique URI:

    returns

    document JSON body

  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. val password: String
    Definition Classes
    ArangoConfig
  29. def replaceDocument(dbName: String, collectionName: String, documentID: String, documentString: String): Future[Either[Throwable, String]]

    Replaces a document with documentString

    Replaces a document with documentString

    returns

    document key

  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. val userName: String
    Definition Classes
    ArangoConfig
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from ArangoClient

Inherited from proteus.Auth

Inherited from ArangoConfig

Inherited from AnyRef

Inherited from Any

Ungrouped