Committed to the documentation trunk as revision 887826.
The added table looks great from the docs perspective.
Thanks Kim and Knut.
I like the suggestion to include the column descriptions into the
main documentation, as it seems very useful for users of the
SYSCS_DIAG.SPACE_TABLE funtion. I think that information goes
nicely into the SYSCS_DIAG page in the Reference guide, so attached
is a second version of the patch, and an updated version of the ref
guide page in HTML.
A codeblock can be either inside a paragraph or outside. So this is fine unless you feel the need to be totally consistent. Thanks, Bryan!
The patch looks good to me. I'm not sure if the codeblock section is supposed to be inside the p section, or if there should be a closing tag </p> right before the codeblock section, and an opening <p> rigth after it. The other occurrences of codeblock sections in that file do terminate the p section before starting the codeblock section.
I think it would be best not to have links to the javadoc because the URL may change and the content is not stable (the URL points to the development sources which may not match the version documented by the manual). It would be good, though, to capture the information from the javadoc in the reference manual. As far as I can see, only the javadoc documents the columns in the space table.
I'm uncertain about whether the pages in the doc set should contain direct references to the internal javadoc, so for now I simply added some text to the admin guide page showing how to use SPACE_TABLE to estimate the space
that could be reclaimed.
Is it reasonable for the doc pages to contain a direct XREF to
Reclassified as a documentation issue.
Sounds like a good way to resolve this issue. I agree that NUMFREEPAGES and ESTIMSPACESAVING give the information requested by the reporter.
I took a closer look at the output from SYSCS_DIAG.SPACE_TABLE, and I think it already
includes this information. See the references to NUMFREEPAGES and ESTIMSPACESAVING
in the description at
I tried running SYSCS_DIAG.SPACE_TABLE on a few sample tables, and it looks like
the output in these columns is legitimate.
So perhaps all that is needed here is to update the documentation for the compress
table discussion (http://db.apache.org/derby/docs/10.5/adminguide/cadminspace21579.html)
to provide some text suggesting that SPACE_TABLE can be used to estimate whether
a COMPRESS_TABLE is worth running?
Once such a technique is made available, here would be a good place in the documentation to describe it: