Class: CouchObject::View

Class

CouchObject::View

In:

lib/couch_object/view.rb

Parent:

Object

dot/f_3.png

Methods

create delete get_db name new query raw_query

Attributes

db [RW]

Public Class methods

create(db, name, query)

Takes:

db as CouchObject::Database object or a string containing the database uri and database name (localhost:5984/mydb)
name (string). The name of the view
query (JSON string). The JSON document that should be added to the database

Returns: CouchObject::Reponse object instance

Raises:

an exeption if it can‘t figure out the database

Takes:

db as CouchObject::Database object or a string containing the database uri and database name (localhost:5984/mydb)
name (string). The name of the view

Returns: new CouchObject::View instance

Raises:

an exeption if it can‘t figure out the database

Protected Class methods

Public Instance methods

query(params = {})

Returns an array of the rows returned by the view

Takes:

[params] (hash): a hash of URL query arguments supported by couchDB. If omitted it defaults to not use a key and to update the view.
Example:
```
  view.query({:update => false, :key => "bar"}) => Array
```

Returns:

a array of rows from the view

Raises:

CouchObject::Errors::MissingView if the view doesn‘t exist

raw_query(params = {})

Returns the response data from CouchDB for a view query without

Takes:

[params] (hash): a hash of URL query arguments supported by couchDB. If omitted it defaults to not use a key and to update the view.
Example:
```
  view.raw_query({:update => false, :key => "bar"}) => data
```

Returns:

the response data for the view

Raises:

CouchObject::Errors::MissingView if the view doesn‘t exist