You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2011/04/29 19:35:39 UTC
svn commit: r1097897 [3/3] - /db/derby/docs/trunk/src/ref/
Modified: db/derby/docs/trunk/src/ref/rrefsqlj58560.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj58560.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj58560.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj58560.dita Fri Apr 29 17:35:37 2011
@@ -26,43 +26,46 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<table><title>Assignments allowed by <ph conref="../conrefs.dita#prod/productshortname"></ph></title>
-<desc>This table displays valid assignments between data types in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-A "Y" indicates that the assignment is valid.</desc>
-<tgroup cols="20">
-<colspec colname="colspec0" colwidth="350*"/>
-<colspec colname="colbool" colwidth="84*"/>
-<colspec colname="col2" colwidth="84*"/>
-<colspec colname="col3" colwidth="84*"/>
-<colspec colname="col4" colwidth="84*"/>
-<colspec colname="col5" colwidth="84*"/>
-<colspec colname="col6" colwidth="81*"/>
-<colspec colname="colspec1" colwidth="84*"/>
-<colspec colname="colspec9" colwidth="84*"/>
-<colspec colname="colspec8" colwidth="84*"/>
-<colspec colname="colspec7" colwidth="84*"/>
-<colspec colname="colspec6" colwidth="81*"/>
-<colspec colname="colspec5" colwidth="84*"/>
-<colspec colname="colspec4" colwidth="87*"/>
-<colspec colname="colspec3" colwidth="81*"/>
-<colspec colname="colspec2" colwidth="84*"/>
-<colspec colname="colspec10" colwidth="84*"/>
-<colspec colname="colspec13" colwidth="84*"/>
-<colspec colname="colspec12" colwidth="84*"/>
-<colspec colname="colspec11" colwidth="84*"/>
-<colspec colname="COLSPEC14" colwidth="84*"/>
-<colspec colname="colspec15" colwidth="84*"/>
+<section><p>The following table displays valid assignments between data types in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. A "Y" indicates that
+the assignment is valid.</p>
+<table>
+<title>Assignments allowed by
+<ph conref="../conrefs.dita#prod/productshortname"></ph></title>
+<tgroup cols="20" colsep="1" rowsep="1">
+<colspec colname="colspec0" colnum="1" colwidth="350*"/>
+<colspec colname="colbool" colnum="2" colwidth="84*"/>
+<colspec colname="col2" colnum="3" colwidth="84*"/>
+<colspec colname="col3" colnum="4" colwidth="84*"/>
+<colspec colname="col4" colnum="5" colwidth="84*"/>
+<colspec colname="col5" colnum="6" colwidth="84*"/>
+<colspec colname="col6" colnum="7" colwidth="81*"/>
+<colspec colname="colspec1" colnum="8" colwidth="84*"/>
+<colspec colname="colspec9" colnum="9" colwidth="84*"/>
+<colspec colname="colspec8" colnum="10" colwidth="84*"/>
+<colspec colname="colspec7" colnum="11" colwidth="84*"/>
+<colspec colname="colspec6" colnum="12" colwidth="81*"/>
+<colspec colname="colspec5" colnum="13" colwidth="84*"/>
+<colspec colname="colspec4" colnum="14" colwidth="87*"/>
+<colspec colname="colspec3" colnum="15" colwidth="81*"/>
+<colspec colname="colspec2" colnum="16" colwidth="84*"/>
+<colspec colname="colspec10" colnum="17" colwidth="84*"/>
+<colspec colname="colspec13" colnum="18" colwidth="84*"/>
+<colspec colname="colspec12" colnum="19" colwidth="84*"/>
+<colspec colname="colspec11" colnum="20" colwidth="84*"/>
+<colspec colname="COLSPEC14" colnum="21" colwidth="84*"/>
+<colspec colname="colspec15" colnum="22" colwidth="84*"/>
<thead>
-<row>
-<entry colname="colspec0" valign="top">Types</entry>
-<entry colname="col2" valign="top"> <lines>B
+<row valign="bottom">
+<entry colname="colspec0">Types</entry>
+<entry colname="col2"> <lines>B
O
O
L
E
A
N</lines></entry>
-<entry colname="col2" valign="top"> <lines>S
+<entry colname="col2"> <lines>S
M
A
L
@@ -70,53 +73,53 @@ L
I
N
T</lines></entry>
-<entry colname="col3" valign="top"> <lines>I
+<entry colname="col3"> <lines>I
N
T
E
G
E
R</lines></entry>
-<entry colname="col4" valign="top"> <lines>B
+<entry colname="col4"> <lines>B
I
G
I
N
T</lines></entry>
-<entry colname="col5" valign="top"> <lines>D
+<entry colname="col5"> <lines>D
E
C
I
M
A
L</lines></entry>
-<entry colname="col6" valign="top"> <lines>R
+<entry colname="col6"> <lines>R
E
A
L</lines></entry>
-<entry colname="colspec1" valign="top"> <lines>D
+<entry colname="colspec1"> <lines>D
O
U
B
L
E</lines></entry>
-<entry colname="colspec9" valign="top"> <lines>F
+<entry colname="colspec9"> <lines>F
L
O
A
T</lines></entry>
-<entry colname="colspec8" valign="top"> <lines>C
+<entry colname="colspec8"> <lines>C
H
A
R</lines></entry>
-<entry colname="colspec7" valign="top"> <lines>V
+<entry colname="colspec7"> <lines>V
A
R
C
H
A
R</lines></entry>
-<entry colname="colspec6" valign="top"> <lines>L
+<entry colname="colspec6"> <lines>L
O
N
G
@@ -128,7 +131,7 @@ C
H
A
R</lines></entry>
-<entry colname="colspec5" valign="top"> <lines>C
+<entry colname="colspec5"> <lines>C
H
A
R
@@ -145,7 +148,7 @@ D
A
T
A</lines></entry>
-<entry colname="colspec4" valign="top"> <lines>V
+<entry colname="colspec4"> <lines>V
A
R
C
@@ -165,7 +168,7 @@ D
A
T
A</lines></entry>
-<entry colname="colspec3" valign="top"> <lines>L
+<entry colname="colspec3"> <lines>L
O
N
G
@@ -190,23 +193,23 @@ D
A
T
A</lines></entry>
-<entry colname="colspec2" valign="top"> <lines>C
+<entry colname="colspec2"> <lines>C
L
O
B</lines></entry>
-<entry colname="colspec10" valign="top"> <lines>B
+<entry colname="colspec10"> <lines>B
L
O
B</lines></entry>
-<entry colname="colspec13" valign="top"> <lines>D
+<entry colname="colspec13"> <lines>D
A
T
E</lines></entry>
-<entry colname="colspec12" valign="top"> <lines>T
+<entry colname="colspec12"> <lines>T
I
M
E</lines></entry>
-<entry colname="colspec11" valign="top"> <lines>T
+<entry colname="colspec11"> <lines>T
I
M
E
@@ -215,10 +218,10 @@ T
A
M
P</lines></entry>
-<entry colname="COLSPEC14" valign="top"> <lines>X
+<entry colname="COLSPEC14"> <lines>X
M
L</lines></entry>
-<entry colname="colspec15" valign="top"> <lines>U
+<entry colname="colspec15"> <lines>U
s
e
r
@@ -745,46 +748,48 @@ e</lines></entry>
</tbody>
</tgroup>
</table>
-<section><p>A value of a user-defined type can be assigned to a value of any supertype of
+<p>A value of a user-defined type can be assigned to a value of any supertype of
that user-defined type. However, no explicit casts of user-defined types are
-allowed.</p></section>
-<table><title>Comparisons allowed by Derby</title><desc>This table displays
-valid comparisons between data types in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
-A "Y" indicates that the comparison is allowed.</desc>
-<tgroup cols="20">
-<colspec colname="colspec0" colwidth="350*"/>
-<colspec colname="colbool" colwidth="83*"/>
-<colspec colname="col2" colwidth="83*"/>
-<colspec colname="col3" colwidth="83*"/>
-<colspec colname="col4" colwidth="83*"/>
-<colspec colname="col5" colwidth="83*"/>
-<colspec colname="col6" colwidth="80*"/>
-<colspec colname="colspec1" colwidth="83*"/>
-<colspec colname="colspec9" colwidth="83*"/>
-<colspec colname="colspec8" colwidth="83*"/>
-<colspec colname="colspec7" colwidth="83*"/>
-<colspec colname="colspec6" colwidth="80*"/>
-<colspec colname="colspec5" colwidth="83*"/>
-<colspec colname="colspec4" colwidth="86*"/>
-<colspec colname="colspec3" colwidth="80*"/>
-<colspec colname="colspec2" colwidth="83*"/>
-<colspec colname="colspec10" colwidth="83*"/>
-<colspec colname="colspec13" colwidth="75*"/>
-<colspec colname="colspec12" colwidth="89*"/>
-<colspec colname="colspec11" colwidth="89*"/>
-<colspec colname="COLSPEC15" colwidth="89*"/>
-<colspec colname="colspec14" colwidth="80*"/>
+allowed.</p>
+<p>The following table displays valid comparisons between data types in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. A "Y" indicates that
+the comparison is allowed.</p>
+<table>
+<title>Comparisons allowed by Derby</title>
+<tgroup cols="20" colsep="1" rowsep="1">
+<colspec colname="colspec0" colnum="1" colwidth="350*"/>
+<colspec colname="colbool" colnum="2" colwidth="83*"/>
+<colspec colname="col2" colnum="3" colwidth="83*"/>
+<colspec colname="col3" colnum="4" colwidth="83*"/>
+<colspec colname="col4" colnum="5" colwidth="83*"/>
+<colspec colname="col5" colnum="6" colwidth="83*"/>
+<colspec colname="col6" colnum="7" colwidth="80*"/>
+<colspec colname="colspec1" colnum="8" colwidth="83*"/>
+<colspec colname="colspec9" colnum="9" colwidth="83*"/>
+<colspec colname="colspec8" colnum="10" colwidth="83*"/>
+<colspec colname="colspec7" colnum="11" colwidth="83*"/>
+<colspec colname="colspec6" colnum="12" colwidth="80*"/>
+<colspec colname="colspec5" colnum="13" colwidth="83*"/>
+<colspec colname="colspec4" colnum="14" colwidth="86*"/>
+<colspec colname="colspec3" colnum="15" colwidth="80*"/>
+<colspec colname="colspec2" colnum="16" colwidth="83*"/>
+<colspec colname="colspec10" colnum="17" colwidth="83*"/>
+<colspec colname="colspec13" colnum="18" colwidth="75*"/>
+<colspec colname="colspec12" colnum="19" colwidth="89*"/>
+<colspec colname="colspec11" colnum="20" colwidth="89*"/>
+<colspec colname="COLSPEC15" colnum="21" colwidth="89*"/>
+<colspec colname="colspec14" colnum="22" colwidth="80*"/>
<thead>
-<row>
-<entry colname="colspec0" valign="top">Types</entry>
-<entry colname="col2" valign="top"> <lines>B
+<row valign="bottom">
+<entry colname="colspec0">Types</entry>
+<entry colname="col2"> <lines>B
O
O
L
E
A
N</lines></entry>
-<entry colname="col2" valign="top"> <lines>S
+<entry colname="col2"> <lines>S
M
A
L
@@ -792,53 +797,53 @@ L
I
N
T</lines></entry>
-<entry colname="col3" valign="top"> <lines>I
+<entry colname="col3"> <lines>I
N
T
E
G
E
R</lines></entry>
-<entry colname="col4" valign="top"> <lines>B
+<entry colname="col4"> <lines>B
I
G
I
N
T</lines></entry>
-<entry colname="col5" valign="top"> <lines>D
+<entry colname="col5"> <lines>D
E
C
I
M
A
L</lines></entry>
-<entry colname="col6" valign="top"> <lines>R
+<entry colname="col6"> <lines>R
E
A
L</lines></entry>
-<entry colname="colspec1" valign="top"> <lines>D
+<entry colname="colspec1"> <lines>D
O
U
B
L
E</lines></entry>
-<entry colname="colspec9" valign="top"> <lines>F
+<entry colname="colspec9"> <lines>F
L
O
A
T</lines></entry>
-<entry colname="colspec8" valign="top"> <lines>C
+<entry colname="colspec8"> <lines>C
H
A
R</lines></entry>
-<entry colname="colspec7" valign="top"> <lines>V
+<entry colname="colspec7"> <lines>V
A
R
C
H
A
R</lines></entry>
-<entry colname="colspec6" valign="top"> <lines>L
+<entry colname="colspec6"> <lines>L
O
N
G
@@ -850,7 +855,7 @@ C
H
A
R</lines></entry>
-<entry colname="colspec5" valign="top"> <lines>C
+<entry colname="colspec5"> <lines>C
H
A
R
@@ -867,7 +872,7 @@ D
A
T
A</lines></entry>
-<entry colname="colspec4" valign="top"> <lines>V
+<entry colname="colspec4"> <lines>V
A
R
C
@@ -887,7 +892,7 @@ D
A
T
A</lines></entry>
-<entry colname="colspec3" valign="top"> <lines>L
+<entry colname="colspec3"> <lines>L
O
N
G
@@ -912,23 +917,23 @@ D
A
T
A</lines></entry>
-<entry colname="colspec2" valign="top"> <lines>C
+<entry colname="colspec2"> <lines>C
L
O
B</lines></entry>
-<entry colname="colspec10" valign="top"> <lines>B
+<entry colname="colspec10"> <lines>B
L
O
B</lines></entry>
-<entry colname="colspec13" valign="top"> <lines>D
+<entry colname="colspec13"> <lines>D
A
T
E</lines></entry>
-<entry colname="colspec12" valign="top"> <lines>T
+<entry colname="colspec12"> <lines>T
I
M
E</lines></entry>
-<entry colname="colspec11" valign="top"> <lines>T
+<entry colname="colspec11"> <lines>T
I
M
E
@@ -937,10 +942,10 @@ T
A
M
P</lines></entry>
-<entry colname="COLSPEC15" valign="top"> <lines>X
+<entry colname="COLSPEC15"> <lines>X
M
L</lines></entry>
-<entry colname="colspec14" valign="top"> <lines>U
+<entry colname="colspec14"> <lines>U
s
e
r
@@ -1467,5 +1472,6 @@ e</lines></entry>
</tbody>
</tgroup>
</table>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsqlj75638.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqlj75638.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqlj75638.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqlj75638.dita Fri Apr 29 17:35:37 2011
@@ -25,14 +25,21 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The following is a list of supported territories:</p></section>
-<section><p> <table>
-<tgroup cols="2"><colspec colname="col1"/><colspec colname="col2"/>
+<section><p>The following table lists the territories supported by
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. Use the
+<i><xref href="rrefattrib56769.dita#rrefattrib56769">territory=ll_CC</xref></i>
+URL attribute to set the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> territory.</p>
+<table>
+<title>Supported territories</title>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="col1" colnum="1" colwidth="50*"/>
+<colspec colname="col2" colnum="2" colwidth="50*"/>
<thead>
-<row>
-<entry colname="col1" valign="top">Territory</entry>
-<entry colname="col2" valign="top"><ph conref="../conrefs.dita#prod/productshortname"></ph> territory
-setting (derby.territory)</entry>
+<row valign="bottom">
+<entry colname="col1">Territory</entry>
+<entry colname="col2"><ph conref="../conrefs.dita#prod/productshortname"></ph>
+Territory Setting</entry>
</row>
</thead>
<tbody>
@@ -90,7 +97,6 @@ setting (derby.territory)</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefsqljargmatching.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqljargmatching.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqljargmatching.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsqljargmatching.dita Fri Apr 29 17:35:37 2011
@@ -148,25 +148,23 @@ an exception if it found more than one m
<section><title>Mapping SQL data types to Java data types</title>
-<p>
-The following table shows how
+<p>The following table shows how
<ph conref="../conrefs.dita#prod/productshortname"></ph> maps specific SQL data
-types to Java data types:
-</p>
+types to Java data types.</p>
<table>
<title>SQL and Java type correspondence</title>
-<tgroup cols="3">
-<colspec colname="sqltype" colwidth="330*"/>
-<colspec colname="primitive" colwidth="330*"/>
-<colspec colname="wrapper" colwidth="330*"/>
+<tgroup cols="3" colsep="1" rowsep="1">
+<colspec colname="sqltype" colnum="1" colwidth="33*"/>
+<colspec colname="primitive" colnum="2" colwidth="33*"/>
+<colspec colname="wrapper" colnum="3" colwidth="34*"/>
<thead>
- <row>
- <entry colname="sqltype" valign="top">SQL type</entry>
- <entry colname="primitive" valign="top">Primitive match</entry>
- <entry colname="wrapper" valign="top">Wrapper match</entry>
+ <row valign="bottom">
+ <entry colname="sqltype">SQL Type</entry>
+ <entry colname="primitive">Primitive Match</entry>
+ <entry colname="wrapper">Wrapper Match</entry>
</row>
</thead>
Modified: db/derby/docs/trunk/src/ref/rrefstringlimits.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefstringlimits.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefstringlimits.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefstringlimits.dita Fri Apr 29 17:35:37 2011
@@ -20,20 +20,28 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefstringlimits" xml:lang="en-us">
<title>String limitations</title>
+<prolog><metadata>
+<keywords><indexterm>limitations<indexterm>string values</indexterm></indexterm>
+<indexterm>string values<indexterm>limitations</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<refbody>
-<table frame="all"><title>String limitations</title><desc>The following table
-contains limitations on string values in <ph conref="../conrefs.dita#prod/productshortname"></ph>.</desc>
-<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="colspec0" colwidth="228*"/>
-<colspec colname="colspec1" colwidth="228*"/>
+<section><p>The following table lists limitations on string values in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<table frame="all">
+<title>String limitations</title>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="colspec0" colnum="1" colwidth="50*"/>
+<colspec colname="colspec1" colnum="2" colwidth="50*"/>
<thead>
-<row>
-<entry align="left" valign="top">Value</entry>
-<entry align="left" colname="colspec1" valign="top">Maximum Limit</entry>
+<row valign="bottom">
+<entry colname="colspec0">Value</entry>
+<entry colname="colspec1">Maximum Limit</entry>
</row>
</thead>
<tbody>
<row>
-<entry colname="colspec0">Length of CHAR </entry>
+<entry colname="colspec0">Length of CHAR</entry>
<entry colname="colspec1">254 characters</entry>
</row>
<row>
@@ -75,6 +83,7 @@ contains limitations on string values in
</tbody>
</tgroup>
</table>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita Fri Apr 29 17:35:37 2011
@@ -55,14 +55,18 @@ Diagnostic table functions can accept ze
the table function that you use. You must use the SQL-defined table function
syntax to access these functions.</dd>
</dlentry></dl> </p><p>The following table shows the types and names of the
-diagnostic table expressions in <ph conref="../conrefs.dita#prod/productshortname"></ph>. </p><table>
-<title>System diagnostic table expressions provided by <ph conref="../conrefs.dita#prod/productshortname"></ph></title>
-<tgroup cols="2"><colspec colname="col1" colwidth="50*"/><colspec colname="col2"
-colwidth="49*"/>
+diagnostic table expressions in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p>
+<table>
+<title>System diagnostic table expressions provided by
+<ph conref="../conrefs.dita#prod/productshortname"></ph></title>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="col1" colnum="1" colwidth="60*"/>
+<colspec colname="col2" colnum="2" colwidth="40*"/>
<thead>
<row valign="bottom">
-<entry colname="col1">Diagnostic table expression</entry>
-<entry colname="col2">Type of expression</entry>
+<entry colname="col1">Diagnostic Table Expression</entry>
+<entry colname="col2">Type of Expression</entry>
</row>
</thead>
<tbody>
@@ -168,22 +172,22 @@ the SQL table function syntax. This diag
the <parmname>schemaName</parmname> and the <parmname>tableName</parmname>.
The <parmname>tableName</parmname> argument is required. If you do not specify
the <parmname>schemaName</parmname>, the current schema is used. </p>
-<p>
-The returned table has the following columns:
-<table pgwide="1" frame="all">
- <tgroup cols="5" colsep="1" rowsep="1">
- <colspec colname="1" colnum="1" colwidth="2784*"/>
- <colspec colname="2" colnum="2" colwidth="2185*"/>
- <colspec colname="3" colnum="3" colwidth="814*"/>
- <colspec colname="4" colnum="4" colwidth="1003*"/>
- <colspec colname="5" colnum="5" colwidth="2902*"/>
+<p>The returned table has the columns shown in the following table.</p>
+<table frame="all">
+<title>Columns returned by the SYSCS_DIAG.SPACE_TABLE function</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -197,48 +201,48 @@ The returned table has the following col
<row>
<entry colname="1">ISINDEX</entry>
<entry colname="2">SMALLINT</entry>
-<entry colname="3"></entry>
+<entry colname="3">5</entry>
<entry colname="4">false</entry>
<entry colname="5">Is not zero if the conglomerate is an index, 0 otherwise.</entry>
</row>
<row>
<entry colname="1">NUMALLOCATEDPAGES</entry>
<entry colname="2">BIGINT</entry>
-<entry colname="3"></entry>
+<entry colname="3">19</entry>
<entry colname="4">false</entry>
<entry colname="5">The number of pages actively linked into the table. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
</row>
<row>
<entry colname="1">NUMFREEPAGES</entry>
<entry colname="2">BIGINT</entry>
-<entry colname="3"></entry>
+<entry colname="3">19</entry>
<entry colname="4">false</entry>
<entry colname="5">The number of free pages that belong to the table. When a new page is to be linked into the table the system will move a page from the NUMFREEPAGES list to the NUMALLOCATEDPAGES list. The total number of pages in the file is the sum of NUMALLOCATEDPAGES + NUMFREEPAGES.</entry>
</row>
<row>
<entry colname="1">NUMUNFILLEDPAGES</entry>
<entry colname="2">BIGINT</entry>
-<entry colname="3"></entry>
+<entry colname="3">19</entry>
<entry colname="4">false</entry>
<entry colname="5">The number of unfilled pages that belong to the table. Unfilled pages are allocated pages that are not completely full. Note that the number of unfilled pages is an estimate and is not exact. Running the same query twice can give different results on this column.</entry>
</row>
<row>
<entry colname="1">PAGESIZE</entry>
<entry colname="2">INTEGER</entry>
-<entry colname="3"></entry>
+<entry colname="3">10</entry>
<entry colname="4">false</entry>
<entry colname="5">The size of the page in bytes for that conglomerate.</entry>
</row>
<row>
<entry colname="1">ESTIMSPACESAVING</entry>
<entry colname="2">BIGINT</entry>
-<entry colname="3"></entry>
+<entry colname="3">19</entry>
<entry colname="4">false</entry>
<entry colname="5">The estimated space which could possibly be saved by compressing the conglomerate, in bytes.</entry>
</row>
- </tbody>
- </tgroup>
- </table></p>
+</tbody>
+</tgroup>
+</table>
<p>For
example, use the following query to return the space usage for all of the
user tables and indexes in the database: <codeblock>SELECT T2.*
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_resultset_timings.dita Fri Apr 29 17:35:37 2011
@@ -20,52 +20,54 @@ limitations under the License.
-->
<reference id="rrefsysxplain_resultset_timings" xml:lang="en-us">
<title>SYSXPLAIN_RESULTSET_TIMINGS system table</title>
+<shortdesc>The SYSXPLAIN_RESULTSET_TIMINGS table captures timing information
+about result set accesses which occurred during statements that were executed
+using RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_RESULTSET_TIMINGS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_RESULTSET_TIMINGS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_RESULTSET_TIMINGS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures timing information about result set accesses
- which occurred during statements that were
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.
Note that statistics timing must be configured by calling
- SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING().
+ SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING(1).
Each row in this table describes various timing information
for this particular result set in this particular statement.
Rows in this table are typically joined with rows in
SYSXPLAIN_STATEMENTS and SYSXPLAIN_RESULTSETS during analysis.
For example:</p>
- <codeblock>
- select rs.op_identifier, rst.execute_time
- from my_stats.sysxplain_resultsets rs,
- my_stats.sysxplain_resultset_timings rst
- where rs.stmt_id = ? and
- rs.timing_id = rst.timing_id
- order by rst.execute_time desc
- </codeblock>
+<codeblock>select rs.op_identifier, rst.execute_time
+ from my_stats.sysxplain_resultsets rs,
+ my_stats.sysxplain_resultset_timings rst
+ where rs.stmt_id = ? and
+ rs.timing_id = rst.timing_id
+ order by rst.execute_time desc</codeblock>
<p>Rows in this table are added
automatically when
<ph conref="../conrefs.dita#prod/productshortname"></ph>
has been configured appropriately. The
rows remain in the table until you delete them or drop the table.
</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
- <p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+<p>The following table shows the contents of the SYSXPLAIN_RESULTSET_TIMINGS
+system table.</p>
+<table>
+<title>SYSXPLAIN_RESULTSET_TIMINGS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -120,8 +122,7 @@ set, in milliseconds.</entry>
<entry colname="4">true</entry>
<entry colname="5">The time for all operations performed by this
result set, excluding the time taken by all the children result sets of
- this result set, in milliseconds.
-</entry>
+ this result set, in milliseconds.</entry>
</row>
<row>
<entry colname="1">AVG_NEXT_TIME_PER_ROW</entry>
@@ -175,6 +176,6 @@ milliseconds.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_resultsets.dita Fri Apr 29 17:35:37 2011
@@ -20,13 +20,18 @@ limitations under the License.
-->
<reference id="rrefsysxplain_resultsets" xml:lang="en-us">
<title>SYSXPLAIN_RESULTSETS system table</title>
+<shortdesc>The SYSXPLAIN_RESULTSETS table captures information about each
+result set which is part of a statement that has been executed using
+RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_RESULTSETS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_RESULTSETS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_RESULTSETS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures information about each result set which
- is part of a statement that has been
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.
</p>
<p>
Most statements have at least one result set associated with
@@ -39,36 +44,33 @@ limitations under the License.
by a particular statement. Rows
in this table are typically joined with rows in
SYSXPLAIN_STATEMENTS during analysis:</p>
- <codeblock>
- select st.stmt_text, rs.op_identifier
- from my_stats.sysxplain_statements st
- join my_stats.sysxplain_resultsets rs
- on st.stmt_id = rs.stmt_id
- </codeblock>
+<codeblock>select st.stmt_text, rs.op_identifier
+ from my_stats.sysxplain_statements st
+ join my_stats.sysxplain_resultsets rs
+ on st.stmt_id = rs.stmt_id</codeblock>
<p>Rows in this table are added
automatically when
<ph conref="../conrefs.dita#prod/productshortname"></ph>
has been configured appropriately. The
rows remain in the table until you delete them or drop the table.
</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
- <p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+<p>The following table shows the contents of the SYSXPLAIN_RESULTSETS system
+table.</p>
+<table>
+<title>SYSXPLAIN_RESULTSETS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -115,8 +117,7 @@ execution of the containing statement.</
<entry colname="5">The number of index updates performed by this
result set. This value is NULL for result sets used by queries, but may have
a non-zero value for modification statements such as INSERT, UPDATE, or
- DELETE.
-</entry>
+ DELETE.</entry>
</row>
<row>
<entry colname="1">LOCK_MODE</entry>
@@ -124,10 +125,10 @@ execution of the containing statement.</
<entry colname="3">2</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating the locking level that was used
- for this result set, as follows: 'EX'=Exclusive table-level locking,
- 'SH'=Share table-level locking, 'IX'=Exclusive row-level locking,
- 'IS'=Share row-level locking.
-</entry>
+ for this result set: <i>'EX'</i> for exclusive table-level locking,
+<i>'SH'</i> for share table-level locking,
+<i>'IX</i>' for exclusive row-level locking, or
+<i>'IS'</i> for share row-level locking.</entry>
</row>
<row>
<entry colname="1">LOCK_GRANULARITY</entry>
@@ -135,8 +136,8 @@ execution of the containing statement.</
<entry colname="3">1</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating the locking granularity that
- was used for this result set, as follows: 'T'=Table-level locking,
-'R'=Row-level locking.</entry>
+ was used for this result set: <i>'T'</i> for table-level locking, or
+<i>'R'</i> for row-level locking.</entry>
</row>
<row>
<entry colname="1">PARENT_RS_ID</entry>
@@ -159,8 +160,7 @@ together.</entry>
<entry colname="3">52</entry>
<entry colname="4">true</entry>
<entry colname="5">The optimizer's estimate of the total number of rows
- for this result set.
-</entry>
+ for this result set.</entry>
</row>
<row>
<entry colname="1">EST_COST</entry>
@@ -169,15 +169,14 @@ together.</entry>
<entry colname="4">true</entry>
<entry colname="5">The optimizer's estimated cost for this result set.
The value indicates the number of milliseconds that the optimizer
- estimates it will take to process this result set.
-</entry>
+ estimates it will take to process this result set.</entry>
</row>
<row>
<entry colname="1">AFFECTED_ROWS</entry>
<entry colname="2">INTEGER</entry>
<entry colname="3">10</entry>
<entry colname="4">true</entry>
-<entry colname="5">This column is only non-null for INSERT, UPDATE, and
+<entry colname="5">This column is non-null only for INSERT, UPDATE, and
DELETE result sets. For those result sets, this column holds the number of
rows which were inserted, updated, or deleted, respectively.</entry>
</row>
@@ -186,12 +185,11 @@ rows which were inserted, updated, or de
<entry colname="2">CHAR</entry>
<entry colname="3">1</entry>
<entry colname="4">true</entry>
-<entry colname="5">The column is only non-null for INSERT, UPDATE, and
- DELETE result sets. For those result sets, this column holds 'Y' if the
- INSERT/UPDATE/DELETE is being performed using deferred change semantics,
- and holds 'N' otherwise. Deferred change semantics are used
- when self-referencing is taking place.
-</entry>
+<entry colname="5">This column is only non-null for INSERT, UPDATE, and
+ DELETE result sets. For those result sets, this column holds <i>'Y'</i> if
+ the INSERT/UPDATE/DELETE is being performed using deferred change semantics,
+ and holds <i>'N'</i> otherwise. Deferred change semantics are used
+ when self-referencing is taking place.</entry>
</row>
<row>
<entry colname="1">INPUT_ROWS</entry>
@@ -210,8 +208,7 @@ result set, and thus were sorted by the
<entry colname="5">For join and set nodes, this is the number of rows
seen by the "left" side of the processing. For aggregate, group, sort,
normalize, materialize, and certain other nodes, this is the number of
- rows seen.
-</entry>
+ rows seen.</entry>
</row>
<row>
<entry colname="1">SEEN_ROWS_RIGHT</entry>
@@ -220,11 +217,13 @@ result set, and thus were sorted by the
<entry colname="4">true</entry>
<entry colname="5">For join and set nodes, this is the number of rows
seen by the "right" side of the processing. For example, in the statement
- <codeblock>
- select country from countries where region = 'Central America'
- union
- select country from countries where region = 'Africa'
-</codeblock>, the UNION result set has SEEN_ROWS = 6 and SEEN_ROWS_RIGHT=19.
+<codeblock>select country
+ from countries
+union
+select country
+ from countries
+ where region = 'Africa'</codeblock>
+the UNION result set has SEEN_ROWS = 6 and SEEN_ROWS_RIGHT = 19.
</entry>
</row>
<row>
@@ -264,9 +263,8 @@ existing rows met the join criteria.</en
a query references the MAX or MIN value of a column which happens to have an
index, and so the MIN or MAX computation can be performed by fetching the
first or last, respectively, entry in the index, as in:
- <codeblock>
- select max(country_iso_code) from countries
-</codeblock></entry>
+<codeblock>select max(country_iso_code)
+ from countries</codeblock></entry>
</row>
<row>
<entry colname="1">SCAN_RS_ID</entry>
@@ -295,7 +293,7 @@ ORDER BY and GROUP BY clauses.</entry>
<entry colname="2">CHAR</entry>
<entry colname="3">36</entry>
<entry colname="4">false</entry>
-<entry colname="5">This column will contain the id value which identifies
+<entry colname="5">This column will contain the ID value which identifies
the particular statement for which this result set was executed. Note that
there may be multiple result sets executed for a single statement, so a join
between the SYSXPLAIN_STATEMENTS table and the SYSXPLAIN_RESULTSETS table
@@ -314,6 +312,6 @@ for this resultset.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_scan_props.dita Fri Apr 29 17:35:37 2011
@@ -20,51 +20,53 @@ limitations under the License.
-->
<reference id="rrefsysxplain_scan_props" xml:lang="en-us">
<title>SYSXPLAIN_SCAN_PROPS system table</title>
+<shortdesc>The SYSXPLAIN_SCAN_PROPS table captures information about table/index
+accesses which occurred during statements that were executed using
+RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_SCAN_PROPS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_SCAN_PROPS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_SCAN_PROPS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures information about table/index access
- which occurred during statements that were
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
- Each row in this table describes a single table/index scan for
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.</p>
+<p>Each row in this table describes a single table/index scan for
a particular result set used by a particular statement. Rows
in this table are typically joined with rows in
SYSXPLAIN_STATEMENTS and SYSXPLAIN_RESULTSETS during analysis:</p>
- <codeblock>
- select st.stmt_text, sp.no_visited_rows
- from my_stats.sysxplain_scan_props sp,
- my_stats.sysxplain_resultsets rs,
- my_stats.sysxplain_statements st
- where st.stmt_id = rs.stmt_id and
- rs.scan_rs_id = sp.scan_rs_id and
- rs.op_identifier = 'TABLESCAN' and
- sp.scan_object_name = 'COUNTRIES'
- </codeblock>
+<codeblock>select st.stmt_text, sp.no_visited_rows
+ from my_stats.sysxplain_scan_props sp,
+ my_stats.sysxplain_resultsets rs,
+ my_stats.sysxplain_statements st
+ where st.stmt_id = rs.stmt_id and
+ rs.scan_rs_id = sp.scan_rs_id and
+ rs.op_identifier = 'TABLESCAN' and
+ sp.scan_object_name = 'COUNTRIES'</codeblock>
<p>Rows in this table are added
automatically when
<ph conref="../conrefs.dita#prod/productshortname"></ph>
has been configured appropriately. The
rows remain in the table until you delete them or drop the table.
</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
- <p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+<p>The following table shows the contents of the SYSXPLAIN_SCAN_PROPS system
+table.</p>
+<table>
+<title>SYSXPLAIN_SCAN_PROPS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -74,7 +76,7 @@ colnum="5" colwidth="29*"/>
<entry colname="3">36</entry>
<entry colname="4">false</entry>
<entry colname="5">A unique identifer for this particular row. Referenced
-by the foreign key SCAN_RS_ID in SYSXPLAIN_RESULTSETS</entry>
+by the foreign key SCAN_RS_ID in SYSXPLAIN_RESULTSETS.</entry>
</row>
<row>
<entry colname="1">SCAN_OBJECT_NAME</entry>
@@ -86,8 +88,8 @@ by the foreign key SCAN_RS_ID in SYSXPLA
If this is a scan of the internal index created for a constraint, the
constraint name appears here.
For complex join queries, the object being scanned may be an intermediate
- result, in which case a description such as 'Temporary HashTable' appears.
-</entry>
+ result, in which case a description such as <i>'Temporary HashTable'</i>
+ appears.</entry>
</row>
<row>
<entry colname="1">SCAN_OBJECT_TYPE</entry>
@@ -95,7 +97,8 @@ by the foreign key SCAN_RS_ID in SYSXPLA
<entry colname="3">1</entry>
<entry colname="4">false</entry>
<entry colname="5">A code indicating the type of object being scanned.
-Codes include 'T' for Table, 'I' for Index, and 'C' for Constraint.</entry>
+Codes include <i>'T'</i> for Table, <i>'I'</i> for Index, and <i>'C'</i> for
+Constraint.</entry>
</row>
<row>
<entry colname="1">SCAN_TYPE</entry>
@@ -103,7 +106,7 @@ Codes include 'T' for Table, 'I' for Ind
<entry colname="3">8</entry>
<entry colname="4">false</entry>
<entry colname="5">The type of scan being performed. Scan types include
-'HEAP', 'BTREE', and 'SORT'.</entry>
+<i>'HEAP'</i>, <i>'BTREE'</i>, and <i>'SORT'</i>.</entry>
</row>
<row>
<entry colname="1">ISOLATION_LEVEL</entry>
@@ -111,9 +114,9 @@ Codes include 'T' for Table, 'I' for Ind
<entry colname="3">3</entry>
<entry colname="4">true</entry>
<entry colname="5">The isolation level being used for this scan.
- Isolation levels are identified by a code: 'RU' for Read Uncommitted,
- 'RC' for Read Committed, 'RR' for Repeatable Read,
- and 'SE' for Serializable.</entry>
+ Isolation levels are identified by a code: <i>'RU'</i> for Read Uncommitted,
+ <i>'RC'</i> for Read Committed, <i>'RR'</i> for Repeatable Read,
+ and <i>'SE'</i> for Serializable.</entry>
</row>
<row>
<entry colname="1">NO_VISITED_PAGES</entry>
@@ -153,14 +156,16 @@ scan which were found to be rows that we
<entry colname="2">INTEGER</entry>
<entry colname="3">10</entry>
<entry colname="4">true</entry>
-<entry colname="5">Number of columns that were fetched from each qualifying row.</entry>
+<entry colname="5">Number of columns that were fetched from each qualifying
+row.</entry>
</row>
<row>
<entry colname="1">BITSET_OF_FETCHED_COLUMNS</entry>
<entry colname="2">VARCHAR</entry>
<entry colname="3">32,672</entry>
<entry colname="4">true</entry>
-<entry colname="5">Description of the columns which were fetched from each qualifying row.</entry>
+<entry colname="5">Description of the columns which were fetched from each
+qualifying row.</entry>
</row>
<row>
<entry colname="1">BTREE_HEIGHT</entry>
@@ -173,8 +178,7 @@ scan which were found to be rows that we
with one page has a height of 1. Total number of pages visited in a
scan of a BTREE should be (BTREE_HEIGHT - 1 + NO_VISITED_PAGES). For an
extremely small BTREE, the btree height may be negative (-1).
- For other types of scans, this column is NULL.
-</entry>
+ For other types of scans, this column is NULL.</entry>
</row>
<row>
<entry colname="1">FETCH_SIZE</entry>
@@ -189,7 +193,7 @@ scan which were found to be rows that we
<entry colname="2">VARCHAR</entry>
<entry colname="3">32,672</entry>
<entry colname="4">true</entry>
-<entry colname="5">For index and constraint scans, this column holds a
+<entry colname="5">For index and constraint scans, a
textual representation of the operator, if any, which was used to position
the beginning of the index/constraint scan.</entry>
</row>
@@ -198,7 +202,7 @@ scan which were found to be rows that we
<entry colname="2">VARCHAR</entry>
<entry colname="3">32,672</entry>
<entry colname="4">true</entry>
-<entry colname="5">For index and constraint scans, this column holds a
+<entry colname="5">For index and constraint scans, a
textual representation of the operator, if any, which was used to position
the end of the index/constraint scan.</entry>
</row>
@@ -225,7 +229,8 @@ captured in this column.</entry>
<entry colname="2">VARCHAR</entry>
<entry colname="3">32,672</entry>
<entry colname="4">true</entry>
-<entry colname="5">For hash joins, this column contains information about which column is being used to hash the rows that are joined.</entry>
+<entry colname="5">For hash joins, this column contains information about which
+column is being used to hash the rows that are joined.</entry>
</row>
<row>
<entry colname="1">HASH_TABLE_SIZE</entry>
@@ -243,6 +248,6 @@ captured in this column.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_sort_props.dita Fri Apr 29 17:35:37 2011
@@ -20,44 +20,48 @@ limitations under the License.
-->
<reference id="rrefsysxplain_sort_props" xml:lang="en-us">
<title>SYSXPLAIN_SORT_PROPS system table</title>
+<shortdesc>The SYSXPLAIN_SORT_PROPS table captures information about row sorting
+actions which occurred during statements that were executed using
+RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_SORT_PROPS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_SORT_PROPS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_SORT_PROPS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures information about row sorting actions
- which occurred during statements that were
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
- Rows in this table are typically joined with rows in
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.</p>
+<p>Rows in this table are typically joined with rows in
SYSXPLAIN_STATEMENTS and SYSXPLAIN_RESULTSETS during analysis.</p>
- <codeblock>
- select s.stmt_text, rs.op_identifier,
- srt.no_input_rows, srt.no_output_rows
- from my_stats.sysxplain_sort_props srt,
- my_stats.sysxplain_resultsets rs,
- my_stats.sysxplain_statements s
- where rs.stmt_id = s.stmt_id and rs.sort_rs_id = srt.sort_rs_id
- </codeblock>
+<codeblock>select s.stmt_text, rs.op_identifier,
+ srt.no_input_rows, srt.no_output_rows
+ from my_stats.sysxplain_sort_props srt,
+ my_stats.sysxplain_resultsets rs,
+ my_stats.sysxplain_statements s
+ where rs.stmt_id = s.stmt_id and rs.sort_rs_id = srt.sort_rs_id</codeblock>
<p>Rows in this table are added
automatically when
<ph conref="../conrefs.dita#prod/productshortname"></ph>
has been configured appropriately. The
- rows remain in the table until you delete them or drop the table.
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p><p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+ rows remain in the table until you delete them or drop the table.</p>
+<p>The following table shows the contents of the SYSXPLAIN_SORT_PROPS system
+table.</p>
+<table>
+<title>SYSXPLAIN_SORT_PROPS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -76,8 +80,8 @@ which required this sort to be performed
<entry colname="3">2</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating the type of sort that was performed.
- The code values include 'IN' for an internal sort, and 'EX' for an
- external sort. An internal sort is one which was entirely
+ The code values include <i>'IN'</i> for an internal sort, and <i>'EX'</i>
+ for an external sort. An internal sort is one which was entirely
performed in-memory and did not overflow to any temporary files, while an
external sort used one or more external files.</entry>
</row>
@@ -95,8 +99,8 @@ external sort used one or more external
<entry colname="4">true</entry>
<entry colname="5">Number of rows which were returned by the sorter.
Note that this may be fewer rows than were input, for example when
- the sorter is performing GROUP BY processing or is eliminating duplicates.
-</entry>
+ the sorter is performing GROUP BY processing or is eliminating
+ duplicates.</entry>
</row>
<row>
<entry colname="1">NO_MERGE_RUNS</entry>
@@ -105,11 +109,10 @@ external sort used one or more external
<entry colname="4">true</entry>
<entry colname="5">Number of merge runs which were provided. This value
will be NULL for an internal sort, but for an external sort it
- indicates how many times the intermedate sort files were merged together.
+ indicates how many times the intermediate sort files were merged together.
External sorts are far more expensive than internal sorts, and each
additional merge run that an external sort must perform adds
- considerably more to the overhead of the sort.
-</entry>
+ considerably more to the overhead of the sort.</entry>
</row>
<row>
<entry colname="1">MERGE_RUN_DETAILS</entry>
@@ -125,7 +128,8 @@ This value will be NULL for an internal
<entry colname="3">1</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating whether or not this sort
- eliminated duplicates from the input: (Y)es or (N)o.
+ eliminated duplicates from the input. Valid values are <i>'Y'</i> and
+ <i>'N'</i>.
This column only applies for a sort which was NOT performing GROUP BY
aggregation; for GROUP BY sorts this column is always NULL. See the
DISTINCT_AGGREGATE column for the corresponding information for
@@ -140,8 +144,8 @@ This value will be NULL for an internal
<entry colname="5">A code indicating whether or not the rows which were
input to the sorter were already in sort order, which can happen if
the rows were retrieved by using an index, or if an earlier phase of
- processing had already sorted the data. The code is 'Y' for Yes if the
-rows are already in sorted order, and 'N' for No otherwise.</entry>
+ processing had already sorted the data. The code is <i>'Y'</i> if the
+rows are already in sorted order, and <i>'N'</i> otherwise.</entry>
</row>
<row>
<entry colname="1">DISTINCT_AGGREGATE</entry>
@@ -149,10 +153,11 @@ rows are already in sorted order, and 'N
<entry colname="3">1</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating whether the aggregation process
-was computing distinct aggregates or not.</entry>
+was computing distinct aggregates or not. Valid values are <i>'Y'</i> and
+<i>'N'</i>.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_statement_timings.dita Fri Apr 29 17:35:37 2011
@@ -20,50 +20,52 @@ limitations under the License.
-->
<reference id="rrefsysxplain_statement_timings" xml:lang="en-us">
<title>SYSXPLAIN_STATEMENT_TIMINGS system table</title>
+<shortdesc>The SYSXPLAIN_STATEMENT_TIMINGS table captures information about
+statement timings which occurred during statements that were executed using
+RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_STATEMENT_TIMINGS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_STATEMENT_TIMINGS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_STATEMENT_TIMINGS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures information about statement timings
- which occurred during statements that were
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.
Note in particular that you must
- call syscs_util.syscs_set_statistics_timing(1) to enable
+ call SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING(1) to enable
timing information to be captured.
Rows in this table are typically joined with rows in
SYSXPLAIN_STATEMENTS and SYSXPLAIN_RESULTSETS during analysis.
For example:</p>
- <codeblock>
- select s.stmt_text, st.execute_time
- from my_stats.sysxplain_statements s,
- my_stats.sysxplain_statement_timings st
- where s.timing_id = st.timing_id
- order by st.execute_time desc
- </codeblock>
+<codeblock>select s.stmt_text, st.execute_time
+ from my_stats.sysxplain_statements s,
+ my_stats.sysxplain_statement_timings st
+ where s.timing_id = st.timing_id
+ order by st.execute_time desc</codeblock>
<p>Rows in this table are added
automatically when
<ph conref="../conrefs.dita#prod/productshortname"></ph>
has been configured appropriately. The
rows remain in the table until you delete them or drop the table.
</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
- <p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+<p>The following table shows the contents of the SYSXPLAIN_STATEMENT_TIMINGS
+system table.</p>
+<table>
+<title>SYSXPLAIN_STATEMENT_TIMINGS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -176,6 +178,6 @@ executing this statement.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita?rev=1097897&r1=1097896&r2=1097897&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsysxplain_statements.dita Fri Apr 29 17:35:37 2011
@@ -20,12 +20,17 @@ limitations under the License.
-->
<reference id="rrefsysxplain_statements" xml:lang="en-us">
<title>SYSXPLAIN_STATEMENTS system table</title>
+<shortdesc>The SYSXPLAIN_STATEMENTS table captures information about statements
+which have been executed using RUNTIMESTATISTICS with XPLAIN style.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>system tables<indexterm>SYSXPLAIN_STATEMENTS</indexterm></indexterm>
+<indexterm>XPLAIN style statistics<indexterm>SYSXPLAIN_STATEMENTS system table</indexterm></indexterm>
+<indexterm>SYSXPLAIN_STATEMENTS system table</indexterm></keywords>
+</metadata></prolog>
<refbody>
- <section><p>This table captures information about statements which have been
- executed using RUNTIMESTATISTICS with XPLAIN style (see the
- RUNTIMESTATISTICS section in the
- <ph conref="../conrefs.dita#pub/citref"></ph> for more information
- on how to configure this).
+ <section><p>See "Working with RunTimeStatistics" in
+ <ph conref="../conrefs.dita#pub/cittuning"></ph> for information
+ on how to configure this.
</p>
<p>
Each row in this table describes a single statement which has
@@ -39,24 +44,23 @@ limitations under the License.
has been configured appropriately. The
rows remain in the table until you delete them or drop the table.
</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
- <p> <table
-pgwide="1" frame="all">
-<tgroup cols="5" colsep="1" rowsep="1"><colspec colname="1" colnum="1" colwidth="24*"/>
-<colspec colname="2" colnum="2" colwidth="23*"/><colspec colname="3" colnum="3"
-colwidth="11*"/><colspec colname="4" colnum="4" colwidth="14*"/><colspec colname="5"
-colnum="5" colwidth="29*"/>
+<p>The following table shows the contents of the SYSXPLAIN_STATEMENTS system
+table.</p>
+<table>
+<title>SYSXPLAIN_STATEMENTS system table</title>
+<tgroup cols="5" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="31*"/>
+<colspec colname="2" colnum="2" colwidth="17*"/>
+<colspec colname="3" colnum="3" colwidth="11*"/>
+<colspec colname="4" colnum="4" colwidth="12*"/>
+<colspec colname="5" colnum="5" colwidth="29*"/>
<thead>
-<row>
-<entry align="left" colname="1" valign="bottom">Column Name</entry>
-<entry align="left" colname="2" valign="bottom">Type</entry>
-<entry align="left" colname="3" valign="bottom">Length</entry>
-<entry align="left" colname="4" valign="bottom">Nullability</entry>
-<entry align="left" colname="5" valign="bottom">Contents</entry>
+<row valign="bottom">
+<entry colname="1">Column Name</entry>
+<entry colname="2">Type</entry>
+<entry colname="3">Length</entry>
+<entry colname="4">Nullable</entry>
+<entry colname="5">Contents</entry>
</row>
</thead>
<tbody>
@@ -73,7 +77,7 @@ colnum="5" colwidth="29*"/>
<entry colname="3">128</entry>
<entry colname="4">true</entry>
<entry colname="5">The name of the associated query or statement. This value
- is NULL if the user did not assign a name (by calling
+ is NULL if the user did not assign a name (by calling
<i>java.sql.Statement.setCursorName()</i>).</entry>
</row>
<row>
@@ -82,9 +86,9 @@ colnum="5" colwidth="29*"/>
<entry colname="3">3</entry>
<entry colname="4">false</entry>
<entry colname="5">A code indicating what type of statement this is:
- '<i>S</i>'=SELECT, '<i>I</i>'=INSERT, '<i>U</i>'=UPDATE,
- '<i>D</i>'=DELETE, '<i>C</i>'=CALL, '<i>DDL</i>'=Data Definition, such
- as CREATE TABLE, '<i>SA</i>'=SELECT (Approximate), or blank,
+<i>'S'</i> for SELECT, <i>'I'</i> for INSERT, <i>'U'</i> for UPDATE,
+<i>'D'</i> for DELETE, <i>'C'</i> for CALL, <i>'DDL'</i> for Data Definition
+(such as CREATE TABLE), <i>'SA'</i> for SELECT (Approximate), or blank,
indicating the statement was a comment.</entry>
</row>
<row>
@@ -100,10 +104,9 @@ indicating the statement was a comment.<
<entry colname="3">32,672</entry>
<entry colname="4">false</entry>
<entry colname="5">A code indicating what version of the JVM was running
- when this statement was captured: '4'=J2SE_14 - JDK 1.4.0 or 1.4.1,
- '5'= J2SE_142 - JDK 1.4.2, '6'=J2SE_15 - JDK 1.5,
- '7'=J2SE_16 - JDK 1.6
-</entry>
+ when this statement was captured: <i>'4'</i> for J2SE_14 (JDK 1.4.0 or 1.4.1),
+<i>'5'</i> for J2SE_142 (JDK 1.4.2), <i>'6'</i> for J2SE_15 (JDK 1.5), or
+<i>'7'</i> for J2SE_16 (JDK 1.6).</entry>
</row>
<row>
<entry colname="1">OS_IDENTIFIER</entry>
@@ -119,7 +122,8 @@ which was being used when this statement
<entry colname="3">1</entry>
<entry colname="4">true</entry>
<entry colname="5">A code indicating the XPLAIN mode which was in use
- when this statement was captured: '<i>F</i>'=FULL, '<i>O</i>'=ONLY.</entry>
+ when this statement was captured: <i>'F'</i> for FULL,
+ or <i>'O'</i> for ONLY.</entry>
</row>
<row>
<entry colname="1">XPLAIN_TIME</entry>
@@ -135,7 +139,7 @@ was captured.</entry>
<entry colname="3">32,672</entry>
<entry colname="4">false</entry>
<entry colname="5">The JVM thread which was running when this statement
-was captured.</entry>
+was captured</entry>
</row>
<row>
<entry colname="1">TRANSACTION_ID</entry>
@@ -180,10 +184,10 @@ this column is null.</entry>
SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING has been called to enable
statistics timing. If statistics timings are being captured, then this
column will contain the ID of the row in SYSXPLAIN_STATEMENT_TIMINGS
-which record the statement timing for this statement.</entry>
+which records the statement timing for this statement.</entry>
</row>
</tbody>
</tgroup>
-</table></p></section>
+</table></section>
</refbody>
</reference>