Replicator

Abstract Value Members

abstract def _all_docs(key: Option[String] = None, keys: List[String] = Nil, startkey: Option[String] = None, startkey_docid: Option[String] = None, endkey: Option[String] = None, endkey_docid: Option[String] = None, limit: Int = 1, stale: Option[String] = None, descending: Boolean = false, skip: Int = 0, inclusive_end: Boolean = true): Result[List[String]]

Returns the list of identifiers of the documents in this database
Returns the list of identifiers of the documents in this database

Definition Classes
Database
abstract def attachTo(docId: String, attachment: String, stream: InputStream, contentType: String): Result[Boolean]

Attaches the given file (given as an input stream) to the given document id.
Attaches the given file (given as an input stream) to the given document id. If no mime type is given, sohva tries to guess the mime type of the file itself. It it does not manage to identify the mime type, the file won't be attached... This method returns true iff the file was attached to the document.

Definition Classes
Database
abstract def attachTo(docId: String, file: File, contentType: String): Result[Boolean]

Attaches the given file to the given document id.
Attaches the given file to the given document id. This method returns true iff the file was attached to the document.

Definition Classes
Database
abstract def builtInView(view: String): View[Result]

Returns a built-in view of this database, identified by its name.
Returns a built-in view of this database, identified by its name. E.g. _all_docs.

Definition Classes
Database
abstract def changes(since: Option[Int] = None, filter: Option[String] = None): ChangeStream

Registers to the change stream of this database with potential filter and since some revision.
Registers to the change stream of this database with potential filter and since some revision. If no revision is given changes that occurred before the connection was established are not sent

Definition Classes
Database
abstract def copy(origin: String, target: String, originRev: Option[String] = None, targetRev: Option[String] = None): Result[Boolean]

Copies the origin document to the target document.
Copies the origin document to the target document. If the target does not exist, it is created, otherwise it is updated and the target revision must be provided

Definition Classes
Database
abstract def couch: CouchDB[Result]

The couchdb instance this database belongs to
The couchdb instance this database belongs to

Definition Classes
Database
abstract def create: Result[Boolean]

Creates this database in the couchdb instance if it does not already exist.
Creates this database in the couchdb instance if it does not already exist. Returns true iff the database was actually created.

Definition Classes
Database
abstract def createDoc(doc: Any): Result[DbResult]

Creates a document in the database and returns its identifier and revision.
Creates a document in the database and returns its identifier and revision. If the json version of the object has a _id field, this identifier is used for the document, otherwise a new one is generated.

Definition Classes
Database
abstract def createDocs(doc: List[Any]): Result[List[DbResult]]

Creates a set of documents in the database and returns theirs identifiers and revision.
Creates a set of documents in the database and returns theirs identifiers and revision. If the json version of an object has a _id field, this identifier is used for the document, otherwise a new one is generated.

Definition Classes
Database
abstract val credit: Int

The retry credit
The retry credit

Definition Classes
Database
abstract def delete: Result[Boolean]

Deletes this database in the couchdb instance if it exists.
Deletes this database in the couchdb instance if it exists. Returns true iff the database was actually deleted.

Definition Classes
Database
abstract def deleteAttachment(docId: String, attachment: String): Result[Boolean]

Deletes the given attachment for the given docId
Deletes the given attachment for the given docId

Definition Classes
Database
abstract def deleteDoc(id: String): Result[Boolean]

Deletes the document identified by the given id from the database.
Deletes the document identified by the given id from the database. If the document exists it is deleted and the method returns true, otherwise returns false.

Definition Classes
Database
abstract def deleteDoc[T](doc: T)(implicit arg0: (T) ⇒ IdRev): Result[Boolean]

Deletes the document from the database.
Deletes the document from the database. The document will only be deleted if the caller provided the last revision

Definition Classes
Database
abstract def deleteDocs(ids: List[String], all_or_nothing: Boolean = false): Result[List[DbResult]]

Deletes a bunch of documents at once returning the results for each identifier in the document list.
Deletes a bunch of documents at once returning the results for each identifier in the document list. One can choose the update strategy by setting the parameter all_or_nothing to true or false.

Definition Classes
Database
abstract def design(designName: String, language: String = "javascript"): Design[Result]

Returns a design object that allows user to work with views
Returns a design object that allows user to work with views

Definition Classes
Database
abstract def exists: Result[Boolean]

Indicates whether this database exists
Indicates whether this database exists

Definition Classes
Database
abstract def getAttachment(docId: String, attachment: String): Result[Option[(String, InputStream)]]

Returns the given attachment for the given docId.
Returns the given attachment for the given docId. It returns the mime type if any given in the response and the input stream to read the response from the server.

Definition Classes
Database
abstract def getDocById[T](id: String, revision: Option[String] = None)(implicit arg0: Manifest[T]): Result[Option[T]]

Returns the document identified by the given id if it exists
Returns the document identified by the given id if it exists

Definition Classes
Database
abstract def getDocRevision(id: String): Result[Option[String]]

Returns the current revision of the document if it exists
Returns the current revision of the document if it exists

Definition Classes
Database
abstract def getDocRevisions(ids: List[String]): Result[List[(String, String)]]

Returns the current revision of the documents
Returns the current revision of the documents

Definition Classes
Database
abstract def getDocsById[T](ids: List[String])(implicit arg0: Manifest[T]): Result[List[T]]

Returns all the documents with given identifiers and of the given type.
Returns all the documents with given identifiers and of the given type. If the document with an identifier exists in the database but has not the required type, it is not added to the result

Definition Classes
Database
abstract def getRawDocById(id: String, revision: Option[String] = None): Result[Option[JValue]]

Returns the raw repsentation of the document identified by the given id if it exists
Returns the raw repsentation of the document identified by the given id if it exists

Definition Classes
Database
abstract def info: Result[Option[InfoResult]]

Returns the information about this database
Returns the information about this database

Definition Classes
Database
abstract val name: String

The database name
The database name

Definition Classes
Database
abstract def patchDoc[T <: IdRev](id: String, rev: String, patch: JsonPatch)(implicit arg0: Manifest[T]): Result[T]

Patches the document identified by the given identifier in the given revision.
Patches the document identified by the given identifier in the given revision. This will work if the revision is the last one, or if it is not but the automatic conflict manager manages to solve the potential conflicts. The patched revision is returned. If something went wrong, an exception is raised

Definition Classes
Database
abstract def saveDoc[T](doc: T)(implicit arg0: (T) ⇒ IdRev, arg1: Manifest[T]): Result[T]

Creates or updates the given object as a document into this database The given object must have an _id and an optional _rev fields to conform to the couchdb document structure.
Creates or updates the given object as a document into this database The given object must have an _id and an optional _rev fields to conform to the couchdb document structure. The saved revision is returned. If something went wrong, an exception is raised

Definition Classes
Database
abstract def saveDocs[T](docs: List[T], all_or_nothing: Boolean = false)(implicit arg0: (T) ⇒ IdRev): Result[List[DbResult]]

Creates or updates a bunch of documents into the database.
Creates or updates a bunch of documents into the database.

Definition Classes
Database
abstract def saveSecurityDoc(doc: SecurityDoc): Result[Boolean]

Creates or updates the security document.
Creates or updates the security document. Security documents are special documents with no _id nor _rev fields.

Definition Classes
Database
abstract def securityDoc: Result[SecurityDoc]

Returns the security document of this database if any defined
Returns the security document of this database if any defined

Definition Classes
Database
abstract def serializer: JsonSerializer

The serializer used by this database
The serializer used by this database

Definition Classes
Database
abstract def start(replication: Replication): Result[Replication]

Starts a new replication from source to target.
Starts a new replication from source to target. if a replication task already exists for the same source and target, the document is added but the replication is not started again. The result only contains the identifier of the actual replication task, not its state.
abstract def stop(id: String): Result[Boolean]

Stops the replication identified by the given replication document id.
Stops the replication identified by the given replication document id. if the identifier does not describe the document that started the replication, it is deleted from the replicator database, but the replication task is not stopped. It returns true only if the replication was actually stopped, false otherwise.
abstract val strategy: Strategy

The merge strategy
The merge strategy

Definition Classes
Database
abstract def temporaryView(viewDoc: ViewDoc): View[Result]

Returns a temporary view of this database, specified by the ViewDoc.
Returns a temporary view of this database, specified by the ViewDoc.

Definition Classes
Database

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package sohva

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

Abstract Value Members

abstract def attachTo(docId: String, attachment: String, stream: InputStream, contentType: String): Result[Boolean]

abstract def attachTo(docId: String, file: File, contentType: String): Result[Boolean]

abstract def builtInView(view: String): View[Result]

abstract def changes(since: Option[Int] = None, filter: Option[String] = None): ChangeStream

abstract def copy(origin: String, target: String, originRev: Option[String] = None, targetRev: Option[String] = None): Result[Boolean]

abstract def couch: CouchDB[Result]

abstract def create: Result[Boolean]

abstract def createDoc(doc: Any): Result[DbResult]

abstract def createDocs(doc: List[Any]): Result[List[DbResult]]

abstract val credit: Int

abstract def delete: Result[Boolean]

abstract def deleteAttachment(docId: String, attachment: String): Result[Boolean]

abstract def deleteDoc(id: String): Result[Boolean]

abstract def deleteDoc[T](doc: T)(implicit arg0: (T) ⇒ IdRev): Result[Boolean]

abstract def deleteDocs(ids: List[String], all_or_nothing: Boolean = false): Result[List[DbResult]]

abstract def design(designName: String, language: String = "javascript"): Design[Result]

abstract def exists: Result[Boolean]

abstract def getAttachment(docId: String, attachment: String): Result[Option[(String, InputStream)]]

abstract def getDocById[T](id: String, revision: Option[String] = None)(implicit arg0: Manifest[T]): Result[Option[T]]

abstract def getDocRevision(id: String): Result[Option[String]]

abstract def getDocRevisions(ids: List[String]): Result[List[(String, String)]]

abstract def getDocsById[T](ids: List[String])(implicit arg0: Manifest[T]): Result[List[T]]

abstract def getRawDocById(id: String, revision: Option[String] = None): Result[Option[JValue]]

abstract def info: Result[Option[InfoResult]]

abstract val name: String

abstract def patchDoc[T <: IdRev](id: String, rev: String, patch: JsonPatch)(implicit arg0: Manifest[T]): Result[T]

abstract def saveDoc[T](doc: T)(implicit arg0: (T) ⇒ IdRev, arg1: Manifest[T]): Result[T]

abstract def saveDocs[T](docs: List[T], all_or_nothing: Boolean = false)(implicit arg0: (T) ⇒ IdRev): Result[List[DbResult]]

abstract def saveSecurityDoc(doc: SecurityDoc): Result[Boolean]

abstract def securityDoc: Result[SecurityDoc]

abstract def serializer: JsonSerializer

abstract def start(replication: Replication): Result[Replication]

abstract def stop(id: String): Result[Boolean]

abstract val strategy: Strategy

abstract def temporaryView(viewDoc: ViewDoc): View[Result]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Database[Result]

Inherited from AnyRef

Inherited from Any

Ungrouped