CouchDB Query View with Multiple Keys Formatting

Question

I'm having a problem getting a couchdb view to return the proper documents when using multiple keys.

This works fine, returning the documents that match:

GET http://example.com:5984/myDb/_design/myFilters/_view/getItemByForeignKeyId?key=abc123

This returns returns all documents in the view, matching or not:

GET http://example.com:5984/myDb/_design/myFilters/_view/getItemByForeignKeyId?keys=%5B%22abc123%22%5D

I'm usually very good at hunting down my answers. But, CouchDB documentation is very clear on the format for using multiple keys. I've seen some use the ?keys=[123,123] and i've also seen ?keys="abc","abc".

If anyone can offer any clarification on the 'proper' format and encoding of multiple key queries for CouchDB using a GET method, I would be extremely appreciative.

Kim Stebel · Accepted Answer · 2013-05-26 20:47:24Z

22

To get multiple keys from a view, you need to do a post request and submit the keys in the request body. Your HTTP request will look like this:

POST /myDb/_design/myFilters/_view/getItemByForeignKeyId
Content-Type: application/json

{
   "keys" : [
      "abc",
      "123"
   ]
}

answered May 26, 2013 at 20:47

Kim Stebel

42.1k12 gold badges130 silver badges142 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

J. Lincoln Over a year ago

Thanks you so much. That worked. The wording of the CouchDB documentation can be ambiguous at times.

Jens · Accepted Answer · 2019-03-04 07:01:37Z

9

function(doc){
    {
        if([doc.key1, doc.key2])
            emit([doc.key1, doc.thingYouWantToKnow]);
    }
}

and in the query string, at the end

?key=["key1Value", "key2Value"]

Notice that it is key=[], not keys=[] !!!!!!!!!

edited Mar 4, 2019 at 7:01

Jens

69.6k15 gold badges107 silver badges133 bronze badges

answered Sep 26, 2014 at 23:29

user2006050

1512 silver badges4 bronze badges

Comments

Daniel · Accepted Answer · 2013-05-29 21:23:41Z

6

Not saying it's correct, but you can actually do it via query string as well. The array enclosing brackets should not be encoded. E.g. this works for me:

http://localhost:5984/test/_design/artists_albums/_view/albums_by_artist?keys=[%22Super%20bad%20artist%22,%20%22Fake%20artist%201%22]

answered May 29, 2013 at 21:23

Daniel

8,3986 gold badges39 silver badges51 bronze badges

1 Comment

albertjan Over a year ago

It's not documented. Is it ok to use it or should I opt for the POST request.

Collectives™ on Stack Overflow

CouchDB Query View with Multiple Keys Formatting

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related