[jira] [Commented] (GEODE-2944) lucene queries on String values (vs. objects) requires obscure/undocumented defaultField (__REGION_VALUE_FIELD)

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/GEODE-2944?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16023924#comment-16023924 ] 

ASF GitHub Bot commented on GEODE-2944:
---------------------------------------

GitHub user DivineEnder opened a pull request:

    https://github.com/apache/geode/pull/533

    GEODE-2944: Added __REGION_VALUE_FIELD explanation to Lucene create i…

    …ndex help
    
    Thank you for submitting a contribution to Apache Geode.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [ ] Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?
    
    - [ ] Has your PR been rebased against the latest commit within the target branch (typically `develop`)?
    
    - [ ] Is your initial contribution a single, squashed commit?
    
    - [ ] Does `gradlew build` run cleanly?
    
    - [ ] Have you written or updated unit tests to verify your changes?
    
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and
    submit an update to your PR as soon as possible. If you need help, please send an
    email to dev@geode.apache.org.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/DivineEnder/geode feature/GEODE-2944

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/geode/pull/533.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #533
    
----
commit 1f944192b8657da5e7f07f4af1d03a5539ee3025
Author: David Anuta <da...@gmail.com>
Date:   2017-05-25T00:05:33Z

    GEODE-2944: Added __REGION_VALUE_FIELD explanation to lucene create index help

----


> lucene queries on String values (vs. objects) requires obscure/undocumented defaultField (__REGION_VALUE_FIELD)
> ---------------------------------------------------------------------------------------------------------------
>
>                 Key: GEODE-2944
>                 URL: https://issues.apache.org/jira/browse/GEODE-2944
>             Project: Geode
>          Issue Type: Bug
>          Components: lucene
>    Affects Versions: 1.2.0
>            Reporter: Shelley Lynn Hughes-Godfrey
>            Assignee: David Anuta
>
> When a lucene index is created, one must indicate the field to create the index on.  When the object value is a simple String, that must be specified as --field=__REGION_VALUE_FIELD.
> For example,
> create lucene index --name=newIndex --region=testRegion --field=__REGION_VALUE_FIELD
> However, the lucene help text (for the gfsh command) does not provide this detail.  In addition, it seems that when executing a lucene search, this must be entered again as --defaultField=__REGION_VALUE_FIELD.
> While this is probably not something one would use in production, I imagine it will be used by developers experimenting with Lucene, so we should consider adding this to the help text.
> {noformat}
> gfsh>help create lucene index
> NAME
>     create lucene index
> IS AVAILABLE
>     true
> SYNOPSIS
>     Create a lucene index that can be used to execute queries.
> SYNTAX
>     create lucene index --name=value --region=value --field=value(,value)* [--analyzer=value(,value)*]
> PARAMETERS
>     name
>         Name of the lucene index to create.
>         Required: true
>     region
>         Name/Path of the region on which to create the lucene index.
>         Required: true
>     field
>         fields on the region values which are stored in the lucene index.
>         Required: true
>     analyzer
>         Type of the analyzer for each field.
>         Required: false
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)