[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user davebarnes97 closed the pull request at: https://github.com/apache/geode/pull/419 --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105278104 --- Diff: geode-docs/tools_modules/gfsh/command-pages/list.html.md.erb --- @@ -398,6 +402,49 @@ gfsh> list indexes No Indexes Found ``` +## list lucene indexes + +Display the list of lucene indexes created for all members. The optional `--with-stats` qualifier shows activity on the indexes. --- End diff -- Capitalize 'Lucene?' --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105277380 --- Diff: geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb --- @@ -233,6 +237,48 @@ PDX Serialization Meta-Data Stored : No ``` +## describe lucene index + +Describe a lucene index. + +See also [create lucene index](create.html#create_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 `gfsh` to a JMX Manager member to use this command. + +**Syntax:** + +``` pre +describe lucene index --name=value --region=value +``` + +| Name | Description | +||--| +| \\-\\-name | *Required.* Name of the lucene index to describe | +| \\-\\-region | *Required.* Name and path of the region in which the lucene index exists | --- End diff -- Capitalize 'Lucene?' --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
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):27574 ``` +## 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 gfsh 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 | +|||-| +| \\-\\-name | *Required.* Name of the index to create. | Â | +| \\-\\-region | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | Â | +| \\-\\-field | *Required.* Field of the region values that are referenced by the index. | Â | +| \\-\\-analyzer | Analyzer to extract terms from text | Â | +| \\-\\-group | The index will be created on all the members in the specified member groups. | Â | + +Table 6. Create Index Parameters + +**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):1025 | Successfully created lucene index --- End diff -- Double check that the IP address is anonymous-enough. --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105276904 --- Diff: geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb --- @@ -675,6 +679,47 @@ Occurred on following members 1. ubuntu(server1:17682):27574 ``` +## 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 gfsh 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 | +|||-| +| \\-\\-name | *Required.* Name of the index to create. | Â | +| \\-\\-region | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | Â | +| \\-\\-field | *Required.* Field of the region values that are referenced by the index. | Â | +| \\-\\-analyzer | Analyzer to extract terms from text | Â | +| \\-\\-group | The index will be created on all the members in the specified member groups. | Â | + +Table 6. Create Index Parameters --- End diff -- Table labeling comes out wrong. There are 2 tables labelled with number 6, and table 7 has 2 labels. Maybe just remove table labels completely? --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105276623 --- Diff: geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb --- @@ -675,6 +679,47 @@ Occurred on following members 1. ubuntu(server1:17682):27574 ``` +## 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 gfsh 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 | +|||-| +| \\-\\-name | *Required.* Name of the index to create. | Â | +| \\-\\-region | *Required.* Name/Path of the region which corresponds to the "from" clause in a query. | Â | +| \\-\\-field | *Required.* Field of the region values that are referenced by the index. | Â | +| \\-\\-analyzer | Analyzer to extract terms from text | Â | --- End diff -- Can you use a non-breaking hyphen here? --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105278956 --- Diff: geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb --- @@ -0,0 +1,49 @@ +--- +title: search lucene +--- + + + +## search lucene + +Search a lucene index --- End diff -- Is there more to this command? I don't know what it does from this description. There's no output shown for the sample command, so that doesn't help me. There are probably command line options that specify what to search for and which index to search within. Capitalize 'Lucene?' --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105279939 --- Diff: geode-docs/tools_modules/gfsh/quick_ref_commands_by_area.html.md.erb --- @@ -277,6 +277,20 @@ limitations under the License. Table 13. Locator Commands +## Lucene Commands + + + +| Command | Description | Availability| +|--|-|-| +| [create lucene index](command-pages/create.html#create_lucene_index) | Create a Lucene index. | online | --- End diff -- Capitalize 'Lucene' in each of the rows of this table? --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105277324 --- Diff: geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb --- @@ -233,6 +237,48 @@ PDX Serialization Meta-Data Stored : No ``` +## describe lucene index + +Describe a lucene index. + +See also [create lucene index](create.html#create_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 `gfsh` to a JMX Manager member to use this command. + +**Syntax:** + +``` pre +describe lucene index --name=value --region=value +``` + +| Name | Description | +||--| +| \\-\\-name | *Required.* Name of the lucene index to describe | --- End diff -- Capitalize 'Lucene?' --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
[GitHub] geode pull request #419: GEODE-2592 Document Lucene-related gfsh commands
Github user karensmolermiller commented on a diff in the pull request: https://github.com/apache/geode/pull/419#discussion_r105277184 --- Diff: geode-docs/tools_modules/gfsh/command-pages/describe.html.md.erb --- @@ -233,6 +237,48 @@ PDX Serialization Meta-Data Stored : No ``` +## describe lucene index + +Describe a lucene index. --- End diff -- Capitalize 'Lucene?' --- If your project is set up for it, you can reply to this email and have your reply appear on GitHub as well. If your project does not have this feature enabled and wishes so, or if the feature is enabled but not working, please contact infrastructure at infrastruct...@apache.org or file a JIRA ticket with INFRA. ---
