GEODE-2952 document quoting of exact match Lucene queries This closes #545
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/c08d70dd Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/c08d70dd Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/c08d70dd Branch: refs/heads/feature/GEODE-2632-18 Commit: c08d70dd4695dbbad17f86fa4227a13497ab0b08 Parents: fa808ac Author: Karen Miller <kmil...@pivotal.io> Authored: Fri May 26 15:10:43 2017 -0700 Committer: Karen Miller <kmil...@pivotal.io> Committed: Tue May 30 13:57:07 2017 -0700 ---------------------------------------------------------------------- .../gfsh/command-pages/search.html.md.erb | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/c08d70dd/geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb index 6cdf362..1c63ecf 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/search.html.md.erb @@ -62,7 +62,7 @@ search lucene --name=value --region=value --queryStrings=value --defaultField=va </tr> <tr> <td><span class="keyword parmname" style="whitespace:nowrap;">‑‐queryStrings</span></td> -<td><em>Required</em>. Query string to search the lucene index.</td> +<td><em>Required</em>. Query string to search the lucene index. Surround a string with double quote marks to do an exact match of the string.</td> <td> </td> </tr> <tr> @@ -84,21 +84,28 @@ search lucene --name=value --region=value --queryStrings=value --defaultField=va **Example Commands:** ``` pre -gfsh> search lucene --name=testIndex --region=/testRegion --queryStrings=value1 --defaultField=__REGION_VALUE_FIELD +gfsh> search lucene --name=testIndex --region=/testRegion --queryStrings=value1 + --defaultField=__REGION_VALUE_FIELD + +gfsh> search lucene --name=indexOfStrings --region=/stringTestRegion + --queryStrings='__REGION_VALUE_FIELD:"my exact string"' + --defaultField=__REGION_VALUE_FIELD ``` **Sample Output:** ``` pre -gfsh>search lucene --name=testIndex --region=/testRegion --queryStrings=value* --defaultField=__REGION_VALUE_FIELD +gfsh>search lucene --name=testIndex --region=/testRegion --queryStrings=value* + --defaultField=__REGION_VALUE_FIELD key | value | score --- | ------ | ----- 3 | value3 | 1 2 | value2 | 1 1 | value1 | 1 -gfsh>search lucene --region=/Person --name=analyzerIndex --defaultField=address --queryStrings="97763" +gfsh>search lucene --region=/Person --name=analyzerIndex --defaultField=address + --queryStrings="97763" key | value | score ------ | --------------------------------------------------------------------------------------------------------- | --------- key763 | Person{name='Fred Freeloader', email='f...@example.com', address='763 Miles Dv, Portland_OR_97763', re.. | 1.6694657