[ https://issues.apache.org/jira/browse/GEODE-2592?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15903912#comment-15903912 ]
ASF GitHub Bot commented on GEODE-2592: --------------------------------------- Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105277043 --- Diff: geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb --- @@ -675,6 +679,47 @@ Occurred on following members 1. ubuntu(server1:17682)<v1>:27574 ``` +## <a id="create_lucene_index" class="no-quick-link"></a>create lucene index + +Create a Lucene index. + +See also [describe lucene index](describe.html#describe_lucene_index), [destroy lucene index](destroy.html#destroy_lucene_index), [list lucene indexes](list.html#list_lucene_indexes) and [search lucene](search.html#search_lucene). + +**Availability:** Online. You must be connected in <span class="keyword parmname">gfsh</span> to a JMX Manager member to use this command. + +**Syntax:** + +``` pre +create lucene index --name=value --region=value --field=value(,value)* [--analyzer=value(,value)*] [--group=value(,value)*] +``` + +| Name | Description | Default | +|----------------------------------------------------|----------------------------------------------------------------------------------------|---------| +| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the index to create. | | +| <span class="keyword parmname">\\-\\-region</span> | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | | +| <span class="keyword parmname">\\-\\-field</span> | *Required.* Field of the region values that are referenced by the index. | | +| <span class="keyword parmname">\\-\\-analyzer</span> | Analyzer to extract terms from text | | +| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in the specified member groups. | | + +<span class="tablecap">Table 6. Create Index Parameters</span> + +**Example Commands:** + +``` pre +create region --name=Person --type=PARTITION_REDUNDANT_PERSISTENT +create lucene index --name=customerIndex --region=/Customer --field=symbol,revenue,SSN,name,email,address,__REGION_VALUE_FIELD +create lucene index --name=analyzerIndex --region=/Person --field=name,email,address,revenue --analyzer=null,org.apache.lucene.analysis.core.KeywordAnalyzer,examples.MyCharacterAnalyzer,null +``` + +**Sample Output:** + +``` pre +gfsh>create lucene index --name=testIndex --region=testRegion --field=__REGION_VALUE_FIELD + Member | Status +---------------------------------------- | --------------------------------- +192.168.1.23(server50505:17200)<v1>:1025 | Successfully created lucene index --- End diff -- Double check that the IP address is anonymous-enough. > Document Lucene-related gfsh commands > ------------------------------------- > > Key: GEODE-2592 > URL: https://issues.apache.org/jira/browse/GEODE-2592 > Project: Geode > Issue Type: New Feature > Components: docs > Reporter: Dave Barnes > Assignee: Dave Barnes > > Add five new Lucene-related gfsh commands to the gfsh command reference pages: > create lucene index, describe lucene index, destroy lucene index, list lucene > indexes, search lucene. -- This message was sent by Atlassian JIRA (v6.3.15#6346)