sohva

Type Members

1. final case class Attachment(content_type: String, revpos: Int, digest: String, length: Int, stub: Boolean, encoded_length: Option[Int] = None, encoding: Option[String] = None) extends Product with Serializable

   

2. trait Attachments extends AnyRef

   

   Mix in this trait with any object to have automatic management of the attachment fields

3. case class AuthInfo(authentication_db: String, authentication_handlers: List[String], authenticated: String) extends Product with Serializable

   

   Authentication information indicating the authentication database, the handler used and the authentication method

4. case class AuthResult(ok: Boolean, userCtx: UserCtx, info: Option[AuthInfo]) extends Product with Serializable

   

   Result of the authentication request

5. trait CList[Result[_]] extends AnyRef

   

   A list that can be queried for a given view.

6. case class Change(seq: Int, id: String, rev: String, deleted: Boolean, doc: Option[JObject]) extends Product with Serializable

   

7. trait ChangeStream extends AnyRef

   

   A stream that represents a connection to the _changes stream of a database.

8. case class Configuration(sections: Map[String, Map[String, String]]) extends Product with Serializable

   

   The configuration object of a couchdb instance

9. class ConflictException extends CouchException

   

10. trait CookieSession[Result[_]] extends CouchDB[Result] with Session[Result]

    

    An instance of a Couch session that allows the user to login and send request identified with the login credentials.

    An instance of a Couch session that allows the user to login and send request identified with the login credentials. This performs a cookie based authentication against the couchdb server. The couchdb client instance retrieved for this session will send request authenticated by the user that logged in in this session.

11. trait CouchClient[Result[_]] extends CouchDB[Result]

    

    A CouchDB instance.

    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.

12. sealed trait CouchCredentials extends AnyRef

    

13. trait CouchDB[Result[_]] extends AnyRef

    

    A CouchDB instance.

    A CouchDB instance. Allows users to access the different databases and 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 databases.

14. class CouchException extends Exception

    

15. final case class CouchInfo(couchdb: String, version: String) extends Product with Serializable

    

16. case class CouchUser(name: String, password: String, roles: List[String], oauth: Option[OAuthData] = None, type: String = "user") extends IdRev with Product with Serializable

    

17. trait Database[Result[_]] extends AnyRef

    

    Gives the user access to the different operations available on a database.

    Gives the user access to the different operations available on a database. Among other operations this is the key class to get access to the documents of this database.

    It also exposes the change handler interface, that allows people to react to change notifications. This is a low-level API, that handles raw Json objects

18. abstract class DbRef extends AnyRef

    

    A Reference to a database.

19. sealed trait DbResult extends AnyRef

    

20. trait Design[Result[_]] extends AnyRef

    

    A design gives access to the different views.

    A design gives access to the different views. Use this class to get or create new views.

21. case class DesignDoc(_id: String, language: String, views: Map[String, ViewDoc] = Map(), validate_doc_update: Option[String] = None, updates: Map[String, String] = Map(), filters: Map[String, String] = Map(), shows: Map[String, String] = Map(), lists: Map[String, String] = Map(), rewrites: List[RewriteRule] = Nil) extends IdRev with Product with Serializable

    

22. type Doc = AnyRef { ... /* 2 definitions in type refinement */ }

    

    A couchdb document must have an _id field and an optional _rev field.

23. final case class DocUpdate(ok: Boolean, id: String, rev: String) extends Product with Serializable

    

24. final case class ErrorResult(id: Option[String], error: String, reason: String) extends DbResult with Product with Serializable

    

25. trait IdRev extends AnyRef

    

    Mix in this trait with any object to have more efficient automatic handling of documents (no reflective method call is performed)

26. final case class InfoResult(compact_running: Boolean, db_name: String, disk_format_version: Int, disk_size: Int, doc_count: Int, doc_del_count: Int, instance_start_time: String, purge_seq: Int, update_seq: Int) extends Product with Serializable

    

27. class JsonSerializer extends AnyRef

    

    The interface for the Json serializer/deserializer.

    The interface for the Json serializer/deserializer. Allows for changing the implementation and using your favorite json library.

28. case class LastSeq(last_seq: Int) extends Product with Serializable

    

29. case class LocalDb(name: String) extends DbRef with Product with Serializable

    

    A Reference to a local database identified by its name.

30. final case class LoginPasswordCredentials(username: String, password: String) extends CouchCredentials with Product with Serializable

    

31. final case class OAuthCredentials(consumerKey: String, consumerSecret: String, token: String, secret: String) extends CouchCredentials with Product with Serializable

    

32. case class OAuthData(consumer_keys: Map[String, String], tokens: Map[String, String]) extends Product with Serializable

    

33. trait OAuthSession[Result[_]] extends CouchDB[Result] with Session[Result]

    

    An instance of a Couch session that allows the user to perform authenticated operations using OAuth.

34. final case class OkResult(ok: Boolean, id: Option[String], rev: Option[String]) extends DbResult with Product with Serializable

    

35. final case class RawRow(id: Option[String], key: JValue, value: JValue, doc: Option[JObject]) extends Product with Serializable

    

36. final case class RawViewResult(total_rows: Long, offset: Long, rows: List[RawRow], update_seq: Option[Long]) extends Product with Serializable

    

37. case class RemoteDb(url: URL) extends DbRef with Product with Serializable

    

    A Reference to a remote database identified by its url.

38. case class Replication(_id: String, source: DbRef, target: DbRef, continuous: Option[Boolean] = None, create_target: Option[Boolean] = None, _replication_id: Option[String] = None, _replication_state: Option[String] = None, _replication_state_time: Option[String] = None, doc_ids: List[String] = Nil, user_ctx: Option[UserCtx] = None) extends IdRev with Product with Serializable

    

    A replication document contains information about a particular replication process (continuous or not, ...)

39. trait Replicator[Result[_]] extends Database[Result]

    

    A replicator database that allows people to manage replications:

    A replicator database that allows people to manage replications:

    • start replication
    • cancel or stop replications
    • list current replications

40. case class RewriteRule(from: String, to: String, method: String, query: Map[String, String]) extends Product with Serializable

    

41. case class Row[Key, Value, Doc](id: Option[String], key: Key, value: Value, doc: Option[Doc] = None) extends Product with Serializable

    

42. case class SecurityDoc(admins: SecurityList = EmptySecurityList, members: SecurityList = EmptySecurityList) extends Product with Serializable

    

    A security document is a special document for couchdb.

    A security document is a special document for couchdb. It has no _id or _rev field.

43. case class SecurityList(names: List[String] = Nil, roles: List[String] = Nil) extends Product with Serializable

    

44. trait Session[Result[_]] extends CouchDB[Result]

    

    Methods that must be implemented by a session.

45. trait Show[Result[_]] extends AnyRef

    

    A show function that can be queried.

46. case class SohvaException(msg: String, cause: Throwable = null) extends Exception with Product with Serializable

    

47. case class SohvaJsonException(msg: String, inner: Exception) extends Exception with Product with Serializable

    

48. trait SohvaSerializer[T] extends AnyRef

    

    Implement this trait to define a custom serializer that may handle object differently based on the CouchDB version

49. trait Update[Result[_]] extends AnyRef

    

    An update handler that can be queried.

50. case class UserCtx(name: String, roles: List[String]) extends Product with Serializable

    

    The user context giving his name and roles

51. case class UserInfo(name: String, roles: List[String]) extends Product with Serializable

    

    A couchdb user has a name, a password and a lit of roles.

52. trait Users[Result[_]] extends AnyRef

    

    The users database, exposing the interface for managing couchdb users.

53. trait View[Result[_]] extends AnyRef

    

    A view can be queried to get the result.

54. case class ViewDoc(map: String, reduce: Option[String]) extends Product with Serializable

    

55. final case class ViewResult[Key, Value, Doc](total_rows: Int, offset: Int, rows: List[Row[Key, Value, Doc]], update_seq: Option[Int]) extends Product with Serializable