Return-Path: X-Original-To: apmail-db-derby-commits-archive@www.apache.org Delivered-To: apmail-db-derby-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id AA9B5C1FD for ; Wed, 23 May 2012 14:54:44 +0000 (UTC) Received: (qmail 47304 invoked by uid 500); 23 May 2012 14:54:44 -0000 Delivered-To: apmail-db-derby-commits-archive@db.apache.org Received: (qmail 47226 invoked by uid 500); 23 May 2012 14:54:44 -0000 Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Derby Development" List-Id: Delivered-To: mailing list derby-commits@db.apache.org Received: (qmail 47215 invoked by uid 99); 23 May 2012 14:54:44 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 May 2012 14:54:44 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 May 2012 14:54:41 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 6972223888CD; Wed, 23 May 2012 14:54:21 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1341882 - in /db/derby/docs/branches/10.8/src: adminguide/ devguide/ getstart/ ref/ Date: Wed, 23 May 2012 14:54:20 -0000 To: derby-commits@db.apache.org From: chaase3@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120523145421.6972223888CD@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: chaase3 Date: Wed May 23 14:54:18 2012 New Revision: 1341882 URL: http://svn.apache.org/viewvc?rev=1341882&view=rev Log: DERBY-5508 Improve backup/restore documentation visibility and content to encourage proper backups and restore procedures Merged DERBY-5508-2.diff to 10.8 docs branch from trunk revision 1341869. Modified: db/derby/docs/branches/10.8/src/adminguide/cadminbckupdb.dita db/derby/docs/branches/10.8/src/adminguide/cadminconsist01.dita db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup01.dita db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup12677.dita db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup63476.dita db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup67525.dita db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup98797.dita db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewbootpw.dita db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewextkey.dita db/derby/docs/branches/10.8/src/devguide/tdevcsecureunencrypteddb.dita db/derby/docs/branches/10.8/src/getstart/cgsquck19524.dita db/derby/docs/branches/10.8/src/getstart/cwwdsummary.dita db/derby/docs/branches/10.8/src/ref/rrefbackupdbenablelogproc.dita db/derby/docs/branches/10.8/src/ref/rrefbackupdbproc.dita db/derby/docs/branches/10.8/src/ref/rrefdisablelogproc.dita db/derby/docs/branches/10.8/src/ref/rreffreezedbproc.dita db/derby/docs/branches/10.8/src/ref/rrefsyscschecktablefunc.dita db/derby/docs/branches/10.8/src/ref/rrefunfreezedbproc.dita Modified: db/derby/docs/branches/10.8/src/adminguide/cadminbckupdb.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminbckupdb.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminbckupdb.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminbckupdb.dita Wed May 23 14:54:18 2012 @@ -20,8 +20,16 @@ limitations under the License. "../dtd/concept.dtd"> Backing up a database +You can back up a database either offline (when it is shut down) or +online (when it is running). +

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 + for more +information.

The topics in this section describe how to back up a database.

 Modified: db/derby/docs/branches/10.8/src/adminguide/cadminconsist01.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminconsist01.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminconsist01.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminconsist01.dita Wed May 23 14:54:18 2012 @@ -19,15 +19,20 @@ limitations under the License. --> Checking database consistency -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. +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. Consistencychecking database -

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.

+

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.

+

See the for details about this +system function.

 - Modified: db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup01.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup01.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup01.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup01.dita Wed May 23 14:54:18 2012 @@ -19,22 +19,39 @@ See the License for the specific languag limitations under the License. --> -Using the backup procedure to perform an online backup -Use the SYSCS_UTIL.SYSCS_BACKUP_DATABASE procedure to perform an +Using the backup procedures to perform an online backup +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. Backup procedureSYSCS_BACKUP_DATABASE() system procedure +

The backup procedures are as follows:

+
    +
  • SYSCS_UTIL.SYSCS_BACKUP_DATABASE
    • +
  • SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT
    • +
  • SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE
    • +
  • SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT
    • +
+

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 + for details.

+

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.

+

See the for details about these +system procedures.

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.)

-

For example, to specify a backup location of c:/mybackups/2005-06-01 for +

For example, to specify a backup location of c:/mybackups/2012-04-01 for a database that is currently open, use the following statement (forward slashes are used as path separators in SQL commands):

-CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/mybackups/2005-06-01') +CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/mybackups/2012-04-01')

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); } -

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 c:/mybackups/2005-06-01.

+

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 c:/mybackups/2012-04-01.

Uncommitted transactions do not appear in the backed-up database.

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/branches/10.8/src/adminguide/cadminhubbkup12677.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup12677.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup12677.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup12677.dita Wed May 23 14:54:18 2012 @@ -20,15 +20,16 @@ limitations under the License. "../dtd/concept.dtd"> Offline backups +To perform an offline backup of a database, use operating system +commands to copy the database directory. -

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.

+

You must shut down the database before you perform an +offline backup.

For example, on Windows systems, the following operating system command backs up a (closed) database that is named sample and that is located in d:\mydatabases by -copying it to the directory c:\mybackups\2005-06-01:

-xcopy d:\mydatabases\sample c:\mybackups\2005-06-01\sample /s /i +copying it to the directory c:\mybackups\2012-04-01:

+xcopy d:\mydatabases\sample c:\mybackups\2012-04-01\sample /s /i

If you are not using Windows, substitute the appropriate operating system command for copying a directory and all contents to a new location.

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.

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.

+

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 + for more +information.

 Modified: db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup63476.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup63476.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup63476.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup63476.dita Wed May 23 14:54:18 2012 @@ -20,12 +20,12 @@ limitations under the License. --> Online backups +Use online backups to back up a database while it is running, without +blocking transactions. -

Use online backups to back up a database while it is running, without -blocking transactions.

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.

 Modified: db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup67525.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup67525.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup67525.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup67525.dita Wed May 23 14:54:18 2012 @@ -28,8 +28,8 @@ up the database, be aware of the followi
  • 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: - 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
    • + 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

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.

@@ -37,7 +37,7 @@ command for copying a directory and all
  • Edit the logDevice entry in service.properties 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 logDevice entry entirely, or leave the logDevice entry as is and wait until the database is restored to edit the entry.

    • See for information about Modified: db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup98797.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup98797.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup98797.dita (original) +++ db/derby/docs/branches/10.8/src/adminguide/cadminhubbkup98797.dita Wed May 23 14:54:18 2012 @@ -21,10 +21,34 @@ limitations under the License. Backing up and restoring databases provides -a way to back up a database while it is online. You can also restore a full -backup from a specified location. +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. Backing up databases - + +

    To back up a database, you can do any of the following:

    +
      +
    • Shut down the database and use operating system commands to copy it to a +backup location, as described in +.
      • +
    • Leave the database running and call one of four system backup procedures to copy +it to a backup location, as described in +.
      • +
    • 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 +.
      • +
    +

    To restore a database from a backup copy, you must use one of three +connection URL attributes:

    +
      +
    • restoreFrom=path, described in +
      • +
    • createFrom=path, described in +
      • +
    • rollForwardRecoveryFrom=path, described in +
      • +
    +         Modified: db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewbootpw.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewbootpw.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewbootpw.dita (original) +++ db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewbootpw.dita Wed May 23 14:54:18 2012 @@ -63,7 +63,9 @@ with the new encryption key, and is prot

    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.

     +with the new boot password. For more information, see the section "Backing up +and restoring databases" in the , +particularly "Roll-forward recovery".

    Modified: db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewextkey.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewextkey.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewextkey.dita (original) +++ db/derby/docs/branches/10.8/src/devguide/tdevcsecurenewextkey.dita Wed May 23 14:54:18 2012 @@ -58,8 +58,9 @@ with the new encryption key 686263646566

    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. -

     +with the new encryption key. For more information, see the section "Backing up +and restoring databases" in the , +particularly "Roll-forward recovery".

    Modified: db/derby/docs/branches/10.8/src/devguide/tdevcsecureunencrypteddb.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/devguide/tdevcsecureunencrypteddb.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/devguide/tdevcsecureunencrypteddb.dita (original) +++ db/derby/docs/branches/10.8/src/devguide/tdevcsecureunencrypteddb.dita Wed May 23 14:54:18 2012 @@ -74,7 +74,10 @@ in the URL:jdbc:derby:salesdb

    If you disabled log archival before you encrypted the database, create -a new backup of the database after the database is encrypted.

     +a new backup of the database after the database is encrypted. For more +information, see the section "Backing up and restoring databases" in the +, particularly "Roll-forward +recovery".

    Modified: db/derby/docs/branches/10.8/src/getstart/cgsquck19524.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/getstart/cgsquck19524.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/getstart/cgsquck19524.dita (original) +++ db/derby/docs/branches/10.8/src/getstart/cgsquck19524.dita Wed May 23 14:54:18 2012 @@ -25,6 +25,8 @@ driver.

    For more detailed information on the topics covered in this section, see the and the .

    +conref="../conrefs.dita#pub/citutilities">. See + for an overview of the + documentation.

     Modified: db/derby/docs/branches/10.8/src/getstart/cwwdsummary.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/getstart/cwwdsummary.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/getstart/cwwdsummary.dita (original) +++ db/derby/docs/branches/10.8/src/getstart/cwwdsummary.dita Wed May 23 14:54:18 2012 @@ -25,38 +25,43 @@ You now have experience with using

    With this basic knowledge, you are ready to begin using to -address your own specific needs. As your next step in learning about this -lightweight and powerful tool, visit the Web -site.

    -Use this link: WorkingWithDerby Resources page -Browser URL: http://wiki.apache.org/db-derby/WorkingWithDerby -
    Activities summary

    We hope these activities have -helped you understand the steps needed to create and access databases. -Although 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.

    Please take a few moments -to become familiar with the many online resources available to users -and developers by browsing the documentation, +described in .

    +

    Also, take a few moments +to become familiar with the many online resources available to + users and developers by +browsing the Web -site at Apache. Whether you are performing a general evaluation of - or have a specific -need to address, the link to the WorkingWith resources -page is a good stepping stone to finding additional information of interest:

      +site at Apache as well as the + +Wiki. Whether you are performing a general evaluation of + or have a specific +need to address, these links are a good stepping stone to finding additional +information of interest:

        +
      • The "Learning material and other references" section on the front page of +the Wiki provides links +to tutorials and other useful materials.
      • The Quick Start page is a good reference page organized by area of interest.
        • -
      • You will find that many content-rich areas, such as the Wiki -and the Users mailing +
      • You will find that many content-rich areas, such as the Users mailing list, are available to you.
      • If you are interested in how others are using , -see the Uses of page +see the Uses of page on the Wiki. This page contains informational links to development projects and products that use . When you implement a system using , please add it to this list.
        • -
    + +
    Activities summary

    We hope these activities have +helped you understand the steps needed to create and access databases. +Although 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.

    +
     Modified: db/derby/docs/branches/10.8/src/ref/rrefbackupdbenablelogproc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefbackupdbenablelogproc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rrefbackupdbenablelogproc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rrefbackupdbenablelogproc.dita Wed May 23 14:54:18 2012 @@ -28,7 +28,11 @@ limitations under the License.

    The SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE system procedure backs up the database to a specified backup directory and enables -the database for log archive mode.

    +the database for log archive mode.

    +

    See "Roll-forward recovery" in the + for more information on using +this procedure.

    +
    SyntaxSYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE (IN BACKUPDIR VARCHAR(32672), IN SMALLINT DELETE_ARCHIVED_LOG_FILES)

    No result is returned from the procedure.

    Modified: db/derby/docs/branches/10.8/src/ref/rrefbackupdbproc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefbackupdbproc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rrefbackupdbproc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rrefbackupdbproc.dita Wed May 23 14:54:18 2012 @@ -27,7 +27,11 @@ limitations under the License.

    The SYSCS_UTIL.SYSCS_BACKUP_DATABASE system procedure -backs up the database to a specified backup directory.

    +backs up the database to a specified backup directory.

    +

    See "Using the backup procedures to perform an online backup" in the + for more information on using +this procedure.

    +
    Syntax SYSCS_UTIL.SYSCS_BACKUP_DATABASE(IN BACKUPDIR VARCHAR())

    No result is returned from the procedure.

    BACKUPDIR
    Modified: db/derby/docs/branches/10.8/src/ref/rrefdisablelogproc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefdisablelogproc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rrefdisablelogproc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rrefdisablelogproc.dita Wed May 23 14:54:18 2012 @@ -23,13 +23,17 @@ limitations under the License.

    The SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE system procedure disables the log archive mode and deletes any existing online archived log files if the DELETE_ARCHIVED_LOG_FILES input parameter -is non-zero.

    +is non-zero.

    +

    See "Roll-forward recovery" in the + for more information on using +this procedure.

    +
    SyntaxSYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE(IN SMALLINT DELETE_ARCHIVED_LOG_FILES)

    No result is returned from the procedure.

    DELETE_ARCHIVED_LOG_FILES
    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.
    Execute privileges Modified: db/derby/docs/branches/10.8/src/ref/rreffreezedbproc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rreffreezedbproc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rreffreezedbproc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rreffreezedbproc.dita Wed May 23 14:54:18 2012 @@ -22,7 +22,12 @@ limitations under the License. SYSCS_UTIL.SYSCS_FREEZE_DATABASE system procedure

    The SYSCS_UTIL.SYSCS_FREEZE_DATABASE system procedure -temporarily freezes the database for backup.

    +temporarily freezes the database for backup.

    +

    See "Using operating system commands with the freeze and unfreeze system +procedures to perform an online backup" in the + for more information on using +this procedure.

    +
    Syntax SYSCS_UTIL.SYSCS_FREEZE_DATABASE()

    No result set is returned by this procedure.

    Execute privileges Modified: db/derby/docs/branches/10.8/src/ref/rrefsyscschecktablefunc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefsyscschecktablefunc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rrefsyscschecktablefunc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rrefsyscschecktablefunc.dita Wed May 23 14:54:18 2012 @@ -24,7 +24,16 @@ limitations under the License.

    The SYSCS_UTIL.SYSCS_CHECK_TABLE 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.

    +with value 1. If the table and indexes are inconsistent, the function will throw an exception.

    +

    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 for +more information.

    +
    Syntax SMALLINT SYSCS_UTIL.SYSCS_CHECK_TABLE(IN SCHEMANAME VARCHAR(128), IN TABLENAME VARCHAR(128))

    An error will occur if either SCHEMANAME or TABLENAME are null.

     Modified: db/derby/docs/branches/10.8/src/ref/rrefunfreezedbproc.dita URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.8/src/ref/rrefunfreezedbproc.dita?rev=1341882&r1=1341881&r2=1341882&view=diff ============================================================================== --- db/derby/docs/branches/10.8/src/ref/rrefunfreezedbproc.dita (original) +++ db/derby/docs/branches/10.8/src/ref/rrefunfreezedbproc.dita Wed May 23 14:54:18 2012 @@ -22,7 +22,12 @@ limitations under the License. SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE system procedure

    The SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE system -procedure unfreezes a database after backup.

    +procedure unfreezes a database after backup.

    +

    See "Using operating system commands with the freeze and unfreeze system +procedures to perform an online backup" in the + for more information on using +this procedure.

    +
    Syntax SYSCS_UTIL.SYSCS_UNFREEZE_DATABASE()

    No result set is returned by this procedure.

    Execute privileges