[ 
https://issues.apache.org/jira/browse/DERBY-4587?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12897401#action_12897401
 ] 

Rick Hillegas commented on DERBY-4587:
--------------------------------------

I would like to propose the following command line api for PlanExporter. Partly 
I am doing this because this api seems simpler to me. My other motivation is to 
verify that I am not missing any of the functionality provided by the tool. 
Thanks.

java org.apache.derby.tools.PlanExporter dbURL schemaName outputFileName [ -xsl 
styleSheet ] [ -stmt statementID ]

dbURL :== An url appropriate for connecting via DriverManager.getConnection()

schemaName :== A case-sensitive schema name

outputFileName :== Absolute or relative name of file to which output will be 
written

styleSheet :== Absolute or relative path name to an xsl style sheet for 
transforming the output.

statementID :== A 36 character statement id string from 
schemaName.SYSXPLAIN_STATEMENTS.STMT_ID

If a stylesheet is specified, then PlanExporter will use that stylesheet to 
transform the output. Otherwise, no stylesheet will be applied. This means 
that, by default, raw xml output is produced. In order to get html output, you 
must specify a Derby-supplied html stylesheet or one of your own. Of course, 
you can also specify a stylesheet which does not produce html output.

If a statement id is specified, then the output file will contain only that 
statement's plan. Otherwise, the output file will contain plans for all of the 
statements in schemaName.SYSXPLAIN_STATEMENTS.


> Add tools for improved analysis and understanding of query plans and 
> execution statistics
> -----------------------------------------------------------------------------------------
>
>                 Key: DERBY-4587
>                 URL: https://issues.apache.org/jira/browse/DERBY-4587
>             Project: Derby
>          Issue Type: Improvement
>          Components: SQL, Tools
>            Reporter: Bryan Pendleton
>            Assignee: C.S. Nirmal J. Fernando
>         Attachments: AdavancedXSL-mouseover.jpg, advancedViewXSL.xsl, 
> advancedViewXSL.xsl, advancedViewXSL2.xsl, advancedXSL-1.jpg, 
> advancedXSL-2.jpg, advancedXSL-3.jpg, basic_html-2.2.jpg, basic_html-2.3.jpg, 
> basic_html-2.jpg, basic_html-3.jpg, basic_html-4.1.jpg, basic_html-4.2.jpg, 
> Derby Query Plan Screen Shot 2.jpg, DERBY-4587-javadoc_fix.diff, 
> DERBY-4587-tool-2.diff, DERBY-4587-tool-3.diff, DERBY-4587-tool-4.diff, 
> DERBY-4587-tool-5.diff, DERBY-4587-tool-6.diff, DERBY-4587-tool-7-b.diff, 
> DERBY-4587-tool-7.diff, DERBY-4587-tool-8.diff, DERBY-4587-tool-9.1.diff, 
> DERBY-4587-tool-9.2.diff, DERBY-4587-tool-9.3.diff, DERBY-4587-tool-9.4.diff, 
> DERBY-4587-tool-9.5.diff, DERBY-4587-tool-9.6.diff, DERBY-4587-tool-9.7.diff, 
> DERBY-4587-tool-9.7.diff, DERBY-4587-tool-9.diff, DERBY-4587-tool-test1.diff, 
> DERBY-4587-tool-test2.diff, DERBY-4587-tool.diff, derby-logo.png, 
> Derby_Query_Plan_Screen_Shot.jpg, PostgreSQL license.jpg, Read_Me.txt, 
> screenshot-1.jpg, screenshot-2.jpg, screenshot-3.jpg, Simple HTML View (Pure 
> XSL).jpg, Source.rar, test.xml, test4.xsl, vanilla_html.xsl, 
> vanilla_html.xsl, vanilla_html.xsl, vanilla_html.xsl, vanilla_html.xsl, 
> xml_doc_screenshot.jpg, xml_doc_screenshot.jpg
>
>
> I think it would be great to see some work in the area of tools for helping
> with the analysis of complex query execution. Quite frequently, users of
> Derby have trouble comprehending (a) how their query is being translated
> into a query plan by the optimizer, and (b) what the execution-time resource
> usage of the various parts of the query is.
> There are low-level features in Derby which capture this information and
> record it, such as logQueryPlan, and the XPLAIN tables, but there is a lot
> of opportunity for designing higher-level tools which can process the query
> plan and execution statistics information and present it in a more
> comprehensible fashion. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply via email to