db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bpendle...@apache.org
Subject svn commit: r985711 - in /db/derby/docs/trunk/src/tools: ctoolsusingplanexp.dita rtoolsplanexpexamples.dita rtoolsplanexpxmlformat.dita
Date Sun, 15 Aug 2010 16:59:49 GMT
Author: bpendleton
Date: Sun Aug 15 16:59:48 2010
New Revision: 985711

URL: http://svn.apache.org/viewvc?rev=985711&view=rev
Log:
DERBY-4758: Adding documentation about the PlanExporter tool

This patch was contributed by C.S. Nirmal J. Fernando (nirmal070125 at gmail dot com)

This patch updates the PlanExporter documentation to respond to several
review comments.

Modified:
    db/derby/docs/trunk/src/tools/ctoolsusingplanexp.dita
    db/derby/docs/trunk/src/tools/rtoolsplanexpexamples.dita
    db/derby/docs/trunk/src/tools/rtoolsplanexpxmlformat.dita

Modified: db/derby/docs/trunk/src/tools/ctoolsusingplanexp.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsusingplanexp.dita?rev=985711&r1=985710&r2=985711&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsusingplanexp.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsusingplanexp.dita Sun Aug 15 16:59:48 2010
@@ -27,7 +27,8 @@ limitations under the License.
 <p>Before you run the <codeph>PlanExporter</codeph> tool, make sure that
 your classpath contains the
 <ph conref="../conrefs.dita#prod/productshortname"></ph> jar files, including
-<i>derbytools.jar</i>. You must also have <i>xalan.jar</i> in your
classpath.</p>
+<i>derbytools.jar</i>. </p>
+
 <p>Before you run the <codeph>PlanExporter</codeph> tool, you must capture
the 
 <codeph>stmt_id</codeph> of the query you have executed from
 <codeph>SYSXPLAIN_STATEMENTS system table</codeph>. To do so, follow these
@@ -47,8 +48,7 @@ about the SYSXPLAIN_STATEMENTS system ta
 <p>You can run the tool as follows in the directory where your database
 is located.</p>
 <codeblock>
-java org.apache.derby.tools.PlanExporter jdbc:derby:<i>database_name 
-    username password schema_name stmt_id</i> <i>options</i>
+java org.apache.derby.tools.PlanExporter <i>derby_connection_URL schema_name stmt_id
options</i>
 </codeblock>
 <p>The <i>options</i> can be passed according to your requirements. Consider

 the following possible scenarios:</p>
@@ -78,7 +78,7 @@ functions, specify the following options
 <li>
 <p>To generate an advanced view of the query plan, you can use advanced XSL
 style sheets provided with
-<ph conref="../conrefs.dita#prod/productshortname"></ph>, or you can specify
a
+<ph conref="../conrefs.dita#prod/productshortname"></ph> inside <i>derbytools.jar/org/apache/derby/impl/tools/planexporter/resources/</i>,
or you can specify a
 style sheet created by you. To do this, specify the following options:</p>
 <codeblock>-adv -xsl <i>fileName</i> -xml <i>path</i></codeblock>

 <note> 

Modified: db/derby/docs/trunk/src/tools/rtoolsplanexpexamples.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsplanexpexamples.dita?rev=985711&r1=985710&r2=985711&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsplanexpexamples.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsplanexpexamples.dita Sun Aug 15 16:59:48 2010
@@ -59,7 +59,7 @@ results and note it down. It looks somet
 <codeblock>9ac8804c-0129-cc31-ca9a-00000047f1e8</codeblock>
 </li>
 <li>Run the <codeph>PlanExporter</codeph> tool in the same location:
-<codeblock>java org.apache.derby.tools.PlanExporter jdbc:derby:myDb "" "" MY_SCHEMA

+<codeblock>java org.apache.derby.tools.PlanExporter jdbc:derby:myDb MY_SCHEMA 
     9ac8804c-0129-cc31-ca9a-00000047f1e8 -html plain_html;</codeblock>
 <p>This command uses the default style sheet provided with 
 <ph conref="../conrefs.dita#prod/productshortname"></ph>, and the HTML

Modified: db/derby/docs/trunk/src/tools/rtoolsplanexpxmlformat.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsplanexpxmlformat.dita?rev=985711&r1=985710&r2=985711&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsplanexpxmlformat.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsplanexpxmlformat.dita Sun Aug 15 16:59:48 2010
@@ -42,7 +42,11 @@ plan - (The root of the XML tree)
 |
 |-- statement - (first child - The query executed)
 |
-|-- details - (second child - Contains the query plan)
+|-- time - (second child - The time that this query executed
+|
+|-- stmt_id - (Third Child - The STMT_ID of the query)
+|
+|-- details - (fourth child - Contains the query plan)
 </codeblock>
 </li>
 <li><b>The <codeph>statement</codeph> element:</b>
@@ -53,6 +57,19 @@ table.</p>
 <codeblock>&lt;statement&gt;select * from my_table&lt;/statement&gt;
 </codeblock>
 </li>
+<li><b>The <codeph>time</codeph> element:</b>
+<p>This element has only its value. That value implies the date &amp; time which
the query executed, as retrieved from the XPLAIN_TIME row of SYSXPLAIN_STATEMENTS table.</p>
+<p>For example:</p>
+<codeblock>&lt;time&gt;2010-07-13 14:27:59.405&lt;/time&gt;
+</codeblock>
+</li>
+<li><b>The <codeph>stmt_id</codeph> element:</b>
+<p>This element has only its value. That value implies the statement id of the query
executed, as retrieved from the STMT_ID row of SYSXPLAIN_STATEMENTS
+table.</p>
+<p>For example:</p>
+<codeblock>&lt;stmt_id&gt;9ac8804c-0129-cc31-ca9a-00000047f1e8&lt;/stmt_id&gt;
+</codeblock>
+</li>
 <li><b>The <codeph>details</codeph> element:</b>
 <p>This element contains the query plan, as a tree structure
 of plan nodes.</p>



Mime
View raw message