net.liftweb.couchdb.Database

Ordering

Alphabetic
By inheritance

Inherited

Hide All
Show all

Database
Request
Handlers
AnyRef
Any

Visibility

Public
All

Impl.

Concrete
Abstract

Instance constructors

new Database (database: String)

Construct a Database request to a default installation of CouchDB on localhost (port 5984)

Construct a Database request to a default installation of CouchDB on localhost (port 5984)
new Database (hostname: String, port: Int, database: String)

Construct a Database request using host and port

Construct a Database request using host and port
new Database (couch: Request, database: String)

Value Members

def != (arg0: AnyRef) : Boolean

attributes: final
definition classes: AnyRef
def != (arg0: Any) : Boolean

o != arg0 is the same as !(o == (arg0)).

o != arg0 is the same as !(o == (arg0)).
arg0
the object to compare against this object for dis-equality.
returns
false if the receiver object is equivalent to the argument; true otherwise.
attributes: final
definition classes: Any
def ## () : Int

attributes: final
definition classes: AnyRef → Any
def $asInstanceOf [T0] () : T0

attributes: final
definition classes: AnyRef
def $isInstanceOf [T0] () : Boolean

attributes: final
definition classes: AnyRef
def / (path: String) : Request

definition classes: Request
def <& (req: Request) : Request

definition classes: Request
def <:< (values: Map[String, String]) : Request

definition classes: Request
def << (string_body: String) : Request

definition classes: Request
def << (values: Map[String, Any]) : Request

definition classes: Request
def <<# (doc: JObject) : Handler[Box[JObject]]

Alias for post

Alias for post
def <<< (file: File, content_type: String) : Request

definition classes: Request
def <<< (body: String) : Request

definition classes: Request
def <<? (values: Map[String, Any]) : Request

definition classes: Request
def <> [T] (block: (Elem) ⇒ T) : Handler[T]

definition classes: Handlers
def == (arg0: AnyRef) : Boolean

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: AnyRef
def == (arg0: Any) : Boolean

o == arg0 is the same as o.equals(arg0).

o == arg0 is the same as o.equals(arg0).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
attributes: final
definition classes: Any
def >& [T] (other: Handler[T]) : Handler[T]

definition classes: Request
def >+ [A, B] (block: (Handlers) ⇒ (Handler[A], Handler[B])) : Handler[(A, B)]

definition classes: Handlers
def >+> [T] (block: (Handlers) ⇒ Handler[Handler[T]]) : Handler[T]

definition classes: Handlers
def >- [T] (block: (String) ⇒ T) : Handler[T]

definition classes: Handlers
def >:> [T] (block: (Map[String, Set[String]]) ⇒ T) : Handler[T]

definition classes: Handlers
def >> [T] (block: (InputStream) ⇒ T) : Handler[T]

definition classes: Handlers
def >> [T] (block: (InputStream, String) ⇒ T) : Handler[T]

definition classes: Handlers
def >>> [OS <: OutputStream] (out: OS) : Handler[OS]

definition classes: Handlers
def >\ (charset: String) : Request

definition classes: Request
def >| : Handler[Unit]

definition classes: Handlers
def >~ [T] (block: (Source) ⇒ T) : Handler[T]

definition classes: Handlers
def DELETE : Request

definition classes: Request
def HEAD : Request

definition classes: Request
def POST : Request

definition classes: Request
def all : AllDocs

Access all documents in the database with a queryable interface

Access all documents in the database with a queryable interface
def apply (ids: Seq[String]) : AllDocs

Access a series of documents by ID.

Access a series of documents by ID.
def apply (doc: JObject) : Document

Access a particular document in the database with _id from a given JObject

Access a particular document in the database with _id from a given JObject
def apply (id: String) : Document

Access a particular document in the database by ID.

Access a particular document in the database by ID.
def as (name: String, pass: String) : Request

definition classes: Request
def asInstanceOf [T0] : T0

This method is used to cast the receiver object to be of type T0.

This method is used to cast the receiver object to be of type T0.
Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expressionList(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
the receiver object.
attributes: final
definition classes: Any
def as_! (name: String, pass: String) : Request

definition classes: Request
def as_source : Handler[Source]

definition classes: Handlers
def as_str : Handler[String]

definition classes: Handlers
def clone () : AnyRef

This method creates and returns a copy of the receiver object.

This method creates and returns a copy of the receiver object.
The default implementation of the clone method is platform dependent.
returns
a copy of the receiver object.
attributes: protected
definition classes: AnyRef
def create : Handler[Unit]

Attempt to create the database (PUT)

Attempt to create the database (PUT)
def createIfNotCreated (http: Http) : Unit

Create the database iff it doesn't already exist

Create the database iff it doesn't already exist
val creds : Option[Credentials]

definition classes: Request
val defaultCharset : String

definition classes: Request
def delete : Handler[Unit]

Destroy the database (DELETE)

Destroy the database (DELETE)
def design (name: String) : Design

Access a particular design document in the database by name

Access a particular design document in the database by name
def eq (arg0: AnyRef) : Boolean

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

This method is used to test whether the argument (arg0) is a reference to the receiver object (this).
The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.
Additionally, the eq method has three other properties. * It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false. * For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false. * null.eq(null) returns true.
When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).
arg0
the object to compare against this object for reference equality.
returns
true if the argument is a reference to the receiver object; false otherwise.
attributes: final
definition classes: AnyRef
def equals (arg0: Any) : Boolean

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.
The default implementations of this method is an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation]: * It is reflexive: for any instance x of type Any, x.equals(x) should return true. * It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. * It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same scala.Int (o1.hashCode.equals(o2.hashCode)).
arg0
the object to compare against this object for equality.
returns
true if the receiver object is equivalent to the argument; false otherwise.
definition classes: AnyRef → Any
def finalize () : Unit

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.
The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.
attributes: protected
definition classes: AnyRef
def getClass () : java.lang.Class[_]

Returns a representation that corresponds to the dynamic class of the receiver object.

Returns a representation that corresponds to the dynamic class of the receiver object.
The nature of the representation is platform dependent.
returns
a representation that corresponds to the dynamic class of the receiver object.
attributes: final
definition classes: AnyRef
def gzip : Request

definition classes: Request
def hashCode () : Int

Returns a hash code value for the object.

Returns a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
returns
the hash code value for the object.
definition classes: AnyRef → Any
val host : Option[HttpHost]

definition classes: Request
def info : Handler[DatabaseInfo]

Retrieve information about the database (GET)

Retrieve information about the database (GET)
def isInstanceOf [T0] : Boolean

This method is used to test whether the dynamic type of the receiver object is T0.

This method is used to test whether the dynamic type of the receiver object is T0.
Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested typed.
returns
true if the receiver object is an instance of erasure of type T0; false otherwise.
attributes: final
definition classes: Any
def ne (arg0: AnyRef) : Boolean

o.ne(arg0) is the same as !(o.eq(arg0)).

o.ne(arg0) is the same as !(o.eq(arg0)).
arg0
the object to compare against this object for reference dis-equality.
returns
false if the argument is not a reference to the receiver object; true otherwise.
attributes: final
definition classes: AnyRef
def next (xf: Xf) : Request

definition classes: Request
def next_uri (sxf: (String) ⇒ String) : Request

definition classes: Request
def notify () : Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def notifyAll () : Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.
attributes: final
definition classes: AnyRef
def post (doc: JObject) : Handler[Box[JObject]]

Store a document in the database, generating a new unique ID for it and returning the document with _id and _rev updated

Store a document in the database, generating a new unique ID for it and returning the document with _id and _rev updated
def req : HttpRequestBase

definition classes: Request
val request : Request

definition classes: Request → Handlers
def secure : Request

definition classes: Request
def store (doc: JObject) : Handler[Box[JObject]]

Inserts or updates a document in the database, using the standard _id field to do so.

Inserts or updates a document in the database, using the standard _id field to do so. Returns the updated document.
def synchronized [T0] (arg0: T0) : T0

attributes: final
definition classes: AnyRef
def toString () : String

Returns a string representation of the object.

Returns a string representation of the object.
The default representation is platform dependent.
returns
a string representation of the object.
definition classes: AnyRef → Any
def to_uri : URI

definition classes: Request
def wait () : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long, arg1: Int) : Unit

attributes: final
definition classes: AnyRef
def wait (arg0: Long) : Unit

attributes: final
definition classes: AnyRef
val xfs : List[Xf]

definition classes: Request

Database

class Database extends Request

Instance constructors

new Database (database: String)

new Database (hostname: String, port: Int, database: String)

new Database (couch: Request, database: String)

Value Members

def != (arg0: AnyRef) : Boolean

def != (arg0: Any) : Boolean

def ## () : Int

def $asInstanceOf [T0] () : T0

def $isInstanceOf [T0] () : Boolean

def / (path: String) : Request

def <& (req: Request) : Request

def <:< (values: Map[String, String]) : Request

def << (string_body: String) : Request

def << (values: Map[String, Any]) : Request

def <<# (doc: JObject) : Handler[Box[JObject]]

def <<< (file: File, content_type: String) : Request

def <<< (body: String) : Request

def <<? (values: Map[String, Any]) : Request

def <> [T] (block: (Elem) ⇒ T) : Handler[T]

def == (arg0: AnyRef) : Boolean

def == (arg0: Any) : Boolean

def >& [T] (other: Handler[T]) : Handler[T]

def >+ [A, B] (block: (Handlers) ⇒ (Handler[A], Handler[B])) : Handler[(A, B)]

def >+> [T] (block: (Handlers) ⇒ Handler[Handler[T]]) : Handler[T]

def >- [T] (block: (String) ⇒ T) : Handler[T]

def >:> [T] (block: (Map[String, Set[String]]) ⇒ T) : Handler[T]

def >> [T] (block: (InputStream) ⇒ T) : Handler[T]

def >> [T] (block: (InputStream, String) ⇒ T) : Handler[T]

def >>> [OS <: OutputStream] (out: OS) : Handler[OS]

def >\ (charset: String) : Request

def >| : Handler[Unit]

def >~ [T] (block: (Source) ⇒ T) : Handler[T]

def DELETE : Request

def HEAD : Request

def POST : Request

def all : AllDocs

def apply (ids: Seq[String]) : AllDocs

def apply (doc: JObject) : Document

def apply (id: String) : Document

def as (name: String, pass: String) : Request

def asInstanceOf [T0] : T0

def as_! (name: String, pass: String) : Request

def as_source : Handler[Source]

def as_str : Handler[String]

def clone () : AnyRef

def create : Handler[Unit]

def createIfNotCreated (http: Http) : Unit

val creds : Option[Credentials]

val defaultCharset : String

def delete : Handler[Unit]

def design (name: String) : Design

def eq (arg0: AnyRef) : Boolean

def equals (arg0: Any) : Boolean

def finalize () : Unit

def getClass () : java.lang.Class[_]

def gzip : Request

def hashCode () : Int

val host : Option[HttpHost]

def info : Handler[DatabaseInfo]

def isInstanceOf [T0] : Boolean

def ne (arg0: AnyRef) : Boolean

def next (xf: Xf) : Request

def next_uri (sxf: (String) ⇒ String) : Request

def notify () : Unit

def notifyAll () : Unit

def post (doc: JObject) : Handler[Box[JObject]]

def req : HttpRequestBase

val request : Request

def secure : Request

def store (doc: JObject) : Handler[Box[JObject]]

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

def toString () : String

def to_uri : URI

def wait () : Unit

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

def wait (arg0: Long) : Unit

val xfs : List[Xf]