[jira] Updated: (DERBY-4065) Provide documentation for XPLAIN style statistics processing

["Bryan Pendleton (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DERBY-4065?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-4065:
-----------------------------------

    Attachment: userSchema.diff

Attached 'userSchema.diff' is a revised patch proposal for the documentation.

The changes are fairly minor compared to the previous patch proposals,
and mostly involve:
 - adjustments to describe that the captured statistics information is now
stored in ordinary database tables in a user-specified schema, rather than
in system catalogs.
 - adjustments to reflect the system procedure changes: SYSCS_RESET_XPLAIN_TABLES
no longer exists, and SYSCS_[GET,SET]_XPLAIN_STYLE has been renamed
to SYSCS_[GET,SET]_XPLAIN_SCHEMA
 - re-arrangement of the table documentation for the XPLAIN tables into its
own section of the reference manual
 - re-naming of the underlying DITA file names to make things easier on
my poor eyes and try to follow a more consistent naming convention.

It will take a while to make this documentation polished, and I think that we can do
a lot of that work in subsequent changes.

What I'd like to do at this point is address any major issues with the documentation
that need to be fixed prior to its initial commit into the docs trunk, then get the
initial version of the docs committed, and then incrementally improve the docs.

If anybody has time to review 'userSchema.diff', that would be much appreciated.


> Provide documentation for XPLAIN style statistics processing
> ------------------------------------------------------------
>
>                 Key: DERBY-4065
>                 URL: https://issues.apache.org/jira/browse/DERBY-4065
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: Bryan Pendleton
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: ctun_xplain_mode.html, ctun_xplain_mode.html, ctun_xplain_tables.html, earlyDraftDocs.diff, earlyDraftDocs.diff, earlyDraftDocs.diff, earlyDraftDocs.diff, rrefresetxplaintablesproc.html, rrefsetxplainmodeproc.html, rrefsetxplainstyleproc.html, rrefsyscsgetxplainmode.html, rrefsyscsgetxplainstyle.html, rrefsysxplain_resultset_timings.html, rrefsysxplain_resultsets.html, rrefsysxplain_resultsets.html, rrefsysxplain_scan_props.html, rrefsysxplain_scan_props.html, rrefsysxplain_sort_props.html, rrefsysxplain_statement_timings.html, rrefsysxplain_statements.html, rrefsysxplain_statements.html, userSchema.diff
>
>
> This sub-task of DERBY-2487 is for tracking the documentation of the new feature. I think
> it will be a little bit simpler to track the documentation changes in a separate issue.

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