This site will be decommissioned on January 30th 2025. After that date content will be available at techdocs.broadcom.com.

describe

Updated on   07/05/2024

This topic describes the VMware GemFire Search describe command.

Note: VMware GemFire Search uses the Lucene name in syntax and APIs.

The describe lucene index command displays information about a VMware GemFire Search index. For details about VMware GemFire Search, see VMware GemFire Search Integration.

Availability: Online. To use this command, you must be connected to a JMX Manager member in gfsh.

Syntax

describe lucene index --name=value --region=value

Parameters

Name Description
‑‑name Required. Name of the index to describe.
‑‑region Required. Name and path of the region in which the index exists

Example Command

gfsh>describe lucene index --name=personIndex --region=/Person

Sample Output

gfsh>describe lucene index --name=personIndex --region=/Person Index Name | Region Path | Indexed Fields | Field Analyzer | Status | Query Executions | Updates | Commits | Documents ----------- | ----------- | ---------------------------------------------- | -------------- | ----------- | ---------------- | ------- | ------- | --------- personIndex | /Person | [name, email, address, streetAddress, revenue] | {} | Initialized | 339 | 1008 | 962 | 1004 gfsh>describe lucene index --name=analyzerIndex --region=/Person Index Name | Region Path | Indexed Fields | Field Analyzer | Status | Query Executions | Updates | Commits | Documents ------------- | ----------- | ---------------------- | ------------------------------------- | ----------- | ---------------- | ------- | ------- | --------- analyzerIndex | /Person | [address, name, email] | {address=MyCharacterAnalyzer, email.. | Initialized | 1695 | 1008 | 962 | 1004

Additional gfsh Commands

For additional GemFire Search gfsh commands, see the following:

check-circle-line exclamation-circle-line Translation Error Open MyLibrary close-line
Scroll to top icon
Send Feedback Send Feedback