Author: plavin
Date: 2008-03-04 23:18:38 +0100 (Tue, 04 Mar 2008)
New Revision: 10123
Log:
Update the grt shell chapter
Modified:
trunk/workbench/grt-shell.xml
trunk/workbench/plugins.xml
Modified: trunk/workbench/grt-shell.xml
===================================================================
--- trunk/workbench/grt-shell.xml 2008-03-04 20:35:24 UTC (rev 10122)
+++ trunk/workbench/grt-shell.xml 2008-03-04 22:18:38 UTC (rev 10123)
Changed blocks: 3, Lines Added: 10, Lines Deleted: 222; 9193 bytes
@@ -316,127 +316,10 @@
</section>
-
-<!--/section-->
<!--End Exploring-->
-<!--section id="wb-using-grt-shell">
- <title>Using the GRT Shell</title>
-
- <para>
- There are three built-in Lua modules that assist working from the
- GRT shell:
-
- <itemizedlist>
-
- <listitem>
- <para>
- <literal>grtV</literal> – for accessing any
- object/variable in the <literal>Values</literal> tab
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>grtS</literal> – for viewing the structs
- defined in the <literal>Structures</literal> tab
- </para>
- </listitem>
-
- <listitem>
- <para>
- <literal>grtM</literal> – for accessing any object in
- the <literal>Modules</literal> tab
- </para>
-
- <para>
- <remark>grtA grtU</remark>
- </para>
-
- </listitem>
-
- </itemizedlist>
- </para>
-
- <para>
- All items in all the tabs are accessible from the GRT shell.
-
- <remark>
- You can use the structs defined ...
- </remark>
- </para>
-
- <para>
- The script example below uses the <literal>getGlobal</literal>
- method of the <literal>grtV</literal> object to return a list of
- databases and then iterates through this list.
- </para>
-
-<programlisting>
-dbs = grtS.getGlobal("/rdbmsMgmt/rdbms")
-for i = 1, grtS.getn(dbs) do
- print(dbs[i].name)
-end
-</programlisting>
-
- <para>
- The <literal>getGlobal</literal> method returns the object found
- at the path parameter passed to it. In this case, the object is a
- list that is traversed using a <literal>for</literal> loop
- controlled by the <literal>getn</literal> method which returns the
- number of elements in the database list.
- </para>
-
- <para>
- Running this <literal>for</literal> loop outputs the names of the
- database formats supported by the &workbench;:
- </para>
-
-<programlisting>
-"Oracle"
-"Mysql"
-"MaxDB"
-"GenericJdbc"
-"Mssql"
-"Access"
-</programlisting>
-
- <para>
- To discover all the methods available for a specific object, type
- the object name preceded by a <quote><literal>?</literal></quote>.
- For example typing <command>?grtV</command> shows:
- </para>
-
-<programlisting>
-GRT Value Management Library - grtV
-––––––––––
-A library that contains functions to work with GRT values.
-
-clearList child diffMake
-diffApply duplicate fromXml
-getContentType getKey getListItemByObjName
-getListRefValueByObjName getn getGlobal
-insert load lookupAdd
-lookupId newDict newList
-newObj remove save
-setContentType setGlobal toLua
-toXml typeOf
-
-Type 'help grtV.<command>' to get help on a specific command.
-</programlisting>
-
- <para>
- <remark>
- Add an object that will appear in the tab? i.e definition of an
- different database struct?
- Above list needs changing.
- </remark>
- </para>
-
- </section>
-
<section id="invoking-grt-from-command-line">
<title>Invoking the GRT Shell From the Command Line</title>
@@ -455,101 +338,22 @@
Execute this file by typing:
</para>
-<programlisting>
-C:\> <userinput>MySQLGrtShell.exe -?</userinput>
+<programlisting>
+C:\> <userinput>MySQLGrtShell.exe</userinput>
</programlisting>
<para>
- Do this and you should see the following listing:
- <remark>Not yet Implemented</remark>
+ Doing this opens the GRT shell window as a stand alone window.
+ <remark>[PL]GRT tree window not there.</remark>
</para>
-<programlisting>
-Usage: C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe [-classpath path] »
- [-modulepath path] [-jvm library] [-d path] [-listen port] [-verbose] [-x] [luafile]
- C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -j structsfile outputdir
- C:\Program Files\MySQL\MySQL Tools for 5.0\grtsh.exe -p structsfile outputdir
- -lua ......... Use the Lua shell (default).
- -py .......... Use the Python shell.
- -classpath ... Sets the java classpath to the given value.
- -modulepath .. Sets the location of the GRT module directory.
- -jvm ......... The java virtual machine library to use (with absolute path).
- -basedir ..... Path to the data files location.
- -d path ...... Modules directory
- -x ........... Exits the shell after running the specified file
- luafile ...... File that is run at startup.
-
- -listen port . Runs in 'remote agent' mode on the given port number.
- -verbose ..... Prints detailed startup information.
- -j ........... Generates Java classes from the given structs file.
- -p ........... Generates PHP classes from the given structs file.
- -D var=value . Sets a global shell variable to the given value.
-Environment variables:
-GRT_MODULE_PATH Equivalent to -modulepath, must point to the directory
- where the grtsh binary resides
-</programlisting>
-
<para>
The default shell is the <literal>Lua</literal> shell and is
- indicated by the <literal>/ ></literal> prompt. Using the
- <option>-py</option> option opens a Python shell, indicated by the
- <literal>/>>></literal> prompt.
+ indicated by the <literal>/ ></literal> prompt.
</para>
- <para>
- If you wish to set the classpath for Java classes use the
- <option>classpath</option> option. You may also change the Java
- Virtual Machine (JVM) by using the <option>jvm</option> option
- with the absolute path to the JVM you wish to use.
- </para>
-
- <para>
- The <option>modulepath</option> option sets the location of the
- <filename>dll</filename> files used with the GRT shell. These
- files are located in the same directory as the
- <filename>grtsh.exe</filename> file. You can also set this
- directory by defining the environment variable,
- <literal>GRT_MODULE_PATH</literal>.
- </para>
-
- <para>
- The location of any data files you wish to use may be set using
- the <option>basedir</option> option.
-
- <remark>
- [PL]What are data files?
- </remark>
- </para>
-
- <para>
- To see the various modules that are loaded at startup use the
- <option>verbose</option> option. The java modules are stored in
- the <filename>java\com\mysql\grt\modules</filename> directory
- immediately below the installation directory and the
- <literal>Lua</literal> modules in the <filename>lua</filename>
- directory. Currently, importing Python modules is not supported.
- </para>
-
- <para>
- To include modules other than the default modules, use the
- <option>d</option> option with a path.
- </para>
-
- <para>
- It is also possible to use the GRT shell to convert XML files to
- Java or PHP class files, by opening the shell using the
- <option>j</option> or the <option>p</option> option and specifying
- the XML source file and the destination directory.
- </para>
-
- <para>
- Use the <option>listen</option> option with a port number to run
- the GRT shell as a service that can be accessed from a remote
- location.
- </para>
-
- <para>
+ <!--para>
Perhaps most importantly, you can pass a <literal>Lua</literal>
script to the shell on startup. This allows you to perform tasks
using a script file without even opening the &workbench;.
@@ -559,29 +363,13 @@
<literal>Lua</literal> script by clicking the <guibutton>Generate
Migration Script</guibutton> when migrating using the graphical
interface.
- < For information on creating a Lua script see,
+ For information on creating a Lua script see,
xref linkend="mysql-migration-toolkit-indepth-summary". A Lua
migration script is examined in detail in
linkend="scripted-migration" />.
- </para>
+ </para-->
- <para>
- Passing a <literal>Lua</literal> file to the shell is usually
- invoked using the <option>x</option> option so that the shell
- closes after the script has executed.
- </para>
-
- <para>
- The appearance of the GRT shell run from the command line is
- identical to its appearance when run from within the &workbench;.
- All the commands and options described
- in <xref linkend="using-grt-shell"/> are available when the GRT
- shell is invoked from the command line.
- </para>
-
- </section-->
-
-<!--End Using -->
-
+ </section>
+
</chapter>
<!-- end GRT Shell -->
Modified: trunk/workbench/plugins.xml
===================================================================
--- trunk/workbench/plugins.xml 2008-03-04 20:35:24 UTC (rev 10122)
+++ trunk/workbench/plugins.xml 2008-03-04 22:18:38 UTC (rev 10123)
Changed blocks: 2, Lines Added: 7, Lines Deleted: 7; 1735 bytes
@@ -24,7 +24,7 @@
The best way to learn about plugins is to examine one. An example
Lua plugin is located in the <filename>C:\Program
Files\MySQL\MySQL Workbench
- <replaceable>version_number</replaceable>\modules</filename>
+ <replaceable>version</replaceable>\modules</filename>
directory. In that directory you can find the
<filename>catalog_utils.grt.lua</filename> Lua file. This is the
plugin for copying SQL to the clipboard.
@@ -98,12 +98,12 @@
-----------------------------------
A library that contains functions to work with GRT values.
- clearList child fromXml
- getContentType getKey getListItemByObjName
- getn getGlobal insert
- load newDict newList
- newObj remove save
- setGlobal toLua toXml
+ clearList child fromXml
+ getContentType getKey getListItemByObjName
+ getn getGlobal insert
+ load newDict newList
+ newObj remove save
+ setGlobal toLua toXml
typeOf
</programlisting>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r10123 - trunk/workbench | plavin | 4 Mar |
