You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by "James Howe (JIRA)" <ji...@apache.org> on 2011/05/04 18:06:03 UTC

[jira] [Created] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Documentation of list functions doesn't explain how to use the 0.9 style
------------------------------------------------------------------------

                 Key: COUCHDB-1149
                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
             Project: CouchDB
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 0.9
            Reporter: James Howe
            Priority: Minor


http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

Re: [jira] [Reopened] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by Zachary Zolton <za...@gmail.com>.
If you're interested in documenting the 0.9 list function behavior for
the wiki, you may want to start here:

https://github.com/apache/couchdb/blob/0.9.0/share/www/script/test/list_views.js

On Thu, May 5, 2011 at 6:24 AM, James Howe (JIRA) <ji...@apache.org> wrote:
>
>     [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
>
> James Howe reopened COUCHDB-1149:
> ---------------------------------
>
>
>> Documentation of list functions doesn't explain how to use the 0.9 style
>> ------------------------------------------------------------------------
>>
>>                 Key: COUCHDB-1149
>>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>>             Project: CouchDB
>>          Issue Type: Improvement
>>          Components: Documentation
>>    Affects Versions: 0.9
>>            Reporter: James Howe
>>            Priority: Minor
>>              Labels: list_function
>>
>> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.
>
> --
> This message is automatically generated by JIRA.
> For more information on JIRA, see: http://www.atlassian.com/software/jira
>

[jira] [Resolved] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Robert Newson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Newson resolved COUCHDB-1149.
------------------------------------

    Resolution: Not A Problem

The wiki is editable by all, feel free to correct the page.


> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Sebastian Cohnen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031672#comment-13031672 ] 

Sebastian Cohnen commented on COUCHDB-1149:
-------------------------------------------

@Robert: based upon "Putting them under the "lists" key results in them being invoked as the 0.10 versions." I thought the question was how to use the old API in newer CouchDB versions...

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Robert Newson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031664#comment-13031664 ] 

Robert Newson commented on COUCHDB-1149:
----------------------------------------

It's definitely true that 0.9 style won't work in any version later than 0.9, but I thought the ticket was to document the style for folks still, somehow, stuck on the now obsolete 0.9 release.


> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Reopened] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "James Howe (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

James Howe reopened COUCHDB-1149:
---------------------------------


> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Sebastian Cohnen (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031646#comment-13031646 ] 

Sebastian Cohnen commented on COUCHDB-1149:
-------------------------------------------

I'm not totally sure, but I think the list fun API simply changed and there is no way to have a 0.9-style list function in later versions of CouchDB.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "James Howe (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031701#comment-13031701 ] 

James Howe commented on COUCHDB-1149:
-------------------------------------

Maybe someone could more completely document all the functions available in lists then.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Robert Newson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031715#comment-13031715 ] 

Robert Newson commented on COUCHDB-1149:
----------------------------------------

The one, and only, example of a 0.10 and later list function on the wiki page uses all the functions;

function(head, req) {
  var row;
  start({
    "headers": {
      "Content-Type": "text/html"
     }
  });
  while(row = getRow()) {
    send(row.value);
  }
}


> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "James Howe (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13029289#comment-13029289 ] 

James Howe commented on COUCHDB-1149:
-------------------------------------

I don't know the answer, so I can't.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Resolved] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Robert Newson (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Newson resolved COUCHDB-1149.
------------------------------------

    Resolution: Won't Fix

0.9 is obsolete. If someone wants to document the 0.9 style for posterity, the wiki is open to those that know, or can find, the answer.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "James Howe (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031674#comment-13031674 ] 

James Howe commented on COUCHDB-1149:
-------------------------------------

The question was asked under the misapprehension that the 0.9 API was still available.

The reason I wanted to use them is that it appeared the old version allows row-by-row streaming to the client, avoiding a large performance penalty of having to buffer all the results before sending.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (COUCHDB-1149) Documentation of list functions doesn't explain how to use the 0.9 style

Posted by "Robert Newson (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/COUCHDB-1149?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13031675#comment-13031675 ] 

Robert Newson commented on COUCHDB-1149:
----------------------------------------

I believe all versions of lists functions are streamable. You get the next row with getRow() and send a part of the response with send(), there's no need to buffer all the results.

> Documentation of list functions doesn't explain how to use the 0.9 style
> ------------------------------------------------------------------------
>
>                 Key: COUCHDB-1149
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-1149
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 0.9
>            Reporter: James Howe
>            Priority: Minor
>              Labels: list_function
>
> http://wiki.apache.org/couchdb/Formatting_with_Show_and_List#Listing_Views_with_CouchDB_0.9 describes a style of list functions, but not where they should go in a design document. Putting them under the "lists" key results in them being invoked as the 0.10 versions.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira