Skip to content

Commit

Permalink
GEODE-2592 Document Lucene-related gfsh commands
Browse files Browse the repository at this point in the history
  • Loading branch information
@davebarnes97
davebarnes97 committed Mar 10, 2017
1 parent b74a0bd commit ab16864
Show file tree
Hide file tree
Showing 9 changed files with 405 additions and 118 deletions.
18 changes: 18 additions & 0 deletions geode-book/master_middleman/source/subnavs/geode-subnav.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1765,6 +1765,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/quick_ref_commands_by_area.html#topic_1C82E6F1B2AF4A65A8DA6B3C846BAC13">Locator Commands</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/quick_ref_commands_by_area.html#topic_lucene_commands">Lucene Commands</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/quick_ref_commands_by_area.html#topic_cvg_bls_5q">PDX Commands</a>
</li>
Expand Down Expand Up @@ -1851,6 +1854,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/create.html#topic_960A5B6FD3D84E1881EE118E299DD12D">create index</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/create.html#create_lucene_index">create lucene index</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/create.html#topic_54B0985FEC5241CA9D26B0CE0A5EA863">create region</a>
</li>
Expand Down Expand Up @@ -1881,6 +1887,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/describe.html#topic_C635B500BE6A4F1D9572D0BC98A224F2">describe disk-store</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/describe.html#describe_lucene_index">describe lucene index</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/describe.html#topic_D62F3D42B1D84CF68F03D54D5122806A">describe member</a>
</li>
Expand All @@ -1905,6 +1914,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/destroy.html#topic_D00219CCD6F64C1582A0802AC5CDF3F3">destroy index</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/destroy.html#destroy_lucene_index">destroy lucene index</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/destroy.html#topic_BEDACECF4599407794ACBC0E56B30F65">destroy region</a>
</li>
Expand Down Expand Up @@ -2003,6 +2015,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/list.html#topic_B3B51B6DEA484EE086C4F657EC9831F2">list indexes</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/list.html#list_lucene_indexes">list lucene indexes</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/list.html#topic_5B5BFB2E5F314210858641BE3A689637">list members</a>
</li>
Expand Down Expand Up @@ -2047,6 +2062,9 @@ gfsh</a>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/run.html">run</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/search.html">search lucene</a>
</li>
<li>
<a href="/docs/guide/11/tools_modules/gfsh/command-pages/set.html">set variable</a>
</li>
Expand Down
99 changes: 63 additions & 36 deletions geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,36 +18,38 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<a id="topic_9663C9448D2745B387FC08F84818DDEC"></a>


Create async-event-queues, disk-stores, gateway receivers, gateway senders, indexes, and regions.

- **[create async-event-queue](../../../tools_modules/gfsh/command-pages/create.html#topic_ryz_pb1_dk)**
- **[create async-event-queue](#topic_ryz_pb1_dk)**

Creates an asynchronous event queue for batching events before they are delivered by a gateway sender.

- **[create defined indexes](../../../tools_modules/gfsh/command-pages/create.html#topic_w2t_l3m_qq)**
- **[create defined indexes](#topic_w2t_l3m_qq)**

Creates all the defined indexes.

- **[create disk-store](../../../tools_modules/gfsh/command-pages/create.html#topic_bkn_zty_ck)**
- **[create disk-store](#topic_bkn_zty_ck)**

Defines a pool of one or more disk stores, which can be used by regions and client subscription queues, and gateway sender queues for WAN distribution.

- **[create gateway-receiver](../../../tools_modules/gfsh/command-pages/create.html#topic_a4x_pb1_dk)**
- **[create gateway-receiver](#topic_a4x_pb1_dk)**

Creates a gateway receiver. You can only have one gateway receiver on each member, and unlike a gateway sender, you do not need to specify an identifier for the gateway receiver .

- **[create gateway-sender](../../../tools_modules/gfsh/command-pages/create.html#topic_hg2_bjz_ck)**
- **[create gateway-sender](#topic_hg2_bjz_ck)**

Creates a gateway sender on one or more members of a distributed system.

- **[create index](../../../tools_modules/gfsh/command-pages/create.html#topic_960A5B6FD3D84E1881EE118E299DD12D)**
- **[create index](#topic_960A5B6FD3D84E1881EE118E299DD12D)**

Create an index that can be used when executing queries.

- **[create region](../../../tools_modules/gfsh/command-pages/create.html#topic_54B0985FEC5241CA9D26B0CE0A5EA863)**
- **[create lucene index](#create_lucene_index)**

Create a region with given path and configuration.

- **[create region](#topic_54B0985FEC5241CA9D26B0CE0A5EA863)**

Create a region with given path and configuration.

Expand All @@ -72,10 +74,8 @@ create async-event-queue --id=value --listener=value [--group=value(nullvalue)*]
[--listener-param=value(,value)*]
```

<a id="topic_ryz_pb1_dk__table_jzz_pb1_dk"></a>

**Parameters, create async-event-queue:**
<table>
<caption><span class="tablecap">Table 1. Create Async-Event-Queue Parameters</span></caption>
<colgroup>
<col width="33%" />
<col width="34%" />
Expand Down Expand Up @@ -179,8 +179,6 @@ create async-event-queue --id=value --listener=value [--group=value(nullvalue)*]
</tbody>
</table>

<span class="tablecap">Table 1. Create Async-Event-Queue Parameters</span>

**Example Commands:**

``` pre
Expand All @@ -201,14 +199,13 @@ See also [define index](define.html) and [clear defined indexes](clear.html).
create defined indexes [--member=value] [--group=value]
```

<a id="topic_w2t_l3m_qq__table_cgy_3jm_qq"></a>
**Parameters, create defined indexes:**

| Name | Description | Default |
|------------------------------------------------|--------------------------------------------------------------------|---------|
| <span class="keyword parmname">\\-\\-member</span> | Name/Id of the member on which index will be created. |   |
| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in this member group. |   |

<span class="tablecap">Table 2. Create Defined Indexes Parameters</span>

**Example Commands:**

Expand Down Expand Up @@ -250,10 +247,10 @@ create disk-store --name=value --dir=value(,value)* [--allow-force-compaction(=v
[--disk-usage-warning-percentage=value] [--disk-usage-critical-percentage=value]
```

<a id="topic_bkn_zty_ck__table_lkn_zty_ck"></a>

**Parameters, create disk-store:**

<table>
<caption><span class="tablecap">Table 3. Create Disk-Store Parameters</span></caption>
<colgroup>
<col width="25%" />
<col width="50%" />
Expand Down Expand Up @@ -335,8 +332,6 @@ If the specified directory does not exist, the command will create the directory
</tbody>
</table>

<span class="tablecap">Table 3. Create Disk-Store Parameters</span>

**Example Commands:**

``` pre
Expand Down Expand Up @@ -369,10 +364,9 @@ create gateway-receiver [--group=value(,value)*] [--member=value(,value)*]
[--gateway-transport-filter=value(,value)*]
```

<a id="topic_a4x_pb1_dk__table_v4x_pb1_dk"></a>
**Parameters, create gateway-receiver:**

<table>
<caption><span class="tablecap">Table 4. Create Gateway-Receiver Parameters</span></caption>
<colgroup>
<col width="33%" />
<col width="33%" />
Expand Down Expand Up @@ -436,12 +430,10 @@ create gateway-receiver [--group=value(,value)*] [--member=value(,value)*]
</tbody>
</table>

<span class="tablecap">Table 4. Create Gateway-Receiver Parameters</span>

**Example Commands:**

``` pre
gfsh>create gatweway-receiver --member=server1
gfsh>create gateway-receiver --member=server1
```

**Sample Output:**
Expand Down Expand Up @@ -477,10 +469,9 @@ create gateway-sender --id=value --remote-distributed-system-id=value
[--gateway-transport-filter=value(,value)*]
```

<a id="topic_hg2_bjz_ck__table_ah2_bjz_ck"></a>
**Parameters, create gateway-sender:**

<table>
<caption><span class="tablecap">Table 5. Create Gateway-Sender Parameters</span></caption>
<colgroup>
<col width="30%" />
<col width="50%" />
Expand Down Expand Up @@ -606,8 +597,6 @@ create gateway-sender --id=value --remote-distributed-system-id=value
</tbody>
</table>

<span class="tablecap">Table 5. Create Gateway-Sender Parameters</span>

**Example Commands:**

``` pre
Expand Down Expand Up @@ -638,18 +627,17 @@ create index --name=value --expression=value --region=value
[--member=value] [--type=value] [--group=value]
```

<a id="topic_960A5B6FD3D84E1881EE118E299DD12D__table_9E1C010276AC45A59446A767A517D39F"></a>
**Parameters: create index:**

| Name | Description | Default |
|----------------------------------------------------|----------------------------------------------------------------------------------------|---------|
| <span class="keyword parmname">\\-\\-name</span> | *Required.* Name of the index to create. |   |
| <span class="keyword parmname">\\-\\-expression</span> | *Required.* Field of the region values that are referenced by the index. |   |
| <span class="keyword parmname">&#8209;&#8209;expression</span> | *Required.* Field of the region values that are referenced by the index. |   |
| <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">\\-\\-member</span> | Name/Id of the member on which index will be created. |   |
| <span class="keyword parmname">\\-\\-type</span> | Type of the index. Valid values are: `range`, `key` and `hash`. | `range` |
| <span class="keyword parmname">\\-\\-group</span> | The index will be created on all the members in this member group. |   |

<span class="tablecap">Table 6. Create Index Parameters</span>

**Example Commands:**

Expand All @@ -675,6 +663,48 @@ 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)*]
```

**Parameters, create lucene index:**

| 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">&#8209;&#8209;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. |   |


**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
```

## <a id="topic_54B0985FEC5241CA9D26B0CE0A5EA863" class="no-quick-link"></a>create region

Create a region with given path and configuration.
Expand Down Expand Up @@ -711,10 +741,9 @@ See [Region Data Storage and Distribution](../../../developing/region_options/ch
[--total-num-buckets=value] [--compressor=value] [--off-heap(=value)]
```

<a id="topic_54B0985FEC5241CA9D26B0CE0A5EA863__table_4CDCDC115DD043D5B8ACAA8D4CCFB145"></a>
**Parameters, create region:**

<table>
<caption><span class="tablecap">Table 7. Create Region Parameters</span></caption>
<colgroup>
<col width="20%" />
<col width="50%" />
Expand Down Expand Up @@ -917,8 +946,6 @@ See [Region Data Storage and Distribution](../../../developing/region_options/ch
</tbody>
</table>

<span class="tablecap">Table 7. Create Region Parameters</span>

**Example Commands:**

``` pre
Expand Down
Loading

0 comments on commit ab16864

Please sign in to comment.