[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[
https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13835098#comment-13835098
]
ASF subversion and git services commented on COUCHDB-1923:
--
Commit ca41964b70b96b5fa76504e4001523ed29c718b5 in branch refs/heads/master
from [~klaus_trainer]
[ https://git-wip-us.apache.org/repos/asf?p=couchdb.git;h=ca41964 ]
Extend support for attachment-related query params
Until now, the boolean query parameters `attachments` and
`att_encoding_info` have only been supported for the document API
endpoint (`/{db}/{docid}`).
This extends support for queries to the changes (`/{db}/_changes`) and
view (`/{db}/_design/{ddoc}/_view/{view}`) API endpoints:
* If `include_docs` and `attachments` equal `true`, the Base64-encoded
contents of attachments are included with the documents in changes or
view query results, respectively.
* If `include_docs` and `att_encoding_info` equal `true`, encoding
information is included in attachment stubs if the particular
attachment is compressed.
Closes COUCHDB-1923.
> Allow ?attachments=true alongside ?include_docs=true on view
>
>
> Key: COUCHDB-1923
> URL: https://issues.apache.org/jira/browse/COUCHDB-1923
> Project: CouchDB
> Issue Type: Improvement
>Reporter: Nathan Vander Wilt
>
> I have a situation where it'd be handy to get inline [base64] attachments for
> the documents from a view response (already using include_docs=true).
> I wonder if this is as easy a fix as COUCHDB-549 was?
--
This message was sent by Atlassian JIRA
(v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13834758#comment-13834758 ] Klaus Trainer commented on COUCHDB-1923: I've closed my previous pull request (again, sorry) and created a new one that also accommodates `att_encoding_info`: https://github.com/apache/couchdb/pull/111 > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13831362#comment-13831362 ] Klaus Trainer commented on COUCHDB-1923: I just noticed that my previous pull request's branch name and commit message were both out of date. I therefore closed it and opened a new pull request: https://github.com/apache/couchdb/pull/109 > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13831342#comment-13831342 ] Klaus Trainer commented on COUCHDB-1923: Great. After rethinking and sleeping over it, I'm now quite confident that we should name it `attachments`. I've updated my feature branch accordingly and pushed it to github again (https://github.com/apache/couchdb/pull/106). Thanks [~natevw], [~rnewson], and [~jjs] for your ideas, feedback, and suggestions! > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13829778#comment-13829778 ] Johannes J. Schmidt commented on COUCHDB-1923: -- `attachments=true` is fine. I think its way better to explain "Use attachments=true to include attachments. On a view, you must also set include_docs=true to ask for the docs with the attachments." rather than "On a view you set include_attachments=true along with include_docs=true to get the attachments in one go whereas on a single document fetch you say attachments=true". I prefer less query parameter names with slightly different behaviour which explain themselves logically. Various names all have to be remembered. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13829563#comment-13829563 ] Klaus Trainer commented on COUCHDB-1923: Thinking about that, I just found a strong argument in favour of [~natevw]'s original proposal to use the same query parameter name like in the document API. I'm wondering why we shouldn't have the functionality that is provided by other query parameters from the document API in the view and changes APIs as well. In fact, I see no reason why we couldn't (and shouldn't) make the following query parameters available to be used in combination with `include_docs`: * attachments * att_encoding_info * conflicts * deleted_conflicts * local_seq * meta * revs * revs_info Now, thinking of that, the most sensible thing would probably be to just stick with the names from the document API. What do others think about that? > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13829539#comment-13829539 ] Klaus Trainer commented on COUCHDB-1923: > Would it make sense to share a pattern from the stale/feed parameters > and turn include_docs into a ternary? E.g. `include_docs=true`, > `include_docs=attachments`? Yeah, we would avoid introducing another query parameter by doing so. However, allowing the values `true` and `false` suggests a boolean type. In fact, it is currently documented as boolean. Of course, we can change the type to string, but then having a string type with values `true`, `false`, and `attachments` is unintuitive and ugly. Instead, we could introduce two new query parameter values (e.g. `yes` and `with_attachments`) that don't suggest that it's a boolean, while deprecating the values `true` and `false`. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13829218#comment-13829218 ] Nathan Vander Wilt commented on COUCHDB-1923: - > However, the `attachments` query parameter is > currently used for only one API endpoint: `/:db/:docid`. Fair point. While I don't see the encoding/multipart issues as a particularly strong argument (that's negotiated via Accept rather than params) the "no attachment contents will be sent unless the `include_docs` query parameter value is also `true`" is interesting. Would it make sense to share a pattern from the stale/feed parameters and turn include_docs into a ternary? E.g. `include_docs=true`, `include_docs=attachments`? > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13829191#comment-13829191 ] Klaus Trainer commented on COUCHDB-1923: > The "include_attachments" suggestion was only consistent in this one > context, AFAICT all other uses of the same are simply "attachments" > and I'd personally prefer the latter. Using plural suggests that there are multiple instances of `attachments` query parameter usage. However, the `attachments` query parameter is currently used for only one API endpoint: `/:db/:docid`. [~natevw]: While first thinking that we can just reuse the `attachments` query parameter for other API endpoints as well, I came to the conclusion that it is better to introduce a new `include_attachments` query parameter for the following reasons. In the document API, attachments are sent with *one* particular requested document iff the query parameter value is `true`. Depending on whether a client requests the content type "application/json" (by setting the "Content-Type" header accordingly) or not, attachments are either included Base64-encoded in the document, or sent along as separate parts of the multipart response in their binary representation. In the view and changes API we got *a collection* of documents. Even if the `attachments` (whatsoever) query parameter value is `true`, no attachment contents will be sent unless the `include_docs` query parameter value is also `true`. That is, the effectiveness of the `attachments` query parameter depends on the presence and value of another query parameter here. Moreover, in contrast to the document API, attachments are always included Base64-encoded in the documents, and there are no multipart responses. Although there would be similar meaning, I don't think it would be a good idea to use the same query parameter name. Following the differences in semantics, it is consequential to use a different query parameter name. This makes the differences more explicit and therefore can help preventing users from having bad surprises. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13828503#comment-13828503 ] Nathan Vander Wilt commented on COUCHDB-1923: - So is this being implemented with plain old ?attachments to match the docs query param? The "include_attachments" suggestion was only consistent in this one context, AFAICT all other uses of the same are simply "attachments" and I'd personally prefer the latter. (Sounds like that's what is used internally too?) > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827762#comment-13827762 ] Klaus Trainer commented on COUCHDB-1923: Thanks for your review and good suggestions, [~rnewson]. I've updated the feature branch and think that I've addressed your points. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827623#comment-13827623 ] Robert Newson commented on COUCHDB-1923: Jan, Klaus already touched the code next to it when he added [include_attachments] as a duplicate of [attachments] rather than transform at the http level. :) > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827614#comment-13827614 ] Jan Lehnardt commented on COUCHDB-1923: --- [~klaus_trainer] ah thanks, overlooked that. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827612#comment-13827612 ] Klaus Trainer commented on COUCHDB-1923: [~janl] Just passing `attachments` instead of `include_attachments` to `couch_doc:to_json_obj/2` should be fine. I'll address [~rnewson]'s points and push an update soon. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827610#comment-13827610 ] Jan Lehnardt commented on COUCHDB-1923: --- [~rnewson] Do you have a pointer to said mechanism? > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13827609#comment-13827609 ] Robert Newson commented on COUCHDB-1923: Needs work (specifically, all the modifications to couch_doc should come out, there's already a mechanism to fetch documents with base64 encoded attachments) and a warning in the docs about doing this for large attachments. > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13823893#comment-13823893 ] Klaus Trainer commented on COUCHDB-1923: I've implemented support for a `include_attachments` query parameter for the view API, and while at it, for the changes API as well. https://github.com/apache/couchdb/pull/106 > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
[jira] [Commented] (COUCHDB-1923) Allow ?attachments=true alongside ?include_docs=true on view
[ https://issues.apache.org/jira/browse/COUCHDB-1923?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13818198#comment-13818198 ] Klaus Trainer commented on COUCHDB-1923: Although longer, `include_attachments` would be self-explanatory and consistent with `include_docs` > Allow ?attachments=true alongside ?include_docs=true on view > > > Key: COUCHDB-1923 > URL: https://issues.apache.org/jira/browse/COUCHDB-1923 > Project: CouchDB > Issue Type: Improvement >Reporter: Nathan Vander Wilt > > I have a situation where it'd be handy to get inline [base64] attachments for > the documents from a view response (already using include_docs=true). > I wonder if this is as easy a fix as COUCHDB-549 was? -- This message was sent by Atlassian JIRA (v6.1#6144)
