You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org> on 2010/08/01 07:06:16 UTC
[jira] Created: (DERBY-4758) Adding documentation about the
PlanExporter Tool
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
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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Attachment: DERBY-4758.zip
derby4758.diff
Hi All,
Attaching a documentation diff and html & dita files as a zipped folder.
Highly appreciate your comments on this.
Thanks.
> 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-4758.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12916523#action_12916523 ]
Rick Hillegas commented on DERBY-4758:
--------------------------------------
We should add a disclaimer to the 10.7 docs, stating that the PlanExporter api and output are experimental and intended to elicit user feedback.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12897823#action_12897823 ]
Kim Haase commented on DERBY-4758:
----------------------------------
Committed patches derby-4758-3.diff and derby-4758-3a.diff to documentation trunk at revision 984851.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Issue & fix info: (was: [Patch Available])
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
[ 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.
Thanks,
-Rick
> 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Attachment: derby-4758-4.diff
ctoolsplanexp.html
Attaching derby-4758-4.diff, which adds a note to the introductory topic on PlanExporter. Comments welcome.
> 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
> Affects Versions: 10.6.1.0
> Reporter: C.S. Nirmal J. Fernando
> Assignee: C.S. Nirmal J. Fernando
> Priority: Critical
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Closed: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando closed DERBY-4758.
------------------------------------------
Resolution: Fixed
Fix Version/s: 10.7.1.0
> 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
> Fix For: 10.7.1.0
>
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12895942#action_12895942 ]
C.S. Nirmal J. Fernando commented on DERBY-4758:
------------------------------------------------
Hi Bryan,
Thanks for reviewing it and committing it.
Yeah, it would be nice to get a document on the XML format
as well, I'll try to work on that in near future.
> 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-4758.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896651#action_12896651 ]
Kim Haase commented on DERBY-4758:
----------------------------------
Thanks so much for the helpful answers and quick response, Nirmal.
There's no need for you to file an updated patch -- I am including your information in a patch I'll be filing, which incorporates your second patch and modifies the contents.
> 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-4758-2.zip, 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.
[jira] Issue Comment Edited: (DERBY-4758) Adding documentation
about the PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896588#action_12896588 ]
C.S. Nirmal J. Fernando edited comment on DERBY-4758 at 8/9/10 11:26 AM:
-------------------------------------------------------------------------
Hi Kim,
Thanks for looking into this.
>The syntax shows "[arguments]" in square brackets, which would normally indicate that the arguments are optional. However, I don't >see any indication of what the default behavior is if an argument is omitted. Does the tool automatically generate some form of output >with a default name, or do you in fact have to specify one or more of the >arguments described? If you do, there should be no >brackets around "arguments".
>(Actually, the correct term here would be "options", not arguments, since they start with a hyphen.)
You're absolutely correct! Tool need at least one option (-html or -xsl) in minimum. So brackets should be removed.
>In the argument syntax, there's currently no description of what "path" must be. I gather you can specify an absolute or relative path, >rather than just a filename in the current directory as with the -adv -xsl option. But to judge from the example, it seems the tool >appends the ".xml" or ".html" suffix to the root filename you specify. Is that true?
Actually path can be absolute or relative (Relative in the sense of the same directory but not sub directories). The tool appends ".xml" or ".html" suffix only if it is not present.
If you think it's better, if I can submit a modified patch adding your suggestions, please let me know.
Thanks.
was (Author: nirmal):
Hi Kim,
Thanks for looking into this.
>The syntax shows "[arguments]" in square brackets, which would normally indicate that the arguments are optional. However, I don't see any indication of what the default >behavior is if an argument is omitted. Does the tool automatically generate some form of output with a default name, or do you in fact have to specify one or more of the >arguments described? If you do, there should be no brackets around "arguments".
>(Actually, the correct term here would be "options", not arguments, since they start with a hyphen.)
You're absolutely correct! Tool need at least one option (-html or -xsl) in minimum. So brackets should be removed.
>In the argument syntax, there's currently no description of what "path" must be. I gather you can specify an absolute or relative path, rather than just a filename in the current >directory as with the -adv -xsl option. But to judge from the example, it seems the tool appends the ".xml" or ".html" suffix to the root filename you specify. Is that true?
Actually path can be absolute or relative (Relative in the sense of the same directory but not sub directories). The tool appends ".xml" or ".html" suffix only if it is not present.
If you think it's better, if I can submit a modified patch adding your suggestions, please let me know.
Thanks.
> 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-4758-2.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Attachment: (was: DERBY-4592-3.zip)
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Affects Version/s: 10.6.1.0
Issue & fix info: [Patch Available]
Priority: Major (was: Critical)
A few minor edits (patch available, priority, version affected).
> 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
> Affects Versions: 10.6.1.0
> Reporter: C.S. Nirmal J. Fernando
> Assignee: C.S. Nirmal J. Fernando
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Attachment: derby-4758-3a.diff
Realized that derby-4758-3.diff did not include the new file rtoolsplanexpxmlformat.dita. Attaching a supplementary patch that adds this file.
I am committing these patches so that future documentation can build on them.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896593#action_12896593 ]
Kim Haase commented on DERBY-4758:
----------------------------------
A few questions on the PlanExporter XML Format topic:
In some cases it's clear what row of a SYSXPLAIN table the topic is referring to, but in others it is not.
"The statement element ... This element has only its value. That value implies the query executed as mentioned in SYSXPLAIN_STATEMENTS table."
Is this the value from the STMT_TEXT row of the SYSXPLAIN_STATEMENTS table?
The attributes of the node element sometimes have the same name as the corresponding row of the SYSXPLAIN table, but in some cases they don't, so I want to make sure I know the right one:
visited_pages, from SYSXPLAIN_SCAN_PROPS -- is this NO_VISITED_PAGES?
scanned_object, from SYSXPLAIN_SCAN_PROPS -- is this SCAN_OBJECT_NAME?
scan_type, from SYSXPLAIN_SCAN_PROPS -- is this SCAN_OBJECT_TYPE?
sorter_output, from SYSXPLAIN_SORT_PROPS -- I can't tell what row this might refer to at all.
I'm thinking this bullet list should be a two-column table -- I'll work on that.
> 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-4758-2.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12898779#action_12898779 ]
C.S. Nirmal J. Fernando commented on DERBY-4758:
------------------------------------------------
Thanks Bryan!
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Attachment: derby-4758-3.zip
Darn! A slip of the finger. Attaching the correct zip file. Thanks, Rick, for catching this. Now can I delete the wrong one? Will work on this.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Issue & fix info: [Patch Available]
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Issue & fix info: [Patch Available]
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Issue & fix info: (was: [Patch Available])
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896901#action_12896901 ]
Rick Hillegas commented on DERBY-4758:
--------------------------------------
Hi Kim,
Did you intend to attach a different zip file? The attached DERBY-4592-3.zip seems to hold doc pages for a different issue. Thanks.
> 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Bryan Pendleton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12895941#action_12895941 ]
Bryan Pendleton commented on DERBY-4758:
----------------------------------------
Committed the documentation patch to the docs trunk as revision 982865.
> 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-4758.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Affects Version/s: (was: 10.6.1.0)
Issue & fix info: (was: [Patch Available])
> 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
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Attachment: derby-4758-3b.diff
Hi Kim,
Thanks for all the formatting you have done to the initial documentation.
Now, it's looking far nice!
Last few days I've modified some of the features of PlanExporter tool, so
I'm attaching patch 3b to address them.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12916910#action_12916910 ]
Kim Haase commented on DERBY-4758:
----------------------------------
Committed patch derby-4758-4.diff to documentation trunk at revision 1003560.
> 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
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Bryan Pendleton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12898708#action_12898708 ]
Bryan Pendleton commented on DERBY-4758:
----------------------------------------
Patch 3b looks good and builds successfully for me. Committed to the
Derby trunk as revision 985711.
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-4758:
-----------------------------
Attachment: derby-4758-3.diff
derby-4758.stat
DERBY-4592-3.zip
Attaching derby-4758-3.diff, derby-4758.stat, and derby-4758-3.zip, with changes to the following files:
A src/tools/rtoolsplanexpxmlformat.dita
M src/tools/ctoolsusingplanexp.dita
M src/tools/derbytools.ditamap
M src/tools/rtoolsplanexpexamples.dita
M src/tools/ctoolspre23947.dita
M src/tools/ctoolspre11181.dita
M src/tools/ctoolsplanexp.dita
src/tools/rtoolsplanexpxmlformat.dita is also added by patch derby-4758-2.diff -- this patch would make it unnecessary to commit that one.
The changes are mainly for formatting consistency and documentation style. I also added cross-references to the tool in a couple of introductory topics. I'm not sure whether it makes sense to refer to the tool in other manuals (reference or tuning, for example) or, if so, where; that can be left to a later patch if need be.
Please let me know if these changes have introduced any inaccuracies and if other changes are needed.
> 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896048#action_12896048 ]
C.S. Nirmal J. Fernando commented on DERBY-4758:
------------------------------------------------
Thanks Kim, for look into the documentation.
It's really nice to add new formatting features here.
> 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-4758.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Attachment: Derby-4758-3b.zip
> 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-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12916905#action_12916905 ]
Rick Hillegas commented on DERBY-4758:
--------------------------------------
Hi Kim,
Thanks for the patch. Looks good to me. I think this is sufficient to warn users that the behavior and api may change in future releases. +1
> 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
> Affects Versions: 10.6.1.0
> Reporter: C.S. Nirmal J. Fernando
> Assignee: C.S. Nirmal J. Fernando
> Attachments: ctoolsplanexp.html, DERBY-4758-2.zip, derby-4758-3.diff, derby-4758-3.zip, derby-4758-3a.diff, derby-4758-3b.diff, Derby-4758-3b.zip, derby-4758-4.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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896047#action_12896047 ]
Kim Haase commented on DERBY-4758:
----------------------------------
This is excellent documentation, Nirmal. It could use a few formatting and style tweaks, and should be linked to from some introductory topics. I'll file a suggested doc patch in the next day or two.
> 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-4758.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896574#action_12896574 ]
Kim Haase commented on DERBY-4758:
----------------------------------
Thanks for the additional documentation, Nirmal. I'll take a look at the formatting and style here too.
I have a couple of questions about the Using PlanExporter topic.
The syntax shows "[arguments]" in square brackets, which would normally indicate that the arguments are optional. However, I don't see any indication of what the default behavior is if an argument is omitted. Does the tool automatically generate some form of output with a default name, or do you in fact have to specify one or more of the arguments described? If you do, there should be no brackets around "arguments".
(Actually, the correct term here would be "options", not arguments, since they start with a hyphen.)
In the argument syntax, there's currently no description of what "path" must be. I gather you can specify an absolute or relative path, rather than just a filename in the current directory as with the -adv -xsl option. But to judge from the example, it seems the tool appends the ".xml" or ".html" suffix to the root filename you specify. Is that true?
Thanks!
> 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-4758-2.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896588#action_12896588 ]
C.S. Nirmal J. Fernando commented on DERBY-4758:
------------------------------------------------
Hi Kim,
Thanks for looking into this.
>The syntax shows "[arguments]" in square brackets, which would normally indicate that the arguments are optional. However, I don't see any indication of what the default >behavior is if an argument is omitted. Does the tool automatically generate some form of output with a default name, or do you in fact have to specify one or more of the >arguments described? If you do, there should be no brackets around "arguments".
>(Actually, the correct term here would be "options", not arguments, since they start with a hyphen.)
You're absolutely correct! Tool need at least one option (-html or -xsl) in minimum. So brackets should be removed.
>In the argument syntax, there's currently no description of what "path" must be. I gather you can specify an absolute or relative path, rather than just a filename in the current >directory as with the -adv -xsl option. But to judge from the example, it seems the tool appends the ".xml" or ".html" suffix to the root filename you specify. Is that true?
Actually path can be absolute or relative (Relative in the sense of the same directory but not sub directories). The tool appends ".xml" or ".html" suffix only if it is not present.
If you think it's better, if I can submit a modified patch adding your suggestions, please let me know.
Thanks.
> 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-4758-2.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12896601#action_12896601 ]
C.S. Nirmal J. Fernando commented on DERBY-4758:
------------------------------------------------
Hi Kim,
Ya, it's STMT_TEXT row of the SYSXPLAIN_STATEMENTS table.
>visited_pages, from SYSXPLAIN_SCAN_PROPS -- is this NO_VISITED_PAGES?
>scanned_object, from SYSXPLAIN_SCAN_PROPS -- is this SCAN_OBJECT_NAME?
You got these two right.
>scan_type, from SYSXPLAIN_SCAN_PROPS -- is this SCAN_OBJECT_TYPE?
It's SCAN_TYPE from SYSXPLAIN_SCAN_PROPS.
>sorter_output, from SYSXPLAIN_SORT_PROPS
It's NO_OUTPUT_ROWS of SYSXPLAIN_SORT_PROPS
Sorry for not being clear.
Thanks.
> 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-4758-2.zip, 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.
[jira] Commented: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "Bryan Pendleton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12895940#action_12895940 ]
Bryan Pendleton commented on DERBY-4758:
----------------------------------------
I think that the documentation that you have provided is very useful and
I am intending to commit it, as it will be of great help to users who are
learning how to use the PlanExporter tool.
At some point, I think that we should document the XML format that is
emitted by PlanExporter. But I think we can do that as a separate,
subsequent change, some time in the future.
> 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-4758.zip, 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.
[jira] Updated: (DERBY-4758) Adding documentation about the
PlanExporter Tool
Posted by "C.S. Nirmal J. Fernando (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/DERBY-4758?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
C.S. Nirmal J. Fernando updated DERBY-4758:
-------------------------------------------
Attachment: derby4758-2.diff
DERBY-4758-2.zip
Hi,
I'm attaching a documentation patch that contains a page
which describes the XML format outputted by the
PlanExporter tool.
Thanks.
> 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-4758-2.zip, 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.