apache / nano

Nano is now part of Apache CouchDB. Repo moved to https://GitHub.com/apache/couchdb-nano

Home Page:https://github.com/apache/couchdb-nano

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Documentation needs fixed for passing keys as parameter in db.view

PaulAllan1 opened this issue · comments

Currently the documentation for db.view is as follows:
"db.view(designname, viewname, [params], [callback])

calls a view of the specified design with optional query string additions params. if you're looking to filter the view results by key(s) pass an array of keys, e.g { keys: ['key1', 'key2', 'key_n'] }, as params."

In actual fact what needs to be passed in to filter by keys is more like {keys: [['key1', 'key2', 'key_n']] }. Please update the documentation.

I agree with @PaulAllan1, please update the documentation. I lost much time trying to figure it out.
Regards.

This repository has been merged into apache/couchdb-nano, please continue the discussion here.