class GraphClient extends ArangoClient with Auth
Manages Graph API operations
- Alphabetic
- By Inheritance
- GraphClient
- ArangoClient
- Auth
- ArangoConfig
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new GraphClient(hostMachine: String = "localhost", port: Int = 8529, https: Boolean = false, databaseName: String)
Type Members
-
case class
Auth(username: String, password: String) extends Product with Serializable
- Definition Classes
- Auth
-
case class
Jwt(jwt: String, must_change_password: Boolean) extends Product with Serializable
- Definition Classes
- Auth
-
type
DatabaseName = String
- Definition Classes
- ArangoClient
-
type
JWT = String
- Definition Classes
- ArangoClient
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
-
implicit
val
arangoHost: String
- Attributes
- protected
- Definition Classes
- ArangoClient
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
auth(request: HttpRequest)(implicit arangoHost: String): HttpRequest
- Definition Classes
- Auth
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
val
conf: Config
- Definition Classes
- ArangoConfig
-
def
createCollection(dbName: String, collectionName: String): Future[Either[Throwable, CollectionResponse]]
Creates a new collection
Creates a new collection
- Definition Classes
- ArangoClient
-
def
createDatabase(dbName: String, users: Option[List[User]]): Future[Either[Throwable, Unit]]
Creates a new database
Creates a new database
- Definition Classes
- ArangoClient
-
def
createEdge(graphName: String, collectionName: String, edgeType: String, from: String, to: String): Future[Either[Throwable, EdgeOrVertex]]
Creates a new edge in the collection.
Creates a new edge in the collection. Within the body the has to contain a _from and _to value referencing to valid vertices in the graph. Furthermore the edge has to be valid in the definition of this edge collection.
free-style json body
-
def
createEdgeCollection(graphName: String, collectionName: String, from: List[String], to: List[String]): Future[Either[Throwable, List[EdgeDefinition]]]
Adds an additional edge definition to the graph.
-
def
createGraph(graphName: String, edges: List[EdgeDefinition]): Future[Either[Throwable, GraphResponse]]
Create the Graph
-
def
createVertex(graphName: String, vertexCollection: String, json: String): Future[Either[Throwable, EdgeOrVertex]]
Adds a vertex to the given collection.
Adds a vertex to the given collection. free style json body
-
def
createVertexCollection(graphName: String, collectionName: String): Future[Either[Throwable, GraphResponse]]
Adds a vertex to the given collection.
-
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
-
def
deleteEdge(graphName: String, collectionName: String, edgeKey: String): Future[Either[Throwable, Unit]]
Removes an edge from the collection.
-
def
deleteEdgeCollection(graphName: String, collectionName: String): Future[Either[Throwable, Unit]]
Remove one edge definition from the graph.
Remove one edge definition from the graph. This will only remove the edge collection, the vertex collections remain untouched and can still be used in your queries.
-
def
deleteVertex(graphName: String, collectionName: String, vertexKey: String): Future[Either[Throwable, Unit]]
Removes a vertex from the collection.
-
def
deleteVertexCollection(graphName: String, collectionName: String): Future[Either[Throwable, Unit]]
Removes a vertex collection from the graph and optionally deletes the collection, if it is not used in any other graph.
-
def
dropCollection(dbName: String, collectionName: String): Future[Either[Throwable, CollectionResponse]]
Drops a collection
Drops a collection
- Definition Classes
- ArangoClient
-
def
dropGraph(graphName: String): Future[Either[Throwable, Boolean]]
Drops Graph
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getCurrentDatabase: Future[Either[Throwable, CurrentDatabase]]
- Definition Classes
- ArangoClient
-
def
getDatabaseList: Future[Either[Throwable, List[DatabaseName]]]
Retrieves the list of all existing databases
Retrieves the list of all existing databases
- Definition Classes
- ArangoClient
-
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()
-
val
password: String
- Definition Classes
- ArangoConfig
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
userName: String
- Definition Classes
- ArangoConfig
-
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
- @native() @throws( ... )