Class/Object

core3.database.dals.json

CouchDB

Related Docs: object CouchDB | package json

Permalink

class CouchDB extends DatabaseAbstractionLayerComponent

A Database Abstraction Layer for accessing a CouchDB database.

Note: When the DAL is used for caching, partial containers are written to the databases and the DAL cannot be used for reading.

Linear Supertypes
DatabaseAbstractionLayerComponent, Component, Actor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CouchDB
  2. DatabaseAbstractionLayerComponent
  3. Component
  4. Actor
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CouchDB(containerCompanions: Map[ContainerType, JSONContainerCompanion], ws: WSClient, config: Config = ...)(implicit ec: ExecutionContext, timeout: Timeout)

    Permalink

    Creates a new instance with the supplied config or uses the default config location.

    Creates a new instance with the supplied config or uses the default config location.

    containerCompanions

    map with all registered container companion objects

    ws

    web service client

    config

    the config to use (if specified; default path is 'server.static.database.couchdb')

    returns

    the new instance

  2. new CouchDB(hostname: String, port: Int, schema: String, username: String, password: String, containerCompanions: Map[ContainerType, JSONContainerCompanion], cacheOnly: Boolean, ws: WSClient)(implicit ec: ExecutionContext, timeout: Timeout)

    Permalink

    creates a new CouchDB DAL

    creates a new CouchDB DAL

    hostname

    the hostname of the CouchDB instance

    port

    the port of the CouchDB instance

    schema

    the schema to be used for HTTP connections ["http" OR "https"]

    username

    the DB user to be used when authenticating each request

    password

    the password for the DB user

    containerCompanions

    map with all registered container companion objects

    cacheOnly

    set to 'true' to use the DAL for caching

    ws

    web service client

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Permalink
    Definition Classes
    Actor

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. def addReceiver(next: akka.actor.Actor.Receive): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Component

  5. def aroundPostRestart(reason: Throwable): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor

  6. def aroundPostStop(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor

  7. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor

  8. def aroundPreStart(): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor

  9. def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

    Permalink
    Attributes
    protected[akka]
    Definition Classes
    Actor

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  11. val cacheOnly: Boolean

    Permalink

    set to 'true' to use the DAL for caching

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. implicit val context: ActorContext

    Permalink
    Definition Classes
    Actor

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  18. def handle_BuildDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  19. def handle_ClearDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  20. def handle_CreateObject(container: Container): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  21. def handle_DeleteObject(objectType: ContainerType, objectID: ObjectID): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  22. def handle_ExecuteAction(action: String, params: Option[Map[String, Option[String]]]): Future[ActionResult]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → Component

  23. def handle_GetCustomQueryResult(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]): Future[ContainerSet]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  24. def handle_GetDatabaseIdentifier: String

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  25. def handle_GetGenericQueryResult(objectsType: ContainerType): Future[ContainerSet]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  26. def handle_GetLayerType: LayerType

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  27. def handle_GetObject(objectType: ContainerType, objectID: ObjectID): Future[Container]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  28. def handle_GetSupportedContainers: Vector[ContainerType]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  29. def handle_LoadView(view: ContainerView): Future[Unit]

    Permalink
    Attributes
    protected
    Definition Classes
    DatabaseAbstractionLayerComponent

  30. def handle_UpdateObject(container: MutableContainer): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  31. def handle_VerifyDatabaseStructure(objectsType: ContainerType): Future[Boolean]

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → DatabaseAbstractionLayerComponent

  32. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  37. def postRestart(reason: Throwable): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )

  38. def postStop(): Unit

    Permalink
    Definition Classes
    Component → Actor

  39. def preRestart(reason: Throwable, message: Option[Any]): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )

  40. def preStart(): Unit

    Permalink
    Definition Classes
    Actor
    Annotations
    @throws( classOf[java.lang.Exception] )

  41. def receive: Receive

    Permalink
    Definition Classes
    Component → Actor

  42. implicit final val self: ActorRef

    Permalink
    Definition Classes
    Actor

  43. final def sender(): ActorRef

    Permalink
    Definition Classes
    Actor

  44. def shutdown(): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    CouchDB → Component

  45. def supervisorStrategy: SupervisorStrategy

    Permalink
    Definition Classes
    Actor

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

    Permalink
    Definition Classes
    AnyRef

  47. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  48. def unhandled(message: Any): Unit

    Permalink
    Definition Classes
    Actor

  49. final def wait(): Unit

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

  50. final def wait(arg0: Long, arg1: Int): Unit

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

  51. final def wait(arg0: Long): Unit

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

Inherited from DatabaseAbstractionLayerComponent

Inherited from Component

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped