Skip to content
This repository

A Simple CouchDb Console, for doing simple things that are generally hard with plain http interface, and some shortcuts

branch: master
Readme.markdown

Couchup

This is a command line interface to CouchDb.

Installation

gem install couchup

Tested on Ruby 1.9, 1.8.7, REE and Rubunius. (Does not work on jruby for reasons i have not debugged)

Usage

Couchup is a command line utility piggybacking on the irb. So you can do all the ruby stuff in it.

Type help on command line to list the stuff you can do with couchup.

$ couchup

help

You see a bunch of commands that you can use.

Remember this is just an IRB, so the command syntax is a little verbose.

create :database, :riders (Note the commas and symbols)

Also symbols and strings can be used interchangeably, So the above is the same as

create "database", "riders"

Some Common Things to do with couchup

Command line Params

couchup --help will print the help

use -h (or--host) to set the host machine to connect to

use -p (or --port) to set the port of the host couchdb

use -d (or --database) to set the database to use by default

use -u (or --username) to use a specific user login (when in admin mode)

use -a (or --password) to specify the password (when in admin mode)

Basics

Connects to the couch server at foo.bar.com on the default port of 5984

connect "foo.bar.com"

Connects to local couch on localhost at 5984

connect

To use a specific database switch with.

use :riders

Most Couchup commands need you to be on a specific database.

Shortcuts

last_result or __ are short hands for the last result returned by couch operations( Note this is not the same as _ that is available in irb).

These are typically json documents( or array of documents)

Most commands that are in the form of <:view|| :database || :doc> have short hands like _ or _database

eg. create_database :foo is same as create :database, :foo

or create_view 'Rider/test' is the same as create :view, 'Rider/test'

Getting documents


Get all documents from the current database.

get

gets docucment by the given ID.

get "id"

Running views


There are 2 different commands.

map Will just run the map function

view : will run both the map and reduce.

They have very similar semantics, except for where noted.

map "Rider/all"

Found 1 item(s)

{"id"=>"78ea2a07be87b6fa0e4afed5d81f3729", "key"=>"78ea2a07be87b6fa0e4afed5d81f3729", "value"=>1, "doc"=>{"_id"=>"78ea2a07be87b6fa0e4afed5d81f3729", "_rev"=>"2-fb5e1207a12f996e287fa23986ac7077", "number"=>"101", "start_time"=>"2011-02-17T18:18:58+05:30", "end_time"=>"2011-02-17T18:20:24+05:30", "type"=>"rider", "couchrest-type"=>"Rider"}}

map "Rider/all", "78ea2a07be87b6fa0e4afed5d81f3729"

will return only only the document matching the above key.

The following will query the view with a post to get all the matching keys.

map "Rider/all", ["78ea2a07be87b6fa0e4afed5d81f3729", "ee23399aad3f8685e64f455504000d49"]

The following will query the view with a startkey and endkey semantics.

map "Rider/all", :startkey=> "78ea2a07be87b6fa0e4afed5d81f3729", :endkey=> "ee23399aad3f8685e64f455504000d49"

The same rules apply for view command as well, and additionally it takes the group_level parameter as well.

view "Rider/all", :startkey=> "78ea2a07be87b6fa0e4afed5d81f3729", :endkey=> "ee23399aad3f8685e64f455504000d49"

Creating and modifying views.


It is important to set the EDITOR variable before running couchup, because we use the EDITOR to pop up an edit window

create :view, "Rider/test"

Will pop a textmate/emacs/vi window with some templates. If the view exists it will show the existing code. So you can modify it.

To cancel creation of the view, just empty the contents of the file and save.

If you want to specify the map and view function on couchup

create :view, 'Rider/test', "function(doc) { if( doc.name) emit(doc.name, 1);}"

Modifying Documents


We use the last_result that is described in the Basics section, and leverage ruby to change documents in couchdb

get("") last_result[:number] = 100 last_result.save

You could do this with the view results as well.

Non Interactive Mode


You can just run a few commands on couch by using the -c (--command) option for couchup

e.g :

couchup -d riders -c map Riders/by_arrival_time

Will run the Riders/by_arrival_time map function on riders database.

Note the absence of symbols and strings in such a mode

Multi line commands are supported by use of ';'

e.g:

couchup -c create database new_riders; use riders; replicate_to new_riders

Something went wrong with that request. Please try again.