zio-arangodb
API
Generated with
zio-arangodb/io.funkode.arangodb/io.funkode.arangodb.model

io.funkode.arangodb.model

package io.funkode.arangodb.model

Members list

Type members

Classlikes

case class ArangoError(code: Long, error: Boolean, errorMessage: String, errorNum: Long) extends Throwable

Attributes

Companion
object
Supertypes
trait Product
trait Equals
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
object ArangoError

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ArangoRequestStatus(error: Boolean, code: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ArangoResponse[T](status: ArangoRequestStatus, result: T)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ArangoResult[T](error: Boolean, code: Int, result: T)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CollectionChecksum(name: CollectionName, checksum: String, revision: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CollectionCount(count: Long)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class CollectionCreate(name: CollectionName, distributeShardsLike: String, doCompact: Boolean, indexBuckets: Option[Long], isSystem: Boolean, isVolatile: Boolean, journalSize: Option[Long], keyOptions: Option[KeyOptions], numberOfShards: Long, replicationFactor: Long, shardKeys: List[String], shardingStrategy: Option[String], smartJoinAttribute: Option[String], `type`: CollectionType, waitForSync: Boolean, waitForSyncReplication: Int, enforceReplicationFactor: Int)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CollectionCreate

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class CollectionInfo(id: String, name: CollectionName, status: CollectionStatus, `type`: CollectionType, isSystem: Boolean, globallyUniqueId: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CollectionName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
enum CollectionStatus(value: Int)

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum CollectionType(val value: Int)

Attributes

Companion
object
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CollectionType

Attributes

Companion
enum
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DatabaseCreate(name: DatabaseName, users: List[User], options: Map[String, String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DatabaseCreate

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DatabaseInfo(name: String, id: String, path: String, isSystem: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DatabaseName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class DeleteResult(id: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Document[T](_id: DocumentHandle, _key: DocumentKey, _rev: DocumentRevision, `new`: Option[T], old: Option[T], _oldRev: Option[DocumentRevision])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DocumentHandle

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object DocumentKey

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class DocumentMetadata(_id: DocumentHandle, _key: DocumentKey, _rev: DocumentRevision)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DocumentRevision

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class EdgeDocumentCreated[T](error: Boolean, code: Long, edge: DocumentMetadata, `new`: Option[Document[T]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class EdgeDocumentDeleted[T](error: Boolean, code: Long, edge: DocumentMetadata, old: Option[Document[T]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphCollections(collections: List[CollectionName])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphCreate(name: GraphName, edgeDefinitions: List[GraphEdgeDefinition], orphanCollections: List[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphEdge[T](edge: T)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphEdgeDefinition(collection: CollectionName, from: List[CollectionName], to: List[CollectionName])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class GraphInfo(_id: String, _rev: String, name: GraphName, edgeDefinitions: List[GraphEdgeDefinition], minReplicationFactor: Option[Int], numberOfShards: Option[Int], orphanCollections: List[CollectionName], replicationFactor: Option[Int], isSmart: Boolean, smartGraphAttribute: Option[String])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphInfo

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
GraphInfo.type
case class GraphList(graphs: List[GraphInfo])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GraphName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
GraphName.type
case class GraphVertex[T](vertex: T)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait IndexCreate

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Geo
object IndexCreate

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
enum IndexGeoFields

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
case Location
case LatLong
object IndexHandle

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object IndexId

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
IndexId.type
enum IndexInfo(val handle: IndexHandle, val name: IndexName)

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
case Edge
case Fulltext
case Geo
case Inverted
case Persistent
case Primary
case TimeToLive
Show all
object IndexName

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
IndexName.type
final case class IndexesInfo(indexes: List[IndexInfo])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Query(query: String, bindVars: Option[VObject], batchSize: Option[Long], cache: Option[Boolean], count: Option[Boolean], memoryLimit: Option[Long], options: Option[Options], ttl: Option[Long])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Query

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Query.type
final case class QueryResults[T](cached: Boolean, count: Option[Long], extra: Option[Extra], hasMore: Boolean, id: Option[String], result: List[T])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object QueryResults

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RemovedResult(removed: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ServerVersion(server: String, license: String, version: String, details: Map[String, String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Token(jwt: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Transaction(id: TransactionId, status: String)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Transaction

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object TransactionId

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class UserPassword(username: String, password: String)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VertexCollectionCreate(collection: CollectionName)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VertexDocumentCreated[T](error: Boolean, code: Long, vertex: DocumentMetadata, `new`: Option[Document[T]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class VertexDocumentDeleted[T](error: Boolean, code: Long, removed: Boolean, old: Option[Document[T]])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

opaque type CollectionName
opaque type DatabaseName
opaque type DocumentHandle
opaque type DocumentKey
opaque type DocumentRevision
opaque type GraphName
opaque type IndexHandle
opaque type IndexId
opaque type IndexName
opaque type TransactionId
Generated with