db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fuzzylo...@apache.org
Subject svn commit: r442769 - in /db/derby/docs/trunk/src/ref: rrefbackupdbenablelognowaitproc.dita rrefbackupdbenablelogproc.dita rrefbackupdbnowaitproc.dita rrefbackupdbproc.dita
Date Wed, 13 Sep 2006 00:27:51 GMT
Author: fuzzylogic
Date: Tue Sep 12 17:27:50 2006
New Revision: 442769

URL: http://svn.apache.org/viewvc?view=rev&rev=442769
Log:
DERBY-1820: Correct the description of the backupDir arugument for all of the
backup procedures In the reference manual.

Committed for Laura Stewart <scotsmatrix@gmail.com>

Modified:
    db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita
    db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
    db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita
    db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita

Modified: db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita?view=diff&rev=442769&r1=442768&r2=442769
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita Tue Sep 12 17:27:50 2006
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+ 
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "reference.dtd">
 <!-- 
@@ -19,6 +20,11 @@
 -->
 <reference id="rrefbackupdbenablelognowaitproc" xml:lang="en-us">
 <title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT</title>
+<prolog><metadata>
+<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT<indexterm>syntax</indexterm></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
@@ -30,8 +36,11 @@
 IN SMALLINT DELETE_ARCHIVED_LOG_FILES)
 </codeblock><p>No result is returned from the procedure.</p><dl><dlentry>
 <dt>BACKUPDIR</dt>
-<dd>An input argument of type VARCHAR(32672) that specifies the full system
-path to the database directory to be backed up.</dd>
+<dd>An input argument of type VARCHAR(32672) that specifies the path to a
+directory, where the backup should be stored. Relative paths are resolved
+based on the current user directory, <filepath>user.dir</filepath>, of the
+JVM where the database backup is occurring. Relative paths are not resolved
+based on the derby home directory. To avoid confusion, use the absolute path.</dd>
 </dlentry><dlentry>
 <dt>DELETE_ARCHIVED_LOG_FILES</dt>
 <dd>If the input parameter value for the DELETE_ARCHIVED_LOG_FILES parameter

Modified: db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita?view=diff&rev=442769&r1=442768&r2=442769
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita Tue Sep 12 17:27:50 2006
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+ 
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "reference.dtd">
 <!-- 
@@ -17,9 +18,13 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<?Pub Caret?>
 <reference id="rrefbackupdbenablelogproc" xml:lang="en-us">
 <title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE</title>
+<prolog><metadata>
+<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE<indexterm>syntax</indexterm></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
@@ -28,8 +33,11 @@
 (IN BACKUPDIR VARCHAR(32672), IN SMALLINT DELETE_ARCHIVED_LOG_FILES) 
 </codeblock><p>No result is returned from the procedure.</p><dl><dlentry>
 <dt>BACKUPDIR</dt>
-<dd>An input argument of type VARCHAR(32672) that specifies the full system
-path to the database directory to be backed up.</dd>
+<dd>An input argument of type VARCHAR(32672) that specifies the path to a
+directory, where the backup should be stored. Relative paths are resolved
+based on the current user directory, <filepath>user.dir</filepath>, of the
+JVM where the database backup is occurring. Relative paths are not resolved
+based on the derby home directory. To avoid confusion, use the absolute path</dd>
 </dlentry><dlentry>
 <dt>DELETE_ARCHIVED_LOG_FILES</dt>
 <dd>If the input parameter value for the DELETE_ARCHIVED_LOG_FILES parameter
@@ -51,4 +59,3 @@
 ></section>
 </refbody>
 </reference>
-<?Pub *0000002908?>

Modified: db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita?view=diff&rev=442769&r1=442768&r2=442769
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita Tue Sep 12 17:27:50 2006
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
+ 
 <!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
  "reference.dtd">
 <!-- 
@@ -22,7 +23,8 @@
 <shortdesc>The <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</codeph>
system
 procedure backs up the database to a specified backup directory. </shortdesc>
 <prolog><metadata>
-<keywords><indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</indexterm></indexterm>
+<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT<indexterm>syntax</indexterm></indexterm>
+<indexterm>system procedures<indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
@@ -33,8 +35,11 @@
 <section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT(IN
BACKUPDIR VARCHAR()) 
 </codeblock><p>No result is returned from the procedure.</p><dl><dlentry>
 <dt>BACKUPDIR</dt>
-<dd>A VARCHAR(32672) input argument that specifies the full system path to
-the database directory that is to be backed up.</dd>
+<dd>An input argument of type VARCHAR(32672) that specifies the path to a
+directory, where the backup should be stored. Relative paths are resolved
+based on the current user directory, <filepath>user.dir</filepath>, of the
+JVM where the database backup is occurring. Relative paths are not resolved
+based on the derby home directory. To avoid confusion, use the absolute path.</dd>
 </dlentry></dl></section>
 <section><title>JDBC example</title><p>The following example backs
up the
 database to the <codeph>c:/backupdir</codeph> directory:</p><codeblock>CallableStatement
cs = conn.prepareCall

Modified: db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita?view=diff&rev=442769&r1=442768&r2=442769
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbproc.dita Tue Sep 12 17:27:50 2006
@@ -1,4 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
 <!-- 
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
@@ -15,19 +18,24 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-
-<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
- "../dtd/reference.dtd">
 <reference id="rrefbackupdbproc" xml:lang="en-us">
 <title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE</title>
+<prolog><metadata>
+<keywords><indexterm>SYSCS_UTIL.SYSCS_BACKUP_DATABASE<indexterm>syntax</indexterm></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></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>
-<dd>An input argument of type VARCHAR(32672) that specifies the full system
-path to the database directory to be backed up.</dd>
+<dt>BACKUPDIR</dt>
+<dd>An input argument of type VARCHAR(32672) that specifies the path to a
+directory, where the backup should be stored. Relative paths are resolved
+based on the current user directory, <filepath>user.dir</filepath>, of the
+JVM where the database backup is occurring. Relative paths are not resolved
+based on the derby home directory. To avoid confusion, use the absolute path.</dd>
 </dlentry></dl></section>
 <section><title>JDBC example</title> <p>The following example backs
up the
 database to the <codeph>c:/backupdir</codeph> directory:</p> <codeblock>CallableStatement
cs = conn.prepareCall
@@ -39,4 +47,3 @@
 database to the <codeph>c:/backupdir</codeph> directory:</p> <codeblock>CALL
SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/backupdir');</codeblock></section>
 </refbody>
 </reference>
-



Mime
View raw message