Trait/Object

com.outr.arango.managed

UpgradeSupport

Related Docs: object UpgradeSupport | package managed

Permalink

trait UpgradeSupport extends Graph

Adds support to the Graph to manage database upgrades and versioning.

Overrides Graph.init to run upgrades immediately after other initialization occurs.

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

Abstract Value Members

  1. abstract val store: MapCollection

    Permalink

    A MapCollection must be defined for UpgradeSupport to retain the database version.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def call[T](query: Query)(implicit decoder: Decoder[T]): Future[T]

    Permalink
    Definition Classes
    Graph
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collections: List[AbstractCollection[_]]

    Permalink
    Definition Classes
    Graph
  8. def cursor: ArangoCursor

    Permalink
    Definition Classes
    Graph
  9. def delete(dropCollections: Boolean = true): Future[Boolean]

    Permalink

    Deletes the graph.

    Deletes the graph.

    dropCollections

    true if the collections should also be dropped. Defaults to true.

    returns

    true if the operation completed successfully

    Definition Classes
    Graph
  10. macro def edge[T <: Edge with DocumentOption](name: String, links: (String, String)*): EdgeCollection[T]

    Permalink
    Definition Classes
    Graph
  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def execute(query: Query): Future[Boolean]

    Permalink
    Definition Classes
    Graph
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def first[T](query: Query)(implicit decoder: Decoder[T]): Future[Option[T]]

    Permalink
    Definition Classes
    Graph
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. def init(createGraph: Boolean, createCollections: Boolean): Future[Boolean]

    Permalink

    Initializes this graph instance, database, and session creating the graph and collections if it doesn't already exist (if createGraph and createCollections is true).

    Initializes this graph instance, database, and session creating the graph and collections if it doesn't already exist (if createGraph and createCollections is true). This can be invoked multiple times without risk of duplicate functionality.

    createGraph

    automatically creates the graph if it doesn't already exist if set to true. Defaults to true.

    createCollections

    automatically creates the collections if they don't already exist if set to true. Defaults to true.

    returns

    true if the operation completed without error

    Definition Classes
    UpgradeSupportGraph
  19. val initialized: Channel[Boolean]

    Permalink
    Definition Classes
    Graph
  20. lazy val instance: ArangoGraph

    Permalink
    Attributes
    protected[com.outr.arango.managed]
    Definition Classes
    Graph
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def latestVersion: Int

    Permalink

    Determines the latest version available based on the upgrades registered.

  23. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def polymorphic[T <: PolymorphicDocumentOption](name: String, types: PolymorphicType[T]*): PolymorphicVertexCollection[T]

    Permalink
    Definition Classes
    Graph
  27. macro def polymorphic2[T <: PolymorphicDocumentOption, P1 <: T, P2 <: T](name: String): PolymorphicVertexCollection[T]

    Permalink
    Definition Classes
    Graph
  28. macro def polymorphic3[T <: PolymorphicDocumentOption, P1 <: T, P2 <: T, P3 <: T](name: String): PolymorphicVertexCollection[T]

    Permalink
    Definition Classes
    Graph
  29. macro def polymorphic4[T <: PolymorphicDocumentOption, P1 <: T, P2 <: T, P3 <: T, P4 <: T](name: String): PolymorphicVertexCollection[T]

    Permalink
    Definition Classes
    Graph
  30. macro def polymorphicType[T <: PolymorphicDocumentOption, P <: T](value: String): PolymorphicType[T]

    Permalink
    Definition Classes
    Graph
  31. lazy val realTime: RealTime

    Permalink
    Definition Classes
    Graph
  32. def register(version: Int, runOnNewDatabase: Boolean = true)(f: ⇒ Future[Unit]): Unit

    Permalink

    Registers an upgrade for a specific version.

    Registers an upgrade for a specific version. Version numbers should start at 1 as 0 represents the initial state.

    runOnNewDatabase

    if false the upgrade will be skipped if the upgrade is invoked on a new database. This is useful for database migration functionality that presumes data in a specific state but is not applicable on a new instance. Defaults to true.

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def synchronous[T](future: Future[T], timeout: FiniteDuration = 10.seconds): T

    Permalink
    Definition Classes
    Graph
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. def upgrade(): Future[Unit]

    Permalink

    Runs all registered but un-applied database upgrades to get to the latest version.

  37. def version: Future[Int]

    Permalink

    The current version of the database.

    The current version of the database. If no upgrades have been run the version will be 0.

  38. macro def vertex[T <: DocumentOption](name: String): VertexCollection[T]

    Permalink
    Definition Classes
    Graph
  39. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Graph

Inherited from AnyRef

Inherited from Any

Ungrouped