|Deploying and Running Pivotal GemFire / Using the GemFire SHell (gfsh)|
The gfsh utility provides useful features for a shell environment, including command auto-complete, preserved command history, and delimiting of multi-line commands. Context-sensitive help is available by command and by topic.
This section describes these features.
To view a list of available gfsh commands, press Tab at an empty prompt.
gfsh> alter disk-store compact offline-disk-store connect debug describe connection describe offline-disk-store disconnect echo encrypt password exit help hint history run set variable sleep start data-browser start jconsole start jvisualvm start locator start pulse start server start vsd status locator status server stop locator stop server upgrade offline-disk-store validate offline-disk-store version
Use the hint command to get information on a particular topic.
gfsh>hint data User data as stored in regions of the GemFire distributed system. create index : Create an index that can be used when executing queries. destroy index : Destroy/Remove the specified index. export data : Export user data from a region to a file. get : Display an entry in a region. If using a region whose key and value classes have been set, then specifying --key-class and --value-class is unnecessary. import data : Import user data from a file to a region. list indexes : Display the list of indexes created for all members. locate entry : Identifies the location, including host, member and region, of entries that have the specified key. put : Add/Update an entry in a region. If using a region whose key and value classes have been set, then specifying --key-class and --value-class is unnecessary. query : Run the specified OQL query as a single quoted string and display the results in one or more pages. Limit will default to the value stored in the "APP_FETCH_SIZE" variable. Page size will default to the value stored in the "APP_COLLECTION_LIMIT" variable. rebalance : Rebalance partitioned regions. The default is for all partitioned regions to be rebalanced. remove : Remove an entry from a region. If using a region whose key class has been set, then specifying --key-class is unnecessary.
gfsh>hint server A server is GemFire cluster member which holds a GemFire cache. Depending on the topology used it can refer to either a system that responds to client requests or a system that is only a peer to other members. describe member : Display information about a member, including name, id, groups, regions, etc. export logs : Export the log files for a member or members. list members : Display all or a subset of members. start server : Start a GemFire Cache Server. status server : Display the status of a GemFire Cache Server. stop server : Stop a GemFire Cache Server.
gfsh>hint Hints are availbale for following topics. Use "hint <topic-name>" for a specific hint. Configuration Data Debug-Utility Disk Store Function Execution GFSH GemFire Help JMX Lifecycle Locator Management-Monitoring Manager Region Server Statistics WAN
Use the help command to get information on a particular command.
Depending on the command, typing help <command-name> displays usage information for that particular command or a list of commands related to the command.
gfsh>help start start data-browser (Available) Start Data Browser in a separate process. start gateway-receiver (Not Available) Start the Gateway Receiver on a member or members. start gateway-sender (Not Available) Start the Gateway Sender on a member or members. start jconsole (Available) Start the JDK's JConsole tool in a separate process. JConsole will be launched, but connecting to GemFire must be done manually. start jvisualvm (Available) Start the JDK's Java VisualVM (jvisualvm) tool in a separate process. Java VisualVM will be launched, but connecting to GemFire must be done manually. start locator (Available) Start a Locator. start pulse (Available) Open a new window in the default Web browser with the URL for the Pulse application. start server (Available) Start a GemFire Cache Server. start vsd (Available) Start VSD in a separate process.
gfsh>help export data NAME export data IS AVAILABLE false SYNOPSIS Export user data from a region to a file. SYNTAX export data --region=value --file=value --member=value PARAMETERS region Region from which data will be exported. Required:true file File to which the exported data will be written. The file must have an extension of ".gfd". Required:true member Name/Id of a member which hosts the region. The data will be exported to the specified file on the host where the member is running. Required:true
Use the Tab key to auto-complete a command or trigger possible completions.Use the Tab key after entering a partial command to trigger auto-completion of the command or a list of possible command completions. For example, hitting Tab after typing hint displays all available topics:
gfsh>hint Configuration Data Debug-Utility Disk Store Function Execution GFSH GemFire Help JMX Lifecycle Locator Management-Monitoring Manager Region Server Statistics WANHitting tab after typing hint d displays the topics available that begin with 'd':
gfsh>hint d data debug-Utility disk StoreAuto-completion also supplies available parameters and arguments to commands; for example, hitting tab after typing start will list all the processes that can be started.
gfsh>start start data-browser start jconsole start jvisualvm start locator start pulse start server start vsd
Access command history with the Up arrow.
Access a command in your shell history by scrolling through previous commands with the Up arrow.
Delimit multi-line commands with \.
gfsh>create region --name=region1 \ --type=REPLICATE_PERSISTENT \ --cache-writer=com.gemstone.gemfire.examples.MyCacheWriter \ --group=Group1 --disk-store=DiskStore1