[GitHub] [lucene-solr] freedev opened a new pull request #996: SOLR-13863: Added spayload query function to read and sort string pay…

[GitBox <gi...@apache.org>]

freedev opened a new pull request #996: SOLR-13863: Added spayload query function to read and sort string pay…
URL: https://github.com/apache/lucene-solr/pull/996
 
 
   <!--
   Before creating a pull request, please file an issue in the ASF Jira system for Lucene or Solr:
   
   * https://issues.apache.org/jira/projects/LUCENE
   * https://issues.apache.org/jira/projects/SOLR
   
   You will need to create an account in Jira in order to create an issue.
   
   The title of the PR should reference the Jira issue number in the form:
   
   * LUCENE-####: <short description of problem or changes>
   * SOLR-####: <short description of problem or changes>
   
   LUCENE and SOLR must be fully capitalized. A short description helps people scanning pull requests for items they can work on.
   
   Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. -->
   
   
   # Description
   
   I started to use payloads because I had the classical per-store pricing problem.
   But standard payload function handles only numbers and, for example, stores can also be in different countries, would be useful also have the currency and other attributes related to the store.
   
   This pull request add a new function query named spayload that helps to read and sort payload field delimited_payloads_string.
   
   Example document:
   
   ```
     "id":"my sample doc",
     "currencyPayload":[
       "store1|EUR",
       "store2|USD",
       "store3|GBP"
     ]
   ```
   
   
   Querying Solr with
   
   ```
   fl=spayload(currencyPayload,store3)
   ```
   
   would generate a response like the following:
   
   ```
     "response":{
         "docs":[{
             "id":"my sample doc", 
             "spayload(currencyPayload,store3)":"GBP"
         }]
      }
   ```
   
   And executing `spayload(payloadCurrency,store2)` returns `EUR`, and so on.
   
   You can use `spayload` even as sorting function.
   
   ```
   sort=spayload(payloadField,value) asc
   ```
   
   # Solution
   
   I was looking at the original payload function is defined into the ValueSourceParser, this function uses a FloatPayloadValueSource to return the value found.
   
   As said I wrote a new version of payload function that handles strings, I named it spayload, and basically is able to extract the string value from the payload.
   
   Given the former example where I have a multivalue field payloadCurrency
   
   ```
   payloadCurrency: [
   "store1|USD",
   "store2|EUR",
   "store3|GBP"
   ]
   ```
   
   executing spayload(payloadCurrency,store2) returns "EUR", and so on for the remaining key/value in the field.
   
   To implement the spayload function, I've added a new ValueSourceParser instance to the list of defined functions and which returns a StringPayloadValueSource with the value inside (does the same thing of former FloatPayloadValueSource).
   
   # Tests
   
   I've created a sample solr collection where test the custom function
   https://github.com/freedev/solr-payload-string-function-query 
   
   # 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.
   - [ ] I am authorized to contribute this code to the ASF and have removed any code I do not have a license to distribute.
   - [ ] 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)
   - [ ] I have developed this patch against the `master` branch.
   - [ x] I have run `ant precommit` and the appropriate test suite.
   - [ ] I have added tests for my changes.
   - [ ] I have added documentation for the [Ref Guide](https://github.com/apache/lucene-solr/tree/master/solr/solr-ref-guide) (for Solr changes only).
   

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org