svn commit: r434580 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefbackupdbnowaitproc.dita rrefonlinebackupdbnowaitproc.dita

[jt...@apache.org]

Author: jta
Date: Thu Aug 24 17:25:05 2006
New Revision: 434580

URL: http://svn.apache.org/viewvc?rev=434580&view=rev
Log:
DERBY-1685 :  Updated Reference Manual to correct the name of the 
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT procedure.

Committed patch derby1685_ref3.diff by Laura Stewart <sc...@gmail.com>.
Before committing, I manually removed an Arbortext editor identification that was in an XML comment.

Added:
    db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita
      - copied, changed from r434536, db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita
Removed:
    db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita
Modified:
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=434580&r1=434579&r2=434580&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Aug 24 17:25:05 2006
@@ -274,7 +274,7 @@
 </topicref>
 <topicref href="rrefbackupdbproc.dita" navtitle="SYSCS_UTIL.SYSCS_BACKUP_DATABASE">
 </topicref>
-<topicref href="rrefonlinebackupdbnowaitproc.dita" navtitle="SYSC_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT">
+<topicref href="rrefbackupdbnowaitproc.dita" navtitle="SYSC_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT">
 </topicref>
 <topicref href="rrefbackupdbenablelogproc.dita" navtitle="SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE">
 </topicref>

Copied: db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita (from r434536, db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita)
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita?p2=db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita&p1=db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita&r1=434536&r2=434580&rev=434580&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbnowaitproc.dita Thu Aug 24 17:25:05 2006
@@ -17,28 +17,32 @@
 See the License for the specific language governing permissions and  
 limitations under the License.
 -->
-<reference id="rrefonlinebackupdbnowaitproc" xml:lang="en-us">
-<title>SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT</title>
+<reference id="rrefbackupdbnowaitproc" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</title>
+<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>
+</metadata></prolog>
 <refbody>
-<section><p>The <codeph>SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT</codeph> system
-procedure backs up the database to a specified backup directory. If there
-are any transactions in progress with unlogged operations at the start of
-the backup, the <codeph>SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT</codeph> system
+<section><p>If there are any transactions in progress with unlogged operations
+at the start of the backup, the <codeph>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT</codeph> system
 procedure returns an error immediately, instead of waiting for those transactions
 to complete.</p></section>
-<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT(IN BACKUPDIR VARCHAR()) 
+<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>An input argument of type VARCHAR(32672) that specifies the full system
-path to the database directory to be backed up.</dd>
+<dd>A VARCHAR(32672) input argument that specifies the full system path to
+the database directory that is to be backed up.</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
-("CALL SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT(?)");
+("CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT(?)");
 cs.setString(1, "c:/backupdir");
 cs.execute();
 cs.close();</codeblock></section>
 <section><title>SQL example</title><p>The following example backs up the database
-to the <codeph>c:/backupdir</codeph> directory:</p><codeblock>CALL SYSCS_UTIL.SYSCS_ONLINE_BACKUP_DATABASE_NOWAIT('c:/backupdir');</codeblock></section>
+to the <codeph>c:/backupdir</codeph> directory:</p><codeblock>CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT('c:/backupdir');</codeblock></section>
 </refbody>
 </reference>