You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by GitBox <gi...@apache.org> on 2022/05/04 20:11:41 UTC
[GitHub] [solr] atarora opened a new pull request, #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
atarora opened a new pull request, #835:
URL: https://github.com/apache/solr/pull/835
https://issues.apache.org/jira/browse/SOLR-16179
# Description
terms.fl can be specified in the query multiple times, which is not clear from the documentation.
# Solution
Added the respective documentation with examples in JSON and XML
# Tests
Reviewed the created doc with asciidoctor and verified the changes.
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [x] I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [x] I have developed this patch against the `main` branch.
- [x] I have run `./gradlew check`.
- [ ] I have added tests for my changes.
- [x ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] atarora commented on pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
atarora commented on PR #835:
URL: https://github.com/apache/solr/pull/835#issuecomment-1119448938
> The rest of the Terms page ONLY has xml... And since the xml output and the json output are really jsut the same, I don't think having both formats helps the readability. I _could_ see a case for just using JSON everywhere????
I removed the JSON, but the reason I added them both as I picked the example template from terms.ttf which has examples for both XML and JSON.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh merged pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
epugh merged PR #835:
URL: https://github.com/apache/solr/pull/835
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] risdenk commented on a diff in pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
risdenk commented on code in PR #835:
URL: https://github.com/apache/solr/pull/835#discussion_r865313326
##########
solr/solr-ref-guide/modules/query-guide/pages/terms-component.adoc:
##########
@@ -68,8 +68,57 @@ s|Required |Default: none
+
Specifies the field from which to retrieve terms.
This parameter is required if `terms=true`.
+This parameter can be specified multiple times to retrieve terms for different fields.
+
Example: `terms.fl=title`
++
+Example: `terms.fl=title&terms=true&terms.fl=name&terms.list=cable,sony`
++
+XML:
++
+[source,xml]
+----
+<response>
+ <lst name="responseHeader">
+ <bool name="zkConnected">true</bool>
+ <int name="status">0</int>
+ <int name="QTime">4</int>
+ </lst>
+ <lst name="terms">
+ <lst name="name">
+ <int name="cable">8661</int>
+ <int name="sony">21</int>
Review Comment:
these 2 lines should be indented?
##########
solr/solr-ref-guide/modules/query-guide/pages/terms-component.adoc:
##########
@@ -68,8 +68,57 @@ s|Required |Default: none
+
Specifies the field from which to retrieve terms.
This parameter is required if `terms=true`.
+This parameter can be specified multiple times to retrieve terms for different fields.
+
Example: `terms.fl=title`
++
+Example: `terms.fl=title&terms=true&terms.fl=name&terms.list=cable,sony`
++
+XML:
++
+[source,xml]
+----
+<response>
+ <lst name="responseHeader">
+ <bool name="zkConnected">true</bool>
+ <int name="status">0</int>
+ <int name="QTime">4</int>
+ </lst>
+ <lst name="terms">
+ <lst name="name">
+ <int name="cable">8661</int>
+ <int name="sony">21</int>
+ </lst>
+ <lst name="title">
+ <int name="cable">11387</int>
+ <int name="sony">3921</int>
+ </lst>
+ </lst>
+</response>
+----
++
+JSON:
++
+[source,json]
+----
+{
+ "responseHeader": {
+ "zkConnected": true,
+ "status": 0,
+ "QTime": 5
+ },
+ "terms": {
+ "name": {
+ "cable": 8661,
+ "sony": 21
Review Comment:
these 2 lines should be indented?
##########
solr/solr-ref-guide/modules/query-guide/pages/terms-component.adoc:
##########
@@ -68,8 +68,57 @@ s|Required |Default: none
+
Specifies the field from which to retrieve terms.
This parameter is required if `terms=true`.
+This parameter can be specified multiple times to retrieve terms for different fields.
+
Example: `terms.fl=title`
++
+Example: `terms.fl=title&terms=true&terms.fl=name&terms.list=cable,sony`
++
+XML:
++
+[source,xml]
+----
+<response>
+ <lst name="responseHeader">
+ <bool name="zkConnected">true</bool>
+ <int name="status">0</int>
+ <int name="QTime">4</int>
+ </lst>
+ <lst name="terms">
+ <lst name="name">
+ <int name="cable">8661</int>
+ <int name="sony">21</int>
+ </lst>
+ <lst name="title">
+ <int name="cable">11387</int>
+ <int name="sony">3921</int>
+ </lst>
+ </lst>
+</response>
+----
++
+JSON:
++
+[source,json]
+----
+{
+ "responseHeader": {
+ "zkConnected": true,
+ "status": 0,
+ "QTime": 5
+ },
+ "terms": {
+ "name": {
+ "cable": 8661,
+ "sony": 21
+ },
+ "title": {
+ "cable": 11387,
+ "sony": 3921
Review Comment:
these 2 lines should be indented?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on a diff in pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
epugh commented on code in PR #835:
URL: https://github.com/apache/solr/pull/835#discussion_r865443684
##########
solr/solr-ref-guide/modules/query-guide/pages/terms-component.adoc:
##########
@@ -68,8 +68,57 @@ s|Required |Default: none
+
Specifies the field from which to retrieve terms.
This parameter is required if `terms=true`.
+This parameter can be specified multiple times to retrieve terms for different fields.
Review Comment:
Oddly enough, it can NOT be.. "Error from server at null: undefined field: \"title,name\"" It would make MORE sense to me if that was the way it was defined.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] risdenk commented on a diff in pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
risdenk commented on code in PR #835:
URL: https://github.com/apache/solr/pull/835#discussion_r865312340
##########
solr/solr-ref-guide/modules/query-guide/pages/terms-component.adoc:
##########
@@ -68,8 +68,57 @@ s|Required |Default: none
+
Specifies the field from which to retrieve terms.
This parameter is required if `terms=true`.
+This parameter can be specified multiple times to retrieve terms for different fields.
Review Comment:
Can it also be comma separated? ie: `terms.fl=title,name`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] epugh commented on pull request #835: SOLR-16179 : Updated the documentation as reported in the ticket , along with the examples
Posted by GitBox <gi...@apache.org>.
epugh commented on PR #835:
URL: https://github.com/apache/solr/pull/835#issuecomment-1118004145
The rest of the Terms page ONLY has xml... And since the xml output and the json output are really jsut the same, I don't think having both formats helps the readability. I *could* see a case for just using JSON everywhere????
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org