Tour of the DataBrowser Interface

To work in DataBrowser, you need to understand the screen layout and the options the browser provides.

Main Window

DataBrowser displays the Main Window at startup. All DataBrowser functionality is available through this window.

Toolbar

Access most functionality offered by the DataBrowser, including the ability to connect to and disconnect from a distributed system; specify security properties; execute queries; and export results to an XML file.

Menu

Set your preferences for the application. The menu displays the Preferences dialog that allows you to set your preferences for connections made to distributed systems, query execution, security preferences, and other miscellaneous options such as additional classpath components for the application, location of the log file, logging level among others.

Region List

The region list shows the regions that are present in the distributed system. This information is refreshed according to the interval specified in the application preferences. The list is displayed as a tree where the child nodes represent child regions of a GemFire regions.

Member List

When a region is selected the GemFire members that have the region defined are displayed in the member list. Right-clicking on a member displays a context menu where you can execute a Continuous Query (CQ) on the member for the selected region.

Query Pane

The query pane is a multi-line editor where you can enter OQL queries for execution. If a line is selected, the text on that line is the query string used for execution. If no line is selected, the text of the last line is automatically used as the query string for execution.

Results Pane

The results pane displays each results item in the table in the pane. Multiple tabs may be displayed under the results pane, each tab representing a specific Java type returned in the results.

Continuous Query (CQ)

A Continuous Query is syntactically identical to a regular GemFire OQL query, except that once its is registered on the member, the member continues sending result items that match the query specifications as changes happen in the region on the member.

The Continuous Query window has a single item in its toolbar that allows you to stop the execution of the CQ. It also shows some additional information about the query as it is being executed on the member. This includes the total number of events that have occurred on the member since the CQ was registered, including inserts, updates and deleted.

Each Results tab in a ContinuousQuery window has a drop down list that contains the field (columns in the table) names of the items in the results. This is useful in filtering the results. Selecting a field in this list allows you to filter the results displayed in the table by having it display only unique values for that field. For example, if one of the fields in the query results is a zip code, applying a filter on that field will result in the table displaying only a single row for each unique zip code returned by the query.

There is also an embedded pane that shows any messages or exceptions returned by the member.

Exporting Results to XML

You can export the contents of the Results pane in the Main Window to an XML file. The export also creates an associated XSD. This allows you to capture the results and manipulate it and examine it further using other tools at a later point in time.

Explore Functionality

The Results Pane in both the Main window and the CQ window has a context menu applicable to a single table row that allows you to drill down into the record in the result set. This is particularly useful to examine a record that contains fields that are collections or composite types.

To view custom application types, you must include the jars in the CLASSPATH or specify their location in the DataBrowser preferences.