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 2013/11/14 22:07:07 UTC
svn commit: r1542079 - /db/derby/docs/branches/10.10/src/ref/
Author: chaase3
Date: Thu Nov 14 21:07:06 2013
New Revision: 1542079
URL: http://svn.apache.org/r1542079
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Merged DERBY-6379-refprocs.diff to 10.10 doc branch from trunk revision 1542068.
Modified:
db/derby/docs/branches/10.10/src/ref/crefproper22250.dita
db/derby/docs/branches/10.10/src/ref/crefstorejardb.dita
db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_mode.dita
db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_schema.dita
db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_mode.dita
db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_schema.dita
db/derby/docs/branches/10.10/src/ref/rrefaltertablecompress.dita
db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelognowaitproc.dita
db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelogproc.dita
db/derby/docs/branches/10.10/src/ref/rrefbackupdbnowaitproc.dita
db/derby/docs/branches/10.10/src/ref/rrefbackupdbproc.dita
db/derby/docs/branches/10.10/src/ref/rrefcase.dita
db/derby/docs/branches/10.10/src/ref/rrefcheckpointdbproc.dita
db/derby/docs/branches/10.10/src/ref/rrefdeclaretemptable.dita
db/derby/docs/branches/10.10/src/ref/rrefdisablelogproc.dita
db/derby/docs/branches/10.10/src/ref/rrefemptystmtcache.dita
db/derby/docs/branches/10.10/src/ref/rreffreezedbproc.dita
db/derby/docs/branches/10.10/src/ref/rrefgetdbpropfunc.dita
db/derby/docs/branches/10.10/src/ref/rrefgetuseraccess.dita
db/derby/docs/branches/10.10/src/ref/rrefjdbc20377.dita
db/derby/docs/branches/10.10/src/ref/rrefproceduresinplacecompress.dita
db/derby/docs/branches/10.10/src/ref/rrefreloadpolicyproc.dita
db/derby/docs/branches/10.10/src/ref/rrefsetdbpropproc.dita
db/derby/docs/branches/10.10/src/ref/rrefsetstatstimingproc.dita
db/derby/docs/branches/10.10/src/ref/rrefsetuseraccess.dita
db/derby/docs/branches/10.10/src/ref/rrefsqlj19433.dita
db/derby/docs/branches/10.10/src/ref/rrefsqlj38831.dita
db/derby/docs/branches/10.10/src/ref/rrefsqljgrant.dita
db/derby/docs/branches/10.10/src/ref/rrefsqljrenamecolumnstatement.dita
db/derby/docs/branches/10.10/src/ref/rrefsqljrevoke.dita
db/derby/docs/branches/10.10/src/ref/rrefsqljtypexml.dita
db/derby/docs/branches/10.10/src/ref/rrefstorejarinstall.dita
db/derby/docs/branches/10.10/src/ref/rrefstorejarremove.dita
db/derby/docs/branches/10.10/src/ref/rrefstorejarreplace.dita
db/derby/docs/branches/10.10/src/ref/rrefsyscschecktablefunc.dita
db/derby/docs/branches/10.10/src/ref/rrefsyscsdiagtables.dita
db/derby/docs/branches/10.10/src/ref/rrefsyscsinvalidatestoredstmts.dita
db/derby/docs/branches/10.10/src/ref/rrefsyscspeeksequence.dita
db/derby/docs/branches/10.10/src/ref/rrefsyscsruntimestatsfunc.dita
db/derby/docs/branches/10.10/src/ref/rrefunfreezedbproc.dita
db/derby/docs/branches/10.10/src/ref/rrefupdatestatsproc.dita
Modified: db/derby/docs/branches/10.10/src/ref/crefproper22250.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/crefproper22250.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/crefproper22250.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/crefproper22250.dita Thu Nov 14 21:07:06 2013
@@ -20,14 +20,14 @@ limitations under the License.
-->
<concept id="crefproper22250" xml:lang="en-us">
<title>Derby properties</title>
-<shortdesc>The <ph conref="../conrefs.dita#prod/productshortname"></ph> properties
-are used for configuring the system and database, as well as for diagnostics
-such as logging statements, and monitoring and tracing locks.</shortdesc>
<prolog><metadata>
<keywords><indexterm><indexterm>properties</indexterm>overview, Derby</indexterm>
</keywords>
</metadata></prolog>
<conbody>
+<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> properties are
+used for configuring the system and database, as well as for diagnostics such as
+logging statements, and monitoring and tracing locks.</p>
<p>The table later in this topic lists all the core
<ph conref="../conrefs.dita#prod/productshortname"></ph> properties.</p>
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> also supports a
Modified: db/derby/docs/branches/10.10/src/ref/crefstorejardb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/crefstorejardb.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/crefstorejardb.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/crefstorejardb.dita Thu Nov 14 21:07:06 2013
@@ -18,10 +18,10 @@ limitations under the License.
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../dtd/concept.dtd">
<concept xml:lang="en-us" id="crefstorejardb">
<title>System procedures for storing jar files in a database</title>
+<shortdesc><codeph>SQLJ.INSTALL_JAR</codeph>, <codeph>SQLJ.REMOVE_JAR</codeph>,
+and <codeph>SQLJ.REPLACE_JAR</codeph> are a set of procedures in the SQLJ schema
+that allow you to store jar files in a database.</shortdesc>
<conbody>
-<p><codeph>SQLJ.INSTALL_JAR</codeph>, <codeph>SQLJ.REMOVE_JAR</codeph>, and
-<codeph>SQLJ.REPLACE_JAR</codeph> are a set of procedures in the SQLJ schema
-that allow you to store jar files in a database.</p>
<p>Your jar file has two names:</p>
<ul>
<li>A <i>physical name</i> (the name you gave it when you created it)</li>
@@ -33,8 +33,8 @@ when you load it into a particular schem
be delimited and must be unique within a schema.</li>
</ul>
<p>A single schema can store more than one jar file.</p>
-<p>For more information on when and how to use these procedures, see the section
-"Loading classes from a database" in the
+<p>For more information on when and how to use these procedures, see "Loading
+classes from a database" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_mode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_mode.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_mode.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_mode.dita Thu Nov 14 21:07:06 2013
@@ -20,19 +20,15 @@ limitations under the License.
-->
<reference id="rref_syscs_get_xplain_mode" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE</codeph> function
+returns the current XPLAIN mode.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE</codeph> function
-returns the current xplain mode.</p><p>If
-the xplain mode is non-zero, then statements are not actually executed, but
-are just compiled, and their statistics recorded in the SYSXPLAIN_* database
-tables. If the xplain mode is zero (the default), then statements are
-executed normally.
-</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
+<section><p>If the XPLAIN mode is non-zero, then statements are not actually
+executed, but are just compiled, and their statistics recorded in the
+SYSXPLAIN_* database tables. If the XPLAIN mode is zero (the default), then
+statements are executed normally.</p>
+<p>See "Working with RunTimeStatistics" in
+<ph conref="../conrefs.dita#pub/cittuning"></ph> for additional information.</p>
</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE() RETURNS INTEGER</codeblock>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_schema.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_schema.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_schema.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rref_syscs_get_xplain_schema.dita Thu Nov 14 21:07:06 2013
@@ -20,23 +20,18 @@ limitations under the License.
-->
<reference id="rref_syscs_get_xplain_schema" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA</codeph> function
+returns the XPLAIN schema for the connection.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA</codeph> function
- returns the xplain schema for the connection.</p>
- <p>The default xplain schema is empty,
- so if the xplain style hasn't been set, the function returns the
- empty string.
- If the xplain schema has been set using
- <codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</codeph>, the function
- returns the xplain schema that was set. If xplain schema is set to
- a non-empty value, and runtime statistics are being captured, then
- the runtime statistics will be stored into the SYSXPLAIN_* database
- tables in that schema for later analysis.</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
+<section><p>The default XPLAIN schema is empty, so if the XPLAIN style has not
+been set, the function returns the empty string. If the XPLAIN schema has been
+set using <codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</codeph>, the function
+returns the XPLAIN schema that was set. If the XPLAIN schema is set to a
+non-empty value, and runtime statistics are being captured, then the runtime
+statistics will be stored into the SYSXPLAIN_* database tables in that schema
+for later analysis.</p>
+<p>See "Working with RunTimeStatistics" in
+<ph conref="../conrefs.dita#pub/cittuning"></ph> for additional information.</p>
</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA () RETURNS VARCHAR</codeblock>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_mode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_mode.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_mode.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_mode.dita Thu Nov 14 21:07:06 2013
@@ -20,21 +20,18 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rref_syscs_set_xplain_mode" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_XPLAIN_MODE system procedure</title>
+<shortdesc>When runtime statistics are being captured, you can control the mode
+of processing by using the <codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_MODE</codeph>
+procedure.</shortdesc>
<refbody>
- <section><p>When runtime statistics are being captured, you can control
- the mode of processing using this procedure. When the xplain mode
- is set to 1, statements are compiled and optimized, but not
- executed; when the xplain mode is set to 0 (the default), statements
- are compiled, optimized, and executed normally.</p>
- <p>Note that xplain_mode only matters when xplain style has been
- enabled, see the
-<xref href="rref_syscs_set_xplain_schema.dita#rref_syscs_set_xplain_schema">SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</xref> system
-procedure for more information.</p>
- <p>
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p>
+<section><p>When the XPLAIN mode is set to 1, statements are compiled and
+optimized, but not executed; when the XPLAIN mode is set to 0 (the default),
+statements are compiled, optimized, and executed normally.</p>
+<p>The XPLAIN mode only matters when XPLAIN style has been enabled. See the
+<codeph><xref href="rref_syscs_set_xplain_schema.dita#rref_syscs_set_xplain_schema">SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</xref></codeph>
+system procedure for more information.</p>
+<p>See "Working with RunTimeStatistics" in
+<ph conref="../conrefs.dita#pub/cittuning"></ph> for additional information.</p>
</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_XPLAIN_MODE(IN SMALLINT NOEXECUTE)</codeblock></section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_schema.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_schema.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_schema.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rref_syscs_set_xplain_schema.dita Thu Nov 14 21:07:06 2013
@@ -20,30 +20,27 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rref_syscs_set_xplain_schema" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</codeph> system
+procedure allows you to request XPLAIN style processing of runtime
+statistics.</shortdesc>
<refbody>
- <section><p>This procedure allows you to request XPLAIN style processing
- of runtime statistics. When XPLAIN style is used, the runtime
- statistics are written to the SYSXPLAIN_* database tables, so
- that you can analyze the statistics by running queries against
- the tables.
- See "Working with RunTimeStatistics" in the
- <ph conref="../conrefs.dita#pub/cittuning"></ph>
- for additional information.
- </p></section>
-<section><p>Turn xplain style on by calling this procedure with a non-empty
-argument. Turn xplain style off by calling the procedure with an empty
-argument.</p></section>
-<section><p>The argument that you provide must be a legal schema name, and
- you should use this argument to indicate the schema in which
- runtime statistics should be captured. If the schema that you
- specify does not already exist, it will be automatically created.
- If the XPLAIN tables do not already exist in this schema, they
- will be automatically created. Runtime statistics information about
- statements executed in this session will then be captured into
- these tables, until runtime statistics capturing is halted by either
- calling <codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</codeph> with
- an empty argument or by calling
- <codeph>SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS(0)</codeph></p></section>
+<section><p>When XPLAIN style is used, the runtime statistics are written to the
+SYSXPLAIN_* database tables, so that you can analyze the statistics by running
+queries against the tables.</p>
+<p>See "Working with RunTimeStatistics" in
+<ph conref="../conrefs.dita#pub/cittuning"></ph> for additional information.</p>
+<p>Turn XPLAIN style on by calling this procedure with a non-empty argument.
+Turn XPLAIN style off by calling the procedure with an empty argument.</p>
+<p>The argument that you provide must be a legal schema name, and you should use
+this argument to indicate the schema in which runtime statistics should be
+captured. If the schema that you specify does not already exist, it will be
+automatically created. If the XPLAIN tables do not already exist in this schema,
+they will be automatically created. Runtime statistics information about
+statements executed in this session will then be captured into these tables,
+until runtime statistics capturing is halted either by calling
+<codeph>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA</codeph> with an empty argument or by
+calling <codeph>SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS(0)</codeph>.</p>
+</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_XPLAIN_SCHEMA(IN VARCHAR(128) SCHEMA_NAME)</codeblock></section>
<section><title>Execute privileges</title>
<p>If authentication and SQL authorization are both enabled, only the
Modified: db/derby/docs/branches/10.10/src/ref/rrefaltertablecompress.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefaltertablecompress.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefaltertablecompress.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefaltertablecompress.dita Thu Nov 14 21:07:06 2013
@@ -20,21 +20,24 @@ limitations under the License.
-->
<reference id="rrefaltertablecompress" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_COMPRESS_TABLE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
+procedure to reclaim unused, allocated space in a table and its
+indexes.</shortdesc>
<prolog><metadata>
<keywords><indexterm>compressing tables</indexterm><indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>Use the <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
-procedure to reclaim unused, allocated space in a table and its indexes. Typically,
-unused allocated space exists when a large amount of data is deleted from
-a table, or indexes are updated. By default, <ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not return unused space to the operating system. For example, once a page
-has been allocated to a table or index, it is not automatically returned to
-the operating system until the table or index is destroyed. <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> allows
-you to return unused space to the operating system.</p><p>The <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system
-procedure updates statistics on all indexes as part of the index rebuilding
-process.</p></section>
+<section><p>Typically, unused allocated space exists when a large amount of data
+is deleted from a table, or indexes are updated. By default,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not return unused
+space to the operating system. For example, once a page has been allocated to a
+table or index, it is not automatically returned to the operating system until
+the table or index is destroyed.
+<codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> allows you to return unused
+space to the operating system.</p>
+<p>The <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph> system procedure updates
+statistics on all indexes as part of the index rebuilding process.</p></section>
<section><title>Syntax</title> <codeblock><b>SYSCS_UTIL.SYSCS_COMPRESS_TABLE (IN SCHEMANAME VARCHAR(128),
IN TABLENAME VARCHAR(128), IN SEQUENTIAL SMALLINT)</b></codeblock> <dl><dlentry>
<dt>SCHEMANAME</dt>
Modified: db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelognowaitproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelognowaitproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelognowaitproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelognowaitproc.dita Thu Nov 14 21:07:06 2013
@@ -19,18 +19,21 @@ See the License for the specific languag
limitations under the License.
-->
<reference id="rrefbackupdbenablelognowaitproc" xml:lang="en-us">
-<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT system procedure</title>
+<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT
+system procedure</title>
+<shortdesc>The
+<codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT</codeph>
+system procedure backs up the database to a specified backup directory and
+enables the database for log archive mode.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT system procedure</indexterm>
<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT</codeph> system
-procedure backs up the database to a specified backup directory and enables
-the database for log archive mode. This procedure returns an error if there
-are any transactions in progress that have unlogged operations at the start
-of the backup, instead of waiting for those transactions to complete.</p></section>
+<section><p>This procedure returns an error if there are any transactions in
+progress that have unlogged operations at the start of the backup, instead of
+waiting for those transactions to complete.</p></section>
<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT
(IN BACKUPDIR VARCHAR(32672),
IN SMALLINT DELETE_ARCHIVED_LOG_FILES)
Modified: db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelogproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelogproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelogproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefbackupdbenablelogproc.dita Thu Nov 14 21:07:06 2013
@@ -19,17 +19,19 @@ See the License for the specific languag
limitations under the License.
-->
<reference id="rrefbackupdbenablelogproc" xml:lang="en-us">
-<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE system procedure</title>
+<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE system
+procedure</title>
+<shortdesc>The
+<codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE</codeph>
+system procedure backs up the database to a specified backup directory and
+enables the database for log archive mode.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE system procedure</indexterm>
<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE</codeph> system
-procedure backs up the database to a specified backup directory and enables
-the database for log archive mode.</p>
-<p>See "Roll-forward recovery" in the
+<section><p>See "Roll-forward recovery" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
this procedure.</p>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefbackupdbnowaitproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefbackupdbnowaitproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefbackupdbnowaitproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefbackupdbnowaitproc.dita Thu Nov 14 21:07:06 2013
@@ -21,7 +21,7 @@ limitations under the License.
<reference id="rrefbackupdbnowaitproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT system procedure</title>
<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</codeph> system
-procedure backs up the database to a specified backup directory. </shortdesc>
+procedure backs up the database to a specified backup directory.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT system procedure<indexterm>syntax</indexterm></indexterm>
<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</indexterm></indexterm>
Modified: db/derby/docs/branches/10.10/src/ref/rrefbackupdbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefbackupdbproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefbackupdbproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefbackupdbproc.dita Thu Nov 14 21:07:06 2013
@@ -20,15 +20,15 @@ limitations under the License.
-->
<reference id="rrefbackupdbproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE</codeph> system
+procedure backs up the database to a specified backup directory.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE system procedure</indexterm>
<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE</codeph> system procedure
-backs up the database to a specified backup directory.</p>
-<p>See "Using the backup procedures to perform an online backup" in the
+<section><p>See "Using the backup procedures to perform an online backup" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
this procedure.</p>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefcase.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefcase.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefcase.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefcase.dita Thu Nov 14 21:07:06 2013
@@ -19,12 +19,12 @@ limitations under the License.
-->
<reference id="rrefcase" xml:lang="en-us">
<title>CASE expression</title>
-<shortdesc>The CASE expression can be used for conditional expressions in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>CASE expression</indexterm></keywords>
</metadata></prolog>
<refbody>
+<section><p>The CASE expression can be used for conditional expressions in
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></section>
<refsyn><title>Syntax</title><p>You can place a CASE expression
anywhere an expression is allowed. It chooses an expression to evaluate based
on a boolean test.</p> <codeblock><b>CASE
Modified: db/derby/docs/branches/10.10/src/ref/rrefcheckpointdbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefcheckpointdbproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefcheckpointdbproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefcheckpointdbproc.dita Thu Nov 14 21:07:06 2013
@@ -20,9 +20,10 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefcheckpointdbproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE</codeph> system
+procedure checkpoints the database by flushing all cached data to
+disk.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE</codeph> system
-procedure checkpoints the database by flushing all cached data to disk.</p></section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE()</codeblock> <p>No
result is returned by this procedure.</p></section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/branches/10.10/src/ref/rrefdeclaretemptable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefdeclaretemptable.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefdeclaretemptable.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefdeclaretemptable.dita Thu Nov 14 21:07:06 2013
@@ -20,15 +20,16 @@ limitations under the License.
-->
<reference id="rrefdeclaretemptable" xml:lang="en-us">
<title>DECLARE GLOBAL TEMPORARY TABLE statement</title>
-<shortdesc>The DECLARE GLOBAL TEMPORARY TABLE statement defines a temporary
-table for the current connection. </shortdesc>
<prolog><metadata>
<keywords><indexterm>DECLARE GLOBAL TEMPORARY TABLE statement</indexterm>
<indexterm>tables<indexterm>temporary</indexterm></indexterm><indexterm><indexterm>SQL
statements</indexterm>DECLARE GLOBAL TEMPORARY TABLE</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>These tables do not reside in the system catalogs and are not
+<section>
+<p>The DECLARE GLOBAL TEMPORARY TABLE statement defines a temporary table for
+the current connection.</p>
+<p>These tables do not reside in the system catalogs and are not
persistent. Temporary tables exist only during the connection that declared
them and cannot be referenced outside of that connection. When the connection
closes, the rows of the table are deleted, and the in-memory description of
Modified: db/derby/docs/branches/10.10/src/ref/rrefdisablelogproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefdisablelogproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefdisablelogproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefdisablelogproc.dita Thu Nov 14 21:07:06 2013
@@ -19,12 +19,12 @@ limitations under the License.
-->
<reference id="rrefdisablelogproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE system procedure</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE</codeph> system
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE</codeph> system
procedure disables the log archive mode and deletes any existing online archived
log files if the <codeph>DELETE_ARCHIVED_LOG_FILES</codeph> input parameter
-is non-zero. </p>
-<p>See "Roll-forward recovery" in the
+is non-zero.</shortdesc>
+<refbody>
+<section><p>See "Roll-forward recovery" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
this procedure.</p>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefemptystmtcache.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefemptystmtcache.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefemptystmtcache.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefemptystmtcache.dita Thu Nov 14 21:07:06 2013
@@ -20,13 +20,14 @@ limitations under the License.
-->
<reference id="rrefemptystmtcache" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE system procedure</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE</codeph> stored
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE</codeph> stored
procedure removes as many compiled statements (plans) as possible from the
-database-wide statement cache. The procedure does not remove statements related
-to currently executing queries or to activations that are about to be garbage
-collected, so the cache is not guaranteed to be completely empty after a call
-to this procedure.</p></section>
+database-wide statement cache.</shortdesc>
+<refbody>
+<section><p>The procedure does not remove statements related to currently
+executing queries or to activations that are about to be garbage collected, so
+the cache is not guaranteed to be completely empty after a call to this
+procedure.</p></section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE()</codeblock>
</section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/branches/10.10/src/ref/rreffreezedbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rreffreezedbproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rreffreezedbproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rreffreezedbproc.dita Thu Nov 14 21:07:06 2013
@@ -20,11 +20,11 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rreffreezedbproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_FREEZE_DATABASE system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_FREEZE_DATABASE</codeph> system
+procedure temporarily freezes the database for backup.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_FREEZE_DATABASE</codeph> system procedure
-temporarily freezes the database for backup.</p>
-<p>See "Using operating system commands with the freeze and unfreeze system
-procedures to perform an online backup" in the
+<section><p>See "Using operating system commands with the freeze and unfreeze
+system procedures to perform an online backup" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
this procedure.</p>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefgetdbpropfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefgetdbpropfunc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefgetdbpropfunc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefgetdbpropfunc.dita Thu Nov 14 21:07:06 2013
@@ -20,11 +20,11 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefgetdbpropfunc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY system function</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph> function
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph> function
fetches the value of the specified property of the database on the current
-connection.</p>
-<p>If the value that was set for the property is invalid, the
+connection.</shortdesc>
+<refbody>
+<section><p>If the value that was set for the property is invalid, the
<codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph> function returns the
invalid value, but <ph conref="../conrefs.dita#prod/productshortname"></ph> uses
the default value.</p></section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefgetuseraccess.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefgetuseraccess.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefgetuseraccess.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefgetuseraccess.dita Thu Nov 14 21:07:06 2013
@@ -20,12 +20,13 @@ limitations under the License.
-->
<reference id="rrefgetuseraccess" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_GET_USER_ACCESS system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_GET_USER_ACCESS</codeph> function
+returns the current connection access permission for the user
+specified.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_USER_ACCESS</codeph> function
-returns the current connection access permission for the user specified.</p><p>If
-no permission is explicitly set for the user, the access permission for the
-user is the value of the default connection mode. The default connection mode
-is set by using the
+<section><p>If no permission is explicitly set for the user, the access
+permission for the user is the value of the default connection mode. The default
+connection mode is set by using the
<codeph><xref href="rrefproper24846.dita#rrefproper24846">derby.database.defaultConnectionMode</xref></codeph>
property.</p></section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_USER_ACCESS (USERNAME VARCHAR(128)) RETURNS VARCHAR(128)</codeblock><dl>
Modified: db/derby/docs/branches/10.10/src/ref/rrefjdbc20377.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefjdbc20377.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefjdbc20377.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefjdbc20377.dita Thu Nov 14 21:07:06 2013
@@ -20,7 +20,6 @@ limitations under the License.
-->
<reference id="rrefjdbc20377" xml:lang="en-us">
<title>Mapping of java.sql.Types to SQL types</title>
-<shortdesc>In Derby, the java.sql.Types are mapped to SQL data types</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.Types<indexterm>mapped to SQL types</indexterm></indexterm>
<indexterm>SQL types<indexterm>mapped to java.sql.Types</indexterm></indexterm>
@@ -31,7 +30,10 @@ types to SQL types</indexterm></indexter
data type</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>The following table shows the mapping of <i>java.sql.Types</i> to
+<section>
+<p>In <ph conref="../conrefs.dita#prod/productshortname"></ph>, the
+<i>java.sql.Types</i> are mapped to SQL data types.</p>
+<p>The following table shows the mapping of <i>java.sql.Types</i> to
SQL types.</p>
<table frame="all" id="jdbc31241"><title>Mapping of <i>java.sql.Types</i>
to SQL types</title>
Modified: db/derby/docs/branches/10.10/src/ref/rrefproceduresinplacecompress.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefproceduresinplacecompress.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefproceduresinplacecompress.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefproceduresinplacecompress.dita Thu Nov 14 21:07:06 2013
@@ -20,24 +20,29 @@ limitations under the License.
-->
<reference id="rrefproceduresinplacecompress" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph>
+system procedure to reclaim unused, allocated space in a table and its
+indexes.</shortdesc>
<prolog><metadata>
<keywords><indexterm>reclaiming unused space</indexterm><indexterm>system
procedures<indexterm>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>Use the <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> system
-procedure to reclaim unused, allocated space in a table and its indexes. Typically,
-unused allocated space exists when a large amount of data is deleted from
-a table and there has not been any subsequent inserts to use the space created
-by the deletes. By default, <ph conref="../conrefs.dita#prod/productshortname"></ph> does
-not return unused space to the operating system. For example, once a page
-has been allocated to a table or index, it is not automatically returned to
-the operating system until the table or index is destroyed. <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> allows
-you to return unused space to the operating system.</p><p>This system procedure
-can be used to force three levels of in-place compression of a SQL table: <codeph>PURGE_ROWS</codeph>, <codeph>DEFRAGMENT_ROWS</codeph>,
-and <codeph>TRUNCATE_END</codeph>. Unlike <codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE()</codeph>,
-all work is done in place in the existing table/index.</p></section>
+<section><p>Typically, unused allocated space exists when a large amount of data
+is deleted from a table and there have not been any subsequent inserts to use
+the space created by the deletes. By default,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not return unused
+space to the operating system. For example, once a page has been allocated to a
+table or index, it is not automatically returned to the operating system until
+the table or index is destroyed.
+<codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> allows you to return
+unused space to the operating system.</p>
+<p>This system procedure can be used to force three levels of in-place
+compression of a SQL table: <codeph>PURGE_ROWS</codeph>,
+<codeph>DEFRAGMENT_ROWS</codeph>, and <codeph>TRUNCATE_END</codeph>. Unlike
+<codeph>SYSCS_UTIL.SYSCS_COMPRESS_TABLE</codeph>, all work is done in place
+in the existing table/index.</p></section>
<section><title>Syntax</title><codeblock><b>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE(
IN SCHEMANAME VARCHAR(128),
IN TABLENAME VARCHAR(128),
@@ -109,10 +114,12 @@ cs.setShort(3, (short) 0);
cs.setShort(4, (short) 0);
cs.setShort(5, (short) 1);
cs.execute();</codeblock></p></section>
-<section><p><note type="tip">We recommend that you issue the <codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> system
-procedure in the auto-commit mode. </note><note>This procedure acquires an
-exclusive table lock on the table being compressed. All statement plans dependent
-on the table or its indexes are invalidated. For information on identifying
-unused space, see the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>.</note></p></section>
+<section><p><note type="tip">We recommend that you issue the
+<codeph>SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE</codeph> system procedure in
+auto-commit mode.</note>
+<note>This procedure acquires an exclusive table lock on the table being
+compressed. All statement plans dependent on the table or its indexes are
+invalidated. For information on identifying unused space, see the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</note></p></section>
</refbody>
</reference>
Modified: db/derby/docs/branches/10.10/src/ref/rrefreloadpolicyproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefreloadpolicyproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefreloadpolicyproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefreloadpolicyproc.dita Thu Nov 14 21:07:06 2013
@@ -20,16 +20,15 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefreloadpolicyproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY</codeph> system
+procedure reloads the security policy, allowing you to fine-tune your Java
+security on the fly.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY</codeph> system
-procedure reloads the security policy, allowing you to fine-tune your
-Java security on the fly. For more information on security policies,
-see the section titled "Running the Network Server under the security
-manager" in the
-<cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite>
-and the section titled "Running Derby under a security manager" in the
-<cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.
-</p></section>
+<section><p>For more information on security policies, see "Running the Network
+Server under the security manager" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> and "Running
+<ph conref="../conrefs.dita#prod/productshortname"></ph> under a security
+manager" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p></section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY()</codeblock> <p>No
result set is returned by this procedure.</p></section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsetdbpropproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsetdbpropproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsetdbpropproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsetdbpropproc.dita Thu Nov 14 21:07:06 2013
@@ -20,22 +20,24 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsetdbpropproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY system procedure</title>
+<shortdesc>Use the <codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph>
+system procedure to set or delete the value of a property of the database on the
+current connection.</shortdesc>
<refbody>
-<section><p>Use the <codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph> system
-procedure to set or delete the value of a property of the database on the
-current connection. For information about properties, see
+<section><p>For information about properties, see
<xref href="rrefproper32213.dita#rrefproper32213"></xref>.</p></section>
-<section><p>If VALUE is not null, then the property with key value KEY
-is set to VALUE. If VALUE is null, then the property with key value KEY
-is deleted from the database property set.</p>
+<section><title>Syntax</title>
+<codeblock>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(IN KEY VARCHAR(128),
+IN VALUE VARCHAR(32672))</codeblock>
+<p>This procedure does not return any results.</p>
+<p>If VALUE is not null, then the property with key value KEY is set to VALUE.
+If VALUE is null, then the property with key value KEY is deleted from the
+database property set.</p>
<p>If VALUE is an invalid value for the property,
<ph conref="../conrefs.dita#prod/productshortname"></ph> uses the default value
of the property, although
-<codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph> returns the invalid
+<codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph> sets the invalid
value.</p></section>
-<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(IN KEY VARCHAR(128),
-IN VALUE VARCHAR(32672))</codeblock> <p>This procedure does not return any
-results.</p></section>
<section><title>Execute privileges</title>
<p>If authentication and SQL authorization are both enabled, only the
<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref> has
Modified: db/derby/docs/branches/10.10/src/ref/rrefsetstatstimingproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsetstatstimingproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsetstatstimingproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsetstatstimingproc.dita Thu Nov 14 21:07:06 2013
@@ -20,21 +20,25 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsetstatstimingproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING system procedure</title>
+<shortdesc>Statistics timing is an attribute associated with a connection
+that you turn on and off by using the
+<codeph>SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING</codeph> system
+procedure.</shortdesc>
<refbody>
-<section><p>Statistics timing is an attribute associated with a connection
-that you turn on and off by using the <codeph>SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING</codeph> system
-procedure. Statistics timing is turned off by default. Turn statistics timing
+<section><p>Statistics timing is turned off by default. Turn statistics timing
on only when the <codeph>runtimestatistics</codeph> attribute is already on.
-Turning statistics timing on when the <codeph>runtimestatistics</codeph> attribute
-is off has no effect. </p></section>
-<section><p>Turn statistics timing on by calling this procedure with a non-zero
-argument. Turn statistics timing off by calling the procedure with a zero
-argument.</p></section>
-<section><p>When statistics timing is turned on, <ph conref="../conrefs.dita#prod/productshortname"></ph> tracks
-the timings of various aspects of the execution of a statement. This information
-is included in the information returned by the <xref href="rrefsyscsruntimestatsfunc.dita#rrefsyscsruntimestatsfunc">SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</xref> system
-function. When statistics timing is turned off, the <xref href="rrefsyscsruntimestatsfunc.dita#rrefsyscsruntimestatsfunc">SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</xref> system
-function shows all timing values as zero.</p></section>
+Turning statistics timing on when the <codeph>runtimestatistics</codeph>
+attribute is off has no effect.</p>
+<p>Turn statistics timing on by calling this procedure with a non-zero argument.
+Turn statistics timing off by calling the procedure with a zero argument.</p>
+<p>When statistics timing is turned on,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> tracks the timings of
+various aspects of the execution of a statement. This information is included in
+the information returned by the
+<codeph><xref href="rrefsyscsruntimestatsfunc.dita#rrefsyscsruntimestatsfunc">SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</xref></codeph>
+system function. When statistics timing is turned off, the
+<codeph>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</codeph> system function shows
+all timing values as zero.</p></section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_STATISTICS_TIMING(IN SMALLINT ENABLE)</codeblock></section>
<section><title>Execute privileges</title>
<p>By default, all users have execute privileges on this procedure.</p>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsetuseraccess.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsetuseraccess.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsetuseraccess.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsetuseraccess.dita Thu Nov 14 21:07:06 2013
@@ -20,17 +20,19 @@ limitations under the License.
-->
<reference id="rrefsetuseraccess" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_USER_ACCESS system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_SET_USER_ACCESS</codeph> system
+procedure sets the connection access permission for the user
+specified.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_SET_USER_ACCESS</codeph> system procedure
-sets the connection access permission for the user specified.</p></section>
-<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_USER_ACCESS (USERNAME VARCHAR(128), CONNECTION_PERMISSION VARCHAR(128))</codeblock
-><dl><dlentry>
+<section><title>Syntax</title>
+<codeblock>SYSCS_UTIL.SYSCS_SET_USER_ACCESS (USERNAME VARCHAR(128),
+CONNECTION_PERMISSION VARCHAR(128))</codeblock><dl><dlentry>
<dt>USERNAME</dt>
-<dd>An input argument of type VARCHAR(128) that specifies the user ID in the <ph
-conref="../conrefs.dita#prod/productshortname"></ph> database. <p></p></dd>
+<dd><p>An input argument of type VARCHAR(128) that specifies the user ID in the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database.</p></dd>
</dlentry><dlentry>
<dt>CONNECTION_PERMISSION</dt>
-<dd> Valid values for CONNECTION_PERMISSION are:<dl><dlentry>
+<dd><p>Valid values for CONNECTION_PERMISSION are:</p><dl><dlentry>
<dt>FULLACCESS</dt>
<dd>Adds the user to the list of users with full access to the database. The
value for the database property is
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqlj19433.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqlj19433.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqlj19433.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqlj19433.dita Thu Nov 14 21:07:06 2013
@@ -20,9 +20,6 @@ limitations under the License.
-->
<reference id="rrefsqlj19433" xml:lang="en-us">
<title>SQL expressions</title>
-<shortdesc>Syntax for many statements and expressions includes the term <term>expression</term>,
-or a term for a specific kind of expression such as <varname>tableSubquery</varname>.
-Expressions are allowed in these specified places within statements. </shortdesc>
<prolog><metadata>
<keywords><indexterm>SQL expressions<indexterm>column reference</indexterm></indexterm>
<indexterm>SQL expressions<indexterm>constant</indexterm></indexterm><indexterm>SQL
@@ -55,7 +52,12 @@ function</indexterm></indexterm><indexte
function</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>Some locations allow only a specific type of expression or one
+<section>
+<p>Syntax for many statements and expressions includes the term
+<term>expression</term>, or a term for a specific kind of expression such as
+<varname>tableSubquery</varname>. Expressions are allowed in these specified
+places within statements.</p>
+<p>Some locations allow only a specific type of expression or one
with a specific property. If not otherwise specified, an expression is permitted
anywhere the word <i>expression</i> appears in the syntax. This includes:
<ul>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqlj38831.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqlj38831.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqlj38831.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqlj38831.dita Thu Nov 14 21:07:06 2013
@@ -20,16 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsqlj38831" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS</codeph> system
+procedure turns a connection's runtime statistics on or off.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_SET_RUNTIMESTATISTICS()</codeph> system
-procedure turns a connection's runtime statistics on or off. By default, the
-runtime statistics are turned off. When the <codeph>runtimestatistics</codeph> attribute
-is turned on, <ph conref="../conrefs.dita#prod/productshortname"></ph> maintains
-information about the execution plan for each statement executed within the
-connection (except for COMMIT) until the attribute is turned off. To turn
-the <codeph>runtimestatistics</codeph> attribute off, call the procedure with
-an argument of zero. To turn the <codeph>runtimestatistics</codeph> on, call
-the procedure with any non-zero argument.</p></section>
+<section><p>By default, the runtime statistics are turned off. When the
+<codeph>runtimestatistics</codeph> attribute is turned on,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> maintains information
+about the execution plan for each statement executed within the connection
+(except for COMMIT) until the attribute is turned off. To turn the
+<codeph>runtimestatistics</codeph> attribute off, call the procedure with an
+argument of zero. To turn the <codeph>runtimestatistics</codeph> on, call the
+procedure with any non-zero argument.</p></section>
<section><p>For statements that do not return rows, the object is created
when all internal processing has completed before returning to the client
program. For statements that return rows, the object is created when the first <codeph>next()</codeph> call
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqljgrant.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqljgrant.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqljgrant.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqljgrant.dita Thu Nov 14 21:07:06 2013
@@ -22,16 +22,16 @@ under the License.
-->
<reference id="rrefsqljgrant" xml:lang="en-us">
<title>GRANT statement </title>
-<shortdesc>Use the GRANT statement to give privileges to a specific user or
-role, or to all users, to perform actions on database objects. You can also use
-the GRANT statement to grant a role to a user, to PUBLIC, or to another role.
-</shortdesc>
<prolog><metadata>
<keywords><indexterm>GRANT statement</indexterm><indexterm>SQL statements<indexterm>GRANT</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>The following types of privileges can be granted:<ul>
+<section>
+<p>Use the GRANT statement to give privileges to a specific user or role, or to
+all users, to perform actions on database objects. You can also use the GRANT
+statement to grant a role to a user, to PUBLIC, or to another role.</p>
+<p>The following types of privileges can be granted:<ul>
<li>Delete data from a specific table.</li>
<li>Insert data into a specific table.</li>
<li>Create a foreign key reference to the named table or to a subset of columns
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqljrenamecolumnstatement.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqljrenamecolumnstatement.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqljrenamecolumnstatement.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqljrenamecolumnstatement.dita Thu Nov 14 21:07:06 2013
@@ -19,7 +19,6 @@ limitations under the License.
-->
<reference id="rrefsqljcolumnstatements" xml:lang="en-us">
<title>RENAME COLUMN statement </title>
-<shortdesc>Use the RENAME COLUMN statement to rename a column in a table.</shortdesc>
<prolog><metadata>
<keywords><indexterm>RENAME COLUMN statement</indexterm>
<indexterm><indexterm>SQL statements</indexterm>RENAME COLUMN</indexterm>
@@ -27,7 +26,9 @@ limitations under the License.
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>The RENAME COLUMN statement allows you to rename an existing
+<section>
+<p>Use the RENAME COLUMN statement to rename a column in a table.</p>
+<p>The RENAME COLUMN statement allows you to rename an existing
column in an existing table in any schema
(except the schema <i>SYS</i>). </p><p>To rename a column, you must either
be the database owner or the table owner.</p>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqljrevoke.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqljrevoke.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqljrevoke.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqljrevoke.dita Thu Nov 14 21:07:06 2013
@@ -19,10 +19,6 @@ See the License for the specific languag
limitations under the License.-->
<reference id="rrefsqljrevoke" xml:lang="en-us">
<title>REVOKE statement </title>
-<shortdesc>Use the REVOKE statement to remove privileges from a specific
-user or role, or from all users, to perform actions on database objects. You can
-also use the REVOKE statement to revoke a role from a user, from PUBLIC, or from
-another role.</shortdesc>
<prolog><metadata>
<keywords><indexterm>REVOKE statement<indexterm>syntax</indexterm></indexterm>
<indexterm>SQL statements<indexterm>REVOKE</indexterm></indexterm><indexterm>REVOKE
@@ -30,7 +26,12 @@ statement<indexterm>limitations</indexte
and columns, revoking</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The following types of privileges can be revoked:<ul>
+<section>
+<p>Use the REVOKE statement to remove privileges from a specific user or role,
+or from all users, to perform actions on database objects. You can also use the
+REVOKE statement to revoke a role from a user, from PUBLIC, or from another
+role.</p>
+<p>The following types of privileges can be revoked:<ul>
<li>Delete data from a specific table.</li>
<li>Insert data into a specific table.</li>
<li>Create a foreign key reference to the named table or to a subset of columns
Modified: db/derby/docs/branches/10.10/src/ref/rrefsqljtypexml.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsqljtypexml.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsqljtypexml.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsqljtypexml.dita Thu Nov 14 21:07:06 2013
@@ -20,13 +20,13 @@ limitations under the License.
-->
<reference id="rrefsqljtypexml" xml:lang="en-us">
<title>XML data type</title>
-<shortdesc>The XML data type is used for Extensible Markup Language (XML)
-documents.</shortdesc>
<prolog><metadata>
<keywords><indexterm>XML data type</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section> <p>The XML data type is used: <ul>
+<section>
+<p>The XML data type is used for Extensible Markup Language (XML) documents.</p>
+<p>The XML data type is used: <ul>
<li>To store XML documents that conform to the SQL/XML definition of a well-formed
XML(DOCUMENT(ANY)) value.</li>
<li>Transiently for XML(SEQUENCE) values, that might not be well-formed XML(DOCUMENT(ANY))
Modified: db/derby/docs/branches/10.10/src/ref/rrefstorejarinstall.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefstorejarinstall.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefstorejarinstall.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefstorejarinstall.dita Thu Nov 14 21:07:06 2013
@@ -19,9 +19,8 @@ limitations under the License.
-->
<reference id="rrefstorejarinstall" xml:lang="en-us">
<title>SQLJ.INSTALL_JAR system procedure</title>
-<shortdesc>
-The SQLJ.INSTALL_JAR system procedure stores a jar file in a database.
-</shortdesc>
+<shortdesc>The <codeph>SQLJ.INSTALL_JAR</codeph> system procedure stores a jar
+file in a database.</shortdesc>
<prolog><metadata><keywords>
<indexterm>SQLJ.INSTALL_JAR system procedure</indexterm>
<indexterm>system procedures<indexterm>SQLJ.INSTALL_JAR</indexterm></indexterm>
Modified: db/derby/docs/branches/10.10/src/ref/rrefstorejarremove.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefstorejarremove.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefstorejarremove.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefstorejarremove.dita Thu Nov 14 21:07:06 2013
@@ -19,9 +19,8 @@ limitations under the License.
-->
<reference id="rrefstorejarremove" xml:lang="en-us">
<title>SQLJ.REMOVE_JAR system procedure</title>
-<shortdesc>
-The SQLJ.REMOVE_JAR system procedure removes a jar file from a database.
-</shortdesc>
+<shortdesc>The <codeph>SQLJ.REMOVE_JAR</codeph> system procedure removes a jar
+file from a database.</shortdesc>
<prolog><metadata><keywords>
<indexterm>SQLJ.REMOVE_JAR system procedure</indexterm>
<indexterm>system procedures<indexterm>SQLJ.REMOVE_JAR</indexterm></indexterm>
Modified: db/derby/docs/branches/10.10/src/ref/rrefstorejarreplace.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefstorejarreplace.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefstorejarreplace.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefstorejarreplace.dita Thu Nov 14 21:07:06 2013
@@ -19,9 +19,8 @@ limitations under the License.
-->
<reference id="rrefstorejarreplace" xml:lang="en-us">
<title>SQLJ.REPLACE_JAR system procedure</title>
-<shortdesc>
-The SQLJ.REPLACE_JAR system procedure replaces a jar file in a database.
-</shortdesc>
+<shortdesc>The <codeph>SQLJ.REPLACE_JAR</codeph> system procedure replaces a jar
+file in a database.</shortdesc>
<prolog><metadata><keywords>
<indexterm>SQLJ.REPLACE_JAR system procedure</indexterm>
<indexterm>system procedures<indexterm>SQLJ.REPLACE_JAR</indexterm></indexterm>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsyscschecktablefunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsyscschecktablefunc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsyscschecktablefunc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsyscschecktablefunc.dita Thu Nov 14 21:07:06 2013
@@ -20,19 +20,22 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsyscschecktablefunc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_CHECK_TABLE system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function checks the
+specified table, ensuring that all of its indexes are consistent with the base
+table.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function
-checks the specified table, ensuring that all of its indexes are consistent
-with the base table. If the table and indexes are consistent, the method returns a SMALLINT
-with value 1. If the table and indexes are inconsistent, the function will throw an exception.</p>
-<p>It is recommended that you run SYSCS_UTIL.SYSCS_CHECK_TABLE on the tables in
-a database offline after you back it up. Do not discard the previous backup
-until you have verified the consistency of the current one. Otherwise, check
-consistency only if there are indications that such a check is needed (for
-example, if you experience hardware or operating system failure), because a
-consistency check can take a long time on a large database. See "Checking
-database consistency" in the <ph conref="../conrefs.dita#pub/citadmin"></ph> for
-more information.</p>
+<section>
+<p>If the table and indexes are consistent, the method returns a SMALLINT
+with value 1. If the table and indexes are inconsistent, the function will throw
+an exception.</p>
+<p>It is recommended that you run <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph>
+on the tables in a database offline after you back it up. Do not discard the
+previous backup until you have verified the consistency of the current one.
+Otherwise, check consistency only if there are indications that such a check is
+needed (for example, if you experience hardware or operating system failure),
+because a consistency check can take a long time on a large database. See
+"Checking database consistency" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information.</p>
</section>
<refsyn><title>Syntax</title> <codeblock>SMALLINT SYSCS_UTIL.SYSCS_CHECK_TABLE(IN SCHEMANAME VARCHAR(128),
IN TABLENAME VARCHAR(128)) </codeblock> <p>An error will occur if either SCHEMANAME
Modified: db/derby/docs/branches/10.10/src/ref/rrefsyscsdiagtables.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsyscsdiagtables.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsyscsdiagtables.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsyscsdiagtables.dita Thu Nov 14 21:07:06 2013
@@ -20,9 +20,6 @@ limitations under the License.
-->
<reference id="rrefsyscsdiagtables" xml:lang="en-us">
<title>SYSCS_DIAG diagnostic tables and functions</title>
-<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-a set of system table expressions which you can use to obtain diagnostic information
-about the state of the database and about the database sessions. </shortdesc>
<prolog><metadata>
<keywords>
<indexterm>diagnostic tables and table functions</indexterm>
@@ -31,6 +28,9 @@ about the state of the database and abou
</metadata></prolog>
<refbody>
<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> provides a set of
+system table expressions which you can use to obtain diagnostic information
+about the state of the database and about the database sessions.</p>
<p>There are two types of diagnostic table expressions in
<ph conref="../conrefs.dita#prod/productshortname"></ph>:
<dl>
Modified: db/derby/docs/branches/10.10/src/ref/rrefsyscsinvalidatestoredstmts.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsyscsinvalidatestoredstmts.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsyscsinvalidatestoredstmts.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsyscsinvalidatestoredstmts.dita Thu Nov 14 21:07:06 2013
@@ -19,11 +19,12 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsyscsinvalidatestoredstmts" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_INVALIDATE_STORED_STATEMENTS system procedure</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_INVALIDATE_STORED_STATEMENTS</codeph>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_INVALIDATE_STORED_STATEMENTS</codeph>
system procedure invalidates all stored prepared statements (that is, all
-statements in the <xref href="rrefsistabs33768.dita#rrefsistabs33768"></xref>).
-The next time one of the invalid stored prepared statements is executed, it will
+statements in the SYSSTATEMENTS system table).</shortdesc>
+<refbody>
+<section><p>The next time one of the invalid stored prepared statements in the
+<xref href="rrefsistabs33768.dita#rrefsistabs33768"></xref> is executed, it will
be recompiled, and a new plan will be generated for it.</p>
<p>Run <codeph>SYSCS_UTIL.SYSCS_INVALIDATE_STORED_STATEMENTS</codeph> whenever
you think that your metadata queries or triggers are misbehaving -- for example,
Modified: db/derby/docs/branches/10.10/src/ref/rrefsyscspeeksequence.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsyscspeeksequence.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsyscspeeksequence.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsyscspeeksequence.dita Thu Nov 14 21:07:06 2013
@@ -20,14 +20,15 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsyscspeeksequence" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_PEEK_AT_SEQUENCE system function</title>
-<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_PEEK_AT_SEQUENCE</codeph> function
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_PEEK_AT_SEQUENCE</codeph> function
allows users to observe the instantaneous current value of a sequence generator
-without having to query the
-<xref href="rrefsistabssyssequences.dita#rrefsistabssyssequences"></xref>.
-Querying the SYSSEQUENCES table does not actually return the current value; it
-only returns an upper bound on that value, that is, the end of the chunk of
-sequence values which has been preallocated but not actually used. The
+without having to query the SYSSEQUENCES system table.</shortdesc>
+<refbody>
+<section><p>Querying the
+<xref href="rrefsistabssyssequences.dita#rrefsistabssyssequences"></xref> does
+not actually return the current value; it only returns an upper bound on that
+value, that is, the end of the chunk of sequence values which has been
+preallocated but not actually used. The
<codeph>SYSCS_UTIL.SYSCS_PEEK_AT_SEQUENCE</codeph> function shows you the very
next value which will be returned by a NEXT VALUE FOR clause. Users should never
directly query the SYSSEQUENCES table, because that will cause sequence
Modified: db/derby/docs/branches/10.10/src/ref/rrefsyscsruntimestatsfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefsyscsruntimestatsfunc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefsyscsruntimestatsfunc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefsyscsruntimestatsfunc.dita Thu Nov 14 21:07:06 2013
@@ -20,16 +20,18 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefsyscsruntimestatsfunc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</codeph> function
+returns a VARCHAR(32672) value representing the query execution plan and runtime
+statistics for a <i>java.sql.ResultSet</i>.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</codeph> function
-returns a VARCHAR(32672) value representing the query execution plan and run
-time statistics for a java.sql.ResultSet. A query execution plan is a tree
-of execution nodes. There are a number of possible node types. Statistics
-are accumulated during execution at each node. The types of statistics include
-the amount of time spent in specific operations, the number of rows passed
-to the node by its children, and the number of rows returned by the node to
-its parent. (The exact statistics are specific to each node type.) <codeph>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</codeph> is
-most meaningful for DML statements such as SELECT, INSERT, DELETE and UPDATE.</p></section>
+<section><p>A query execution plan is a tree of execution nodes. There are a
+number of possible node types. Statistics are accumulated during execution at
+each node. The types of statistics include the amount of time spent in specific
+operations, the number of rows passed to the node by its children, and the
+number of rows returned by the node to its parent. (The exact statistics are
+specific to each node type.)
+<codeph>SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS</codeph> is most meaningful for
+DML statements such as SELECT, INSERT, DELETE and UPDATE.</p></section>
<section><title>Syntax</title> <codeblock>VARCHAR(32672) SYSCS_UTIL.SYSCS_GET_RUNTIMESTATISTICS() </codeblock></section>
<section><title>Execute privileges</title>
<p>By default, all users have execute privileges on this function.</p>
Modified: db/derby/docs/branches/10.10/src/ref/rrefunfreezedbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefunfreezedbproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefunfreezedbproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefunfreezedbproc.dita Thu Nov 14 21:07:06 2013
@@ -20,11 +20,11 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefunfreezedbproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE system procedure</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE</codeph> system
+procedure unfreezes a database after backup.</shortdesc>
<refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE</codeph> system
-procedure unfreezes a database after backup.</p>
-<p>See "Using operating system commands with the freeze and unfreeze system
-procedures to perform an online backup" in the
+<section><p>See "Using operating system commands with the freeze and unfreeze
+system procedures to perform an online backup" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
this procedure.</p>
</section>
Modified: db/derby/docs/branches/10.10/src/ref/rrefupdatestatsproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefupdatestatsproc.dita?rev=1542079&r1=1542078&r2=1542079&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefupdatestatsproc.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefupdatestatsproc.dita Thu Nov 14 21:07:06 2013
@@ -19,9 +19,10 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefupdatestatsproc" xml:lang="en-us">
<title>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS system procedure</title>
-<shortdesc>The SYSCS_UTIL.SYSCS_UPDATE_STATISTICS system procedure updates the
-cardinality statistics, or creates the statistics if they do not exist, for the
-index that you specify or for all of the indexes on a table.</shortdesc>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS</codeph> system
+procedure updates the cardinality statistics, or creates the statistics if they
+do not exist, for the index that you specify or for all of the indexes on a
+table.</shortdesc>
<prolog><metadata>
<keywords>
<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS</indexterm></indexterm>
@@ -33,19 +34,20 @@ system procedure</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> uses cardinality statistics to determine
-the optimal query plan during the compilation of a query. If the statistics
-are missing, <ph conref="../conrefs.dita#prod/productshortname"></ph> might use a query plan which is not the
-most efficient plan. </p>
-<p>Once statistics have been created, they should be
-maintained. It is a good idea to call the SYSCS_UTIL.SYSCS_UPDATE_STATISTICS
-procedure when the number of distinct values in an index is likely to have
-changed significantly. To drop all existing statistics and start again from
-scratch, call the
-<xref href="rrefdropstatsproc.dita#rrefdropstatsproc"></xref>.</p>
-<p>For more information on cardinality statistics,
-see "Working with cardinality statistics" in the <ph
-conref="../conrefs.dita#pub/cittuning"></ph> guide.</p></section>
+<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> uses
+cardinality statistics to determine the optimal query plan during the
+compilation of a query. If the statistics are missing,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> might use a query plan
+which is not the most efficient plan.</p>
+<p>Once statistics have been created, they should be maintained. It is a good
+idea to call the <codeph>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS</codeph> procedure
+when the number of distinct values in an index is likely to have changed
+significantly. To drop all existing statistics and start again from scratch,
+call the
+<codeph><xref href="rrefdropstatsproc.dita#rrefdropstatsproc">SYSCS_UTIL.SYSCS_DROP_STATISTICS</xref></codeph>
+system procedure.</p>
+<p>For more information on cardinality statistics, see "Working with cardinality
+statistics" in <ph conref="../conrefs.dita#pub/cittuning"></ph>.</p></section>
<section><title>Syntax</title>
<codeblock>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS(IN SCHEMANAME VARCHAR(128),
IN TABLENAME VARCHAR(128),