blob: 1dc6628fab0f9563b8685763f1c49044ea4d4fba [file] [log] [blame]
---
title: locate entry
---
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
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.
-->
Locate a region entry on a member.
## <a id="concept_73B980C1138743DDBBFACE68009BD1E3__section_04BD7EC0032147DFA9CCD1331EE3B694" class="no-quick-link"></a>locate entry
Locate a given entry on members using the specified key. This command is useful when using partitioned regions.
**Availability:** Online. You must be connected in `gfsh` to a JMX Manager member to use this command.
**Syntax:**
``` pre
locate entry --key=value --region=value [--key-class=value]
[--value-class=value] [--recursive=value]
```
<a id="concept_73B980C1138743DDBBFACE68009BD1E3__table_dk3_pdg_2w"></a>
| Name | Description | Default Value |
|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| <span class="keyword parmname">\\-\\-key</span> | *Required.* String or JSON text from which to create a key. Examples include: "`James`", "`100L`" and "`('id': 'l34s')`". |   |
| <span class="keyword parmname">\\-\\-region</span> | *Required.* Region in which to locate values. |   |
| <span class="keyword parmname">\\-\\-key-class</span> | Fully qualified class name of the key's type. | `java.lang.String` |
| <span class="keyword parmname">\\-\\-value-class</span> | Fully qualified class name of the value's type. | `java.lang.String` |
| <span class="keyword parmname">&#8209;&#8209;recursive</span> | Whether to traverse regions and subregions recursively. | false |
<span class="tablecap">Table 1. Locate Entry Parameters</span>
**Example Commands:**
``` pre
locate entry --key=('id':'133abg124') --region=/region1
--key-class=data.ProfileKey --recursive=true;
```
**Sample Output:**
``` pre
gfsh>locate entry --key=('123abc') --region=region2
Result : true
Key Class : java.lang.String
Key : ('123abc')
Locations Found : 2
MemberName | MemberId
---------- | -------------------------------------
server1 | GemFireStymon(server1:3692)<v1>:13487
server2 | GemFireStymon(server2:2340)<v2>:11613
```