12.5.3 The Files, Globals, Classes, Modules, and Notifications Tabs

The Workbench Scripting Shell features the Files, Globals, Classes, Modules, and Notifications tabs, in addition to the main Shell tab.

The Files Tab

Lists folders and files for user-defined (custom) script files. The categories are User Scripts, User Modules, and User Libraries.

Figure 12.3 The Workbench Scripting Shell tab: Files

The Workbench Scripting Shell tab: Files

By default, scripts are stored in the scripts/ folder of your MySQL Workbench configuration folder. These default locations are:

Table 12.2 Default Scripts Location

Operating SystemDefault scripts/ path
Linux~/.mysql/workbench/scripts
Mac OS X~/Library/Application\ Support/MySQL/Workbench/scripts/
Windows 7C:\Users\[user]\AppData\Roaming\MySQL\Workbench\scripts\

The Globals Tab

At the top of the window is a list that is used to select the starting point, or root, of the GRT Globals tree displayed beneath it. By default, this starting point is the root of the tree, that is, '/'. You can expand or collapse the GRT Globals tree as desired. The GRT Globals tree is the structure in which MySQL Workbench stores document data. Clicking any item results in its name and value being displayed in the panel below the tree.

Figure 12.4 The Workbench Scripting Shell tab: Globals

The Workbench Scripting Shell tab: Globals

The Classes Tab

A class is a user-defined data type formed by combining primitive data types: integers, doubles, strings, dicts, lists, and objects. This tab shows the definitions of the classes used by the objects in the Modules tab. Clicking a class causes a brief description of the class to be displayed in a panel below the classes explorer.

Figure 12.5 The Workbench Scripting Shell tab: Classes

The Workbench Scripting Shell tab: Classes

When the Classes tab is selected, the list displays the following items:

The default view for this tab is Group By Name. This view shows all the different objects arranged alphabetically. Click the + icon or double-click a package to show the properties of the struct.

If you switch to the hierarchical view, you will see GrtObject: the parent object from which all other objects are derived.

The Modules Tab

The Modules tab enables you to browse the MySQL Workbench installed modules and their functions. Clicking a module within the explorer causes its details to be displayed in a panel below the explorer. This facility is useful for exploring the available modules, and their supported functions. It is also a way to check whether custom modules have been correctly installed.

Figure 12.6 The Workbench Scripting Shell tab: Modules

The Workbench Scripting Shell tab: Modules

The Notifications Tab

The set of notification classes used by MySQL Workbench modules. Click a notification class for a description of its use.

Figure 12.7 The Workbench Scripting Shell tab: Notifications

The Workbench Scripting Shell tab: Notifications