Packages

c

gnieh.sohva

CouchClient

class CouchClient extends CouchDB

A CouchDB instance. Allows users to access the different databases and instance information. This is the key class to start with when one wants to work with couchdb. Through this one you will get access to the sessions and anonymous access to databases.

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

Instance Constructors

  1. new CouchClient(host: String = "localhost", port: Int = 5984, ssl: Boolean = false)(implicit system: ActorSystem, timeout: Timeout)

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. def allDbs: Future[List[String]]

    Returns the names of all databases in this couch instance.

    Returns the names of all databases in this couch instance.

    Definition Classes
    CouchDB
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def config(section: String, key: String): Future[Option[String]]

    Returns the configuration value Returns None if the value does not exist

    Returns the configuration value Returns None if the value does not exist

    Definition Classes
    CouchDB
  8. def config(section: String): Future[Map[String, String]]

    Returns the configuration section identified by its name (an empty map is returned if the section does not exist)

    Returns the configuration section identified by its name (an empty map is returned if the section does not exist)

    Definition Classes
    CouchDB
  9. def config: Future[Configuration]

    Returns the configuration object for this CouchDB instance

    Returns the configuration object for this CouchDB instance

    Definition Classes
    CouchDB
  10. def connectionFlow: Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchDB
  11. def contains(dbName: String): Future[Boolean]

    Indicates whether this couchdb instance contains the given database

    Indicates whether this couchdb instance contains the given database

    Definition Classes
    CouchDB
  12. def database(name: String, credit: Int = 0, strategy: Strategy = BarneyStinsonStrategy): Database

    Returns the database on the given couch instance.

    Returns the database on the given couch instance.

    Definition Classes
    CouchDB
  13. def dbUpdates(timeout: Option[Int] = None, heartbeat: Boolean = true): Source[DbUpdate, UniqueKillSwitch]
    Definition Classes
    CouchDB
  14. def deleteConfigValue(section: String, key: String): Future[Boolean]

    Deletes the given configuration key inthe specified section

    Deletes the given configuration key inthe specified section

    Definition Classes
    CouchDB
  15. implicit def ec: ExecutionContext
    Definition Classes
    CouchClientCouchDB
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. val host: String
    Definition Classes
    CouchClientCouchDB
  22. def http(req: HttpRequest): Future[JsValue]
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchDB
  23. def info: Future[CouchInfo]

    Returns the couchdb instance information

    Returns the couchdb instance information

    Definition Classes
    CouchDB
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. implicit val materializer: Materializer
    Definition Classes
    CouchClientCouchDB
  26. def membership: Future[Membership]

    Returns the list of nodes known by this node and the clusters.

    Returns the list of nodes known by this node and the clusters.

    Definition Classes
    CouchDB
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. def ok(json: JsValue): Boolean
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchDB
    Annotations
    @inline()
  31. def optHttp(req: HttpRequest): Future[Option[JsValue]]
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchDB
  32. val port: Int
    Definition Classes
    CouchClientCouchDB
  33. def prepare(req: HttpRequest): HttpRequest
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchClientCouchDB
  34. def rawHttp(req: HttpRequest): Future[HttpResponse]
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchDB
  35. def replicator(name: String = "_replicator", credit: Int = 0, strategy: Strategy = BarneyStinsonStrategy): Replicator

    Returns the replicator database

    Returns the replicator database

    Definition Classes
    CouchDB
  36. def restart: Future[Boolean]

    Restarts the CouchDB instance.

    Restarts the CouchDB instance.

    Definition Classes
    CouchDB
  37. def saveConfigValue(section: String, key: String, value: String): Future[Boolean]

    Saves the given key/value association in the specified section The section and/or the key is created if it does not exist

    Saves the given key/value association in the specified section The section and/or the key is created if it does not exist

    Definition Classes
    CouchDB
  38. val ssl: Boolean
    Definition Classes
    CouchClientCouchDB
  39. def startBasicSession(username: String, password: String): BasicSession

    Starts a new HTTP Basic authentication session

  40. def startOAuthSession(consumerKey: String, consumerSecret: String, token: String, secret: String): OAuthSession

    Starts a new OAuth session

  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. implicit val system: ActorSystem
    Definition Classes
    CouchClientCouchDB
  43. implicit val timeout: Timeout
  44. def toString(): String
    Definition Classes
    CouchDB → AnyRef → Any
  45. val uri: Uri
    Attributes
    protected[gnieh.sohva]
    Definition Classes
    CouchClientCouchDB
  46. def uuid: Future[String]

    Returns one UUID

    Returns one UUID

    Definition Classes
    CouchDB
  47. def uuids(count: Int = 1): Future[List[String]]

    Returns the requested number of UUIDS (by default 1).

    Returns the requested number of UUIDS (by default 1).

    Definition Classes
    CouchDB
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  51. def withCredentials(credentials: CouchCredentials): Session

    Starts a new session with the given credential

  52. object users extends Users

    Exposes the interface for managing couchdb users.

    Exposes the interface for managing couchdb users.

    Definition Classes
    CouchDB

Deprecated Value Members

  1. def _all_dbs: Future[List[String]]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use allDbs instead

  2. def _config(section: String, key: String): Future[Option[String]]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use config instead

  3. def _config(section: String): Future[Map[String, String]]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use config instead

  4. def _config: Future[Configuration]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use config instead

  5. def _uuid: Future[String]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use uuid instead

  6. def _uuids(count: Int = 1): Future[List[String]]
    Definition Classes
    CouchDB
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) Use uuids instead

Inherited from CouchDB

Inherited from AnyRef

Inherited from Any

CouchDB2

Ungrouped