couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "HTTP_view_API" by SebastianCohnen
Date Wed, 03 Mar 2010 17:03:23 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "HTTP_view_API" page has been changed by SebastianCohnen.
The comment on this change is: added information on design documents and the meaning of the
result hash (not yet finished).
http://wiki.apache.org/couchdb/HTTP_view_API?action=diff&rev1=29&rev2=30

--------------------------------------------------

  
  The ''inclusive_end'' option controls whether the ''endkey'' is included in the result.
It defaults to true.
  
+ == Getting Information about Design Documents (and their Views) ==
+ You can query the design document (''_design/test'' in this case) by GET for some information
on the view:
+ {{{
+ curl -X GET http://localhost:5984/databasename/_design/test/_info
+ }}}
+ will produce something like this:
+ {{{
+ {"name":"test", "view_index":{"signature":"07ca32cf9b0de9c915c5d9ce653cdca3", "language":"javascript",
"disk_size":4188, "updater_running":false, "compact_running":false, "waiting_commit":false,
"waiting_clients":0, "update_seq":4, "purge_seq":0}}
+ }}}
+ 
+ === Meaning of the status hash ===
+ ||'''Key'''||<-2>'''Description'''||
+ ||''name''||<-2>Name of the design document without the ''_design'' prefix (string)||
+ ||''view_index''||<-2>Contains information on the view (JSON object)||
+ || ||'''Key'''||'''Description'''||
+ || ||''signature''||The MD5 representation of the views of a design document (string)||
+ || ||''language''||Language of the view used (string, default: "javascript")||
+ || ||''disk_size''||Size in Bytes of the view on disk (int)||
+ || ||''updater_running''||Indicates if an update process is running (boolean)||
+ || ||''compact_running''||Indicates if view compaction is running (boolean)||
+ || ||''waiting_commit''||? (int)||
+ || ||''waiting_clients''||? (int)||
+ || ||''update_seq''||Sequence number of updates to this view (int)||
+ || ||''purge_seq''||? (int)||
+ 
  
  == Debugging Views ==
  

Mime
View raw message