db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rick Hillegas (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-4758) Adding documentation about the PlanExporter Tool
Date Tue, 10 Aug 2010 15:41:17 GMT

    [ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896910#action_12896910

Rick Hillegas commented on DERBY-4758:

Thanks Nirmal and Kim for working on this documentation. I am starting to experiment with
the tool. In doing so, I am first trying to wrap my head around the documentation.

One thing that jumps out at me early on is this: in order to pilot this tool I need to have
3 user manuals open all at once:

1) The Tools guide.

2) The Reference guide, which the Tools guide points me at.

3) The Tuning guide, which the Reference guides points me at.

I think it would be a better user experience if I only had to consult one manual. For detailed
operation, I can see the value in consulting multiple manuals, but I think that the first
experience of this tool should be simple and straightforward. My gut feeling is that the Tuning
guide is the right place to start. I think it would be very helpful if the Tuning guide's
section titled "How you use the XPLAIN style" contained instructions and examples on how to
use PlanExporter to study the output of your statistics run.


> Adding documentation about the PlanExporter Tool
> ------------------------------------------------
>                 Key: DERBY-4758
>                 URL: https://issues.apache.org/jira/browse/DERBY-4758
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: C.S. Nirmal J. Fernando
>            Assignee: C.S. Nirmal J. Fernando
>            Priority: Critical
>         Attachments: DERBY-4592-3.zip, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758.stat,
DERBY-4758.zip, derby4758-2.diff, derby4758.diff
> Providing a user guide documentation in http://db.apache.org/derby/docs/10.6/tools/

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

View raw message