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 2012/05/23 16:09:46 UTC
svn commit: r1341869 - in /db/derby/docs/trunk/src: adminguide/ devguide/
getstart/ ref/
Author: chaase3
Date: Wed May 23 14:09:45 2012
New Revision: 1341869
URL: http://svn.apache.org/viewvc?rev=1341869&view=rev
Log:
DERBY-5508 Improve backup/restore documentation visibility and content to encourage proper backups and restore procedures
Modified 2 Getting Started topics, 3 Developer's Guide topics, 6 Reference Manual topics, and 7 Admin Guide topics.
Patch: DERBY-5508-2.diff
Modified:
db/derby/docs/trunk/src/adminguide/cadminbckupdb.dita
db/derby/docs/trunk/src/adminguide/cadminconsist01.dita
db/derby/docs/trunk/src/adminguide/cadminhubbkup01.dita
db/derby/docs/trunk/src/adminguide/cadminhubbkup12677.dita
db/derby/docs/trunk/src/adminguide/cadminhubbkup63476.dita
db/derby/docs/trunk/src/adminguide/cadminhubbkup67525.dita
db/derby/docs/trunk/src/adminguide/cadminhubbkup98797.dita
db/derby/docs/trunk/src/devguide/tdevcsecurenewbootpw.dita
db/derby/docs/trunk/src/devguide/tdevcsecurenewextkey.dita
db/derby/docs/trunk/src/devguide/tdevcsecureunencrypteddb.dita
db/derby/docs/trunk/src/getstart/cgsquck19524.dita
db/derby/docs/trunk/src/getstart/cwwdsummary.dita
db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita
db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita
db/derby/docs/trunk/src/ref/rreffreezedbproc.dita
db/derby/docs/trunk/src/ref/rrefsyscschecktablefunc.dita
db/derby/docs/trunk/src/ref/rrefunfreezedbproc.dita
Modified: db/derby/docs/trunk/src/adminguide/cadminbckupdb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminbckupdb.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminbckupdb.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminbckupdb.dita Wed May 23 14:09:45 2012
@@ -20,8 +20,16 @@ limitations under the License.
"../dtd/concept.dtd">
<concept id="cadminbckupdb" xml:lang="en-us">
<title>Backing up a database</title>
+<shortdesc>You can back up a database either offline (when it is shut down) or
+online (when it is running).</shortdesc>
<prolog></prolog>
<conbody>
+<p>After you back up a database, make sure the backup copy is not corrupt. To
+do this, run the SYSCS_UTIL.SYSCS_CHECK_TABLE system function on all the tables
+in the backup copy. Do not discard the previous backup until you have verified
+the consistency of the current one. See
+<xref href="cadminconsist01.dita#cadminconsist01"></xref> for more
+information.</p>
<p>The topics in this section describe how to back up a database.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/adminguide/cadminconsist01.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminconsist01.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminconsist01.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminconsist01.dita Wed May 23 14:09:45 2012
@@ -19,15 +19,20 @@ limitations under the License.
-->
<concept id="cadminconsist01" xml:lang="en-us">
<title>Checking database consistency</title>
-<shortdesc>If you experience hardware or operating system failure, you can use the SYSCS_UTIL.SYSCS_CHECK_TABLE function to verify that the database is still consistent.</shortdesc>
+<shortdesc>After you perform a backup, or if you experience hardware or
+operating system failure, you can use the SYSCS_UTIL.SYSCS_CHECK_TABLE system
+function to verify that the database is still consistent.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Consistency<indexterm>checking database</indexterm></indexterm>
</keywords>
</metadata></prolog>
<conbody>
-<p>Check consistency only if there are indications that such
-a check is needed because a consistency check can take a long time on a large
-database.</p>
+<p>It is recommended that you run SYSCS_UTIL.SYSCS_CHECK_TABLE on all 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, because a
+consistency check can take a long time on a large database.</p>
+<p>See the <ph conref="../conrefs.dita#pub/citref"></ph> for details about this
+system function.</p>
</conbody>
</concept>
-
Modified: db/derby/docs/trunk/src/adminguide/cadminhubbkup01.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminhubbkup01.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminhubbkup01.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminhubbkup01.dita Wed May 23 14:09:45 2012
@@ -19,22 +19,39 @@ See the License for the specific languag
limitations under the License.
-->
<concept id="cadminhubbkup01" xml:lang="en-us">
-<title>Using the backup procedure to perform an online backup</title>
-<shortdesc>Use the SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure to perform an
+<title>Using the backup procedures to perform an online backup</title>
+<shortdesc>Use the SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure or one of the
+other system backup procedures to perform an
online backup of a database to a specified location.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Backup procedure</indexterm><indexterm>SYSCS_BACKUP_DATABASE()
system procedure</indexterm></keywords>
</metadata></prolog>
<conbody>
+<p>The backup procedures are as follows:</p>
+<ul>
+<li>SYSCS_UTIL.SYSCS_BACKUP_DATABASE</li>
+<li>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</li>
+<li>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE</li>
+<li>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT </li>
+</ul>
+<p>Use the SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE
+procedure if you want to make it possible to perform a roll-forward recovery of
+a damaged database. See
+<xref href="cadminrollforward.dita#cadminrollforward"></xref> for details.</p>
+<p>The NOWAIT versions of the procedures do not wait for transactions
+in progress with unlogged operations to complete before proceeding with the
+backup; instead, they return an error immediately.</p>
+<p>See the <ph conref="../conrefs.dita#pub/citref"></ph> for details about these
+system procedures.</p>
<p>The SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure takes a string argument
that represents the location in which to back up the database. Typically,
you provide the full path to the backup directory. (Relative paths are interpreted
as relative to the current directory, not to the derby.system.home directory.)</p>
-<p>For example, to specify a backup location of <filepath>c:/mybackups/2005-06-01</filepath> for
+<p>For example, to specify a backup location of <filepath>c:/mybackups/2012-04-01</filepath> for
a database that is currently open, use the following statement (forward slashes
are used as path separators in SQL commands):</p>
-<codeblock><b>CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/mybackups/2005-06-01')</b></codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/mybackups/2012-04-01')</b></codeblock>
<p>The SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure puts the database
into a state in which it can be safely copied. The procedure then copies the
entire original database directory (including data files, online transaction log
@@ -59,8 +76,8 @@ cs.execute();
cs.close();
System.out.println("backed up database to "+backupdirectory);
}</codeblock>
-<p>For a database that was backed up on 2005-06-01, the previous commands
-copy the current database to a directory of the same name in <i>c:/mybackups/2005-06-01</i>.</p>
+<p>For a database that was backed up on 2012-04-01, the previous commands
+copy the current database to a directory of the same name in <i>c:/mybackups/2012-04-01</i>.</p>
<p>Uncommitted transactions do not appear in the backed-up database.</p>
<note>Do not back up different databases with the same name to the same backup
directory. If a database of the same name already exists in the backup directory,
Modified: db/derby/docs/trunk/src/adminguide/cadminhubbkup12677.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminhubbkup12677.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminhubbkup12677.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminhubbkup12677.dita Wed May 23 14:09:45 2012
@@ -20,15 +20,16 @@ limitations under the License.
"../dtd/concept.dtd">
<concept id="cadminhubbkup12677" xml:lang="en-us">
<title>Offline backups</title>
+<shortdesc>To perform an offline backup of a database, use operating system
+commands to copy the database directory.</shortdesc>
<prolog></prolog>
<conbody>
-<p>To perform an offline backup of a database, use operating system
-commands to copy the database directory. You must shut down the database prior
-to performing an offline backup. </p>
+<p><note type="important">You must shut down the database before you perform an
+offline backup.</note></p>
<p>For example, on Windows systems, the following operating system command
backs up a (closed) database that is named <i>sample</i> and that is located in <filepath>d:\mydatabases</filepath> by
-copying it to the directory <filepath>c:\mybackups\2005-06-01</filepath>:</p>
-<codeblock>xcopy d:\mydatabases\sample c:\mybackups\2005-06-01\sample /s /i</codeblock>
+copying it to the directory <filepath>c:\mybackups\2012-04-01</filepath>:</p>
+<codeblock>xcopy d:\mydatabases\sample c:\mybackups\2012-04-01\sample /s /i</codeblock>
<p>If you are not using Windows, substitute the appropriate operating
system command for copying a directory and all contents to a new location.</p>
<note>On Windows systems, do not attempt to update a database while it is being
@@ -37,6 +38,12 @@ backup will generate a java.io.IOExcepti
this from occurring.</note>
<p>For large systems, shutting down the database might not be convenient.
To back up a database without having to shut it down, you can use an online backup.</p>
+<p>After you back up a database, make sure the backup copy is not corrupt. To
+do this, run the SYSCS_UTIL.SYSCS_CHECK_TABLE system function on all the tables
+in the backup copy. Do not discard the previous backup until you have verified
+the consistency of the current one. See
+<xref href="cadminconsist01.dita#cadminconsist01"></xref> for more
+information.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/adminguide/cadminhubbkup63476.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminhubbkup63476.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminhubbkup63476.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminhubbkup63476.dita Wed May 23 14:09:45 2012
@@ -20,12 +20,12 @@ limitations under the License.
-->
<concept id="cadminhubbkup63476" xml:lang="en-us">
<title>Online backups</title>
+<shortdesc>Use online backups to back up a database while it is running, without
+blocking transactions.</shortdesc>
<prolog></prolog>
<conbody>
-<p>Use online backups to back up a database while it is running, without
-blocking transactions.</p>
<p>You can perform online backups by using several types of backup procedures
-or by using operating systems commands with the freeze and unfreeze system
+or by using operating system commands with the freeze and unfreeze system
procedures.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/adminguide/cadminhubbkup67525.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminhubbkup67525.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminhubbkup67525.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminhubbkup67525.dita Wed May 23 14:09:45 2012
@@ -28,8 +28,8 @@ up the database, be aware of the followi
<ul>
<li>If you are using an operating system command to back up the database,
you must explicitly copy the log file as well, as shown in the following example:
- <codeblock>xcopy d:\mydatabases\sample c:\mybackups\2005-06-01\sample /s /i
-xcopy h:\janet\tourslog\log c:\mybackups\2005-06-01\sample\log /s /i</codeblock></li>
+ <codeblock>xcopy d:\mydatabases\sample c:\mybackups\2012-04-01\sample /s /i
+xcopy h:\janet\tourslog\log c:\mybackups\2012-04-01\sample\log /s /i</codeblock></li>
</ul>
<p>If you are not using Windows, substitute the appropriate operating system
command for copying a directory and all of its contents to a new location.</p>
@@ -37,7 +37,7 @@ command for copying a directory and all
<li>Edit the <i>logDevice</i> entry in <i>service.properties</i> of the database
backup so that it points to the correct location for the log. In the previous
example, the log was moved to the default location for a log, so you can remove
-the logDevice entry entirely, or leave the logDevice entry as is and wait
+the <i>logDevice</i> entry entirely, or leave the <i>logDevice</i> entry as is and wait
until the database is restored to edit the entry.</li>
</ul>
<p>See <xref href="cadminlog98.dita#cadminlog98"></xref> for information about
Modified: db/derby/docs/trunk/src/adminguide/cadminhubbkup98797.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminhubbkup98797.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminhubbkup98797.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminhubbkup98797.dita Wed May 23 14:09:45 2012
@@ -21,10 +21,34 @@ limitations under the License.
<concept id="cadminhubbkup98797" xml:lang="en-us">
<title>Backing up and restoring databases</title>
<shortdesc><ph conref="../conrefs.dita#prod/productshortname"></ph> provides
-a way to back up a database while it is online. You can also restore a full
-backup from a specified location.</shortdesc>
+a way to back up a database while it is either offline or online. You can also
+restore a full backup from a specified location.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Backing up databases</indexterm></keywords>
</metadata></prolog>
-<conbody></conbody>
+<conbody>
+<p>To back up a database, you can do any of the following:</p>
+<ul>
+<li>Shut down the database and use operating system commands to copy it to a
+backup location, as described in
+<xref href="cadminhubbkup12677.dita#cadminhubbkup12677"></xref>.</li>
+<li>Leave the database running and call one of four system backup procedures to copy
+it to a backup location, as described in
+<xref href="cadminhubbkup01.dita#cadminhubbkup01"></xref>.</li>
+<li>Leave the database running, but call a system procedure to freeze the
+database, use operating system commands to copy it to a backup location, then
+call a system procedure to unfreeze the database, as described in
+<xref href="cadminhubbkup75469.dita#cadminhubbkup75469"></xref>.</li>
+</ul>
+<p>To restore a database from a backup copy, you must use one of three
+connection URL attributes:</p>
+<ul>
+<li><codeph>restoreFrom=<i>path</i></codeph>, described in
+<xref href="tadminhubbkup44.dita#tadminhubbkup44"></xref></li>
+<li><codeph>createFrom=<i>path</i></codeph>, described in
+<xref href="tadmincrtdbbkup.dita#tadmincrtdbbkup"></xref></li>
+<li><codeph>rollForwardRecoveryFrom=<i>path</i></codeph>, described in
+<xref href="cadminrollforward.dita#cadminrollforward"></xref></li>
+</ul>
+</conbody>
</concept>
Modified: db/derby/docs/trunk/src/devguide/tdevcsecurenewbootpw.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/tdevcsecurenewbootpw.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/tdevcsecurenewbootpw.dita (original)
+++ db/derby/docs/trunk/src/devguide/tdevcsecurenewbootpw.dita Wed May 23 14:09:45 2012
@@ -63,7 +63,9 @@ with the new encryption key, and is prot
</info>
<info><p>If you disabled log archival before you applied the new boot
password, create a new backup of the database after the database is reconfigured
-with the new boot password.</p></info></step>
+with the new boot password. For more information, see the section "Backing up
+and restoring databases" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>,
+particularly "Roll-forward recovery".</p></info></step>
</steps>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/devguide/tdevcsecurenewextkey.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/tdevcsecurenewextkey.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/tdevcsecurenewextkey.dita (original)
+++ db/derby/docs/trunk/src/devguide/tdevcsecurenewextkey.dita Wed May 23 14:09:45 2012
@@ -58,8 +58,9 @@ with the new encryption key 686263646566
</info>
<info><p>If you disabled log archival before you applied the new encryption
key, create a new backup of the database after the database is reconfigured
-with new the encryption key.
-</p></info></step>
+with the new encryption key. For more information, see the section "Backing up
+and restoring databases" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>,
+particularly "Roll-forward recovery".</p></info></step>
</steps>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/devguide/tdevcsecureunencrypteddb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/tdevcsecureunencrypteddb.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/tdevcsecureunencrypteddb.dita (original)
+++ db/derby/docs/trunk/src/devguide/tdevcsecureunencrypteddb.dita Wed May 23 14:09:45 2012
@@ -74,7 +74,10 @@ in the URL:<codeblock>jdbc:derby:salesdb
</info>
<info><p>
If you disabled log archival before you encrypted the database, create
-a new backup of the database after the database is encrypted.</p></info></step>
+a new backup of the database after the database is encrypted. For more
+information, see the section "Backing up and restoring databases" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>, particularly "Roll-forward
+recovery".</p></info></step>
</steps>
</taskbody>
</task>
Modified: db/derby/docs/trunk/src/getstart/cgsquck19524.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cgsquck19524.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/cgsquck19524.dita (original)
+++ db/derby/docs/trunk/src/getstart/cgsquck19524.dita Wed May 23 14:09:45 2012
@@ -25,6 +25,8 @@ driver.</shortdesc>
<conbody>
<p>For more detailed information on the topics covered in this section, see
the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite> and the <cite><ph
-conref="../conrefs.dita#pub/citutilities"></ph></cite>.</p>
+conref="../conrefs.dita#pub/citutilities"></ph></cite>. See
+<xref href="rgsdocs17307.dita#rgsdocs17307"></xref> for an overview of the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> documentation.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/getstart/cwwdsummary.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/getstart/cwwdsummary.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/getstart/cwwdsummary.dita (original)
+++ db/derby/docs/trunk/src/getstart/cwwdsummary.dita Wed May 23 14:09:45 2012
@@ -25,38 +25,43 @@ You now have experience with using <ph
both the embedded and client/server architectures.</shortdesc>
<conbody>
<p>With this basic knowledge, you are ready to begin using <ph conref="../conrefs.dita#prod/productshortname"></ph> to
-address your own specific needs. As your next step in learning about this
-lightweight and powerful tool, visit the <ph conref="../conrefs.dita#prod/productlongname"></ph> Web
-site.</p>
-<lines importance="high"><b>Use this link:</b> <xref format="html"
-href="http://wiki.apache.org/db-derby/WorkingWithDerby" importance="high"
-scope="external"><b>WorkingWithDerby Resources page</b></xref>
-<b>Browser URL</b>: <codeph><b>http://wiki.apache.org/db-derby/WorkingWithDerby</b></codeph></lines>
-<section><title>Activities summary</title><p>We hope these activities have
-helped you understand the steps needed to create and access <ph conref="../conrefs.dita#prod/productshortname"></ph> databases.
-Although <ph conref="../conrefs.dita#prod/productshortname"></ph> is easy
-to set up and use, you will find that it has the features and reliability
-of much larger database systems. The examples presented here do not begin
-to scratch the surface of what can be done.</p><p>Please take a few moments
-to become familiar with the many online resources available to <ph conref="../conrefs.dita#prod/productshortname"></ph> users
-and developers by browsing the <xref format="html" href="http://db.apache.org/derby/index.html"
+address your own specific needs. To learn more about this lightweight and
+powerful tool, refer to the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> documentation,
+described in <xref href="rgsdocs17307.dita#rgsdocs17307"></xref>.</p>
+<p>Also, take a few moments
+to become familiar with the many online resources available to
+<ph conref="../conrefs.dita#prod/productshortname"></ph> users and developers by
+browsing the <xref format="html" href="http://db.apache.org/derby/index.html"
scope="external"><ph conref="../conrefs.dita#prod/productshortname"></ph> Web
-site</xref> at Apache. Whether you are performing a general evaluation of
- <ph conref="../conrefs.dita#prod/productshortname"></ph> or have a specific
-need to address, the link to the WorkingWith<ph conref="../conrefs.dita#prod/productshortname"></ph> resources
-page is a good stepping stone to finding additional information of interest:</p><ul>
+site</xref> at Apache as well as the
+<xref format="html" href="http://wiki.apache.org/db-derby/FrontPage"
+scope="external"><ph conref="../conrefs.dita#prod/productshortname"></ph>
+Wiki</xref>. Whether you are performing a general evaluation of
+<ph conref="../conrefs.dita#prod/productshortname"></ph> or have a specific
+need to address, these links are a good stepping stone to finding additional
+information of interest:</p><ul>
+<li>The "Learning material and other references" section on the front page of
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> Wiki provides links
+to tutorials and other useful materials.</li>
<li>The <xref format="html" href="http://db.apache.org/derby/quick_start.html"
scope="external"><ph conref="../conrefs.dita#prod/productshortname"></ph> Quick
Start page</xref> is a good reference page organized by area of interest.</li>
-<li>You will find that many content-rich areas, such as the <ph conref="../conrefs.dita#prod/productshortname"></ph> Wiki
-and the <ph conref="../conrefs.dita#prod/productshortname"></ph> Users mailing
+<li>You will find that many content-rich areas, such as the <ph conref="../conrefs.dita#prod/productshortname"></ph> Users mailing
list, are available to you.</li>
<li>If you are interested in how others are using <ph conref="../conrefs.dita#prod/productshortname"></ph>,
-see the Uses of <ph conref="../conrefs.dita#prod/productshortname"></ph> page
+see the Uses of <ph conref="../conrefs.dita#prod/productshortname"></ph> page
on the Wiki. This page contains informational links to development projects
and products that use <ph conref="../conrefs.dita#prod/productshortname"></ph>.
When you implement a system using <ph conref="../conrefs.dita#prod/productshortname"></ph>,
please add it to this list.</li>
-</ul></section>
+</ul>
+<section><title>Activities summary</title><p>We hope these activities have
+helped you understand the steps needed to create and access <ph conref="../conrefs.dita#prod/productshortname"></ph> databases.
+Although <ph conref="../conrefs.dita#prod/productshortname"></ph> is easy
+to set up and use, you will find that it has the features and reliability
+of much larger database systems. The examples presented here do not begin
+to scratch the surface of what can be done.</p>
+</section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita Wed May 23 14:09:45 2012
@@ -28,7 +28,11 @@ limitations under the License.
<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></section>
+the database for log archive mode.</p>
+<p>See "Roll-forward recovery" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
+this procedure.</p>
+</section>
<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE
(IN BACKUPDIR VARCHAR(32672), IN SMALLINT DELETE_ARCHIVED_LOG_FILES)
</codeblock><p>No result is returned from the procedure.</p><dl><dlentry>
Modified: db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita Wed May 23 14:09:45 2012
@@ -27,7 +27,11 @@ limitations under the License.
</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></section>
+backs up the database to a specified backup directory.</p>
+<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>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE(IN BACKUPDIR VARCHAR()) </codeblock> <p>No
result is returned from the procedure.</p> <dl><dlentry>
<dt>BACKUPDIR</dt>
Modified: db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita Wed May 23 14:09:45 2012
@@ -23,13 +23,17 @@ limitations under the License.
<section><p>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></section>
+is non-zero. </p>
+<p>See "Roll-forward recovery" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
+this procedure.</p>
+</section>
<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE(IN SMALLINT DELETE_ARCHIVED_LOG_FILES) </codeblock><p>No
result is returned from the procedure.</p><dl><dlentry>
<dt>DELETE_ARCHIVED_LOG_FILES</dt>
<dd>If the input parameter value for the DELETE_ARCHIVED_LOG_FILES parameter
is a non-zero value, then all existing online archived log files are deleted.
-If the parameter value is zero, then exiting online archived log files are
+If the parameter value is zero, then existing online archived log files are
not deleted.</dd>
</dlentry></dl></section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/trunk/src/ref/rreffreezedbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rreffreezedbproc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rreffreezedbproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rreffreezedbproc.dita Wed May 23 14:09:45 2012
@@ -22,7 +22,12 @@ limitations under the License.
<title>SYSCS_UTIL.SYSCS_FREEZE_DATABASE system procedure</title>
<refbody>
<section><p>The <codeph>SYSCS_UTIL.SYSCS_FREEZE_DATABASE</codeph> system procedure
-temporarily freezes the database for backup.</p></section>
+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
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
+this procedure.</p>
+</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_FREEZE_DATABASE()</codeblock> <p>No
result set is returned by this procedure.</p></section>
<section><title>Execute privileges</title>
Modified: db/derby/docs/trunk/src/ref/rrefsyscschecktablefunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscschecktablefunc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscschecktablefunc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefsyscschecktablefunc.dita Wed May 23 14:09:45 2012
@@ -24,7 +24,16 @@ limitations under the License.
<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></section>
+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>
<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
or TABLENAME are null.</p></refsyn>
Modified: db/derby/docs/trunk/src/ref/rrefunfreezedbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefunfreezedbproc.dita?rev=1341869&r1=1341868&r2=1341869&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefunfreezedbproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefunfreezedbproc.dita Wed May 23 14:09:45 2012
@@ -22,7 +22,12 @@ limitations under the License.
<title>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE system procedure</title>
<refbody>
<section><p>The <codeph>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE</codeph> system
-procedure unfreezes a database after backup.</p></section>
+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
+<ph conref="../conrefs.dita#pub/citadmin"></ph> for more information on using
+this procedure.</p>
+</section>
<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE()</codeblock> <p>No
result set is returned by this procedure.</p></section>
<section><title>Execute privileges</title>