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 fu...@apache.org on 2006/04/13 23:43:13 UTC
svn commit: r393949 - in /db/derby/docs/trunk/src/ref:
rrefbackupdbenablelognowaitproc.dita rrefbackupdbenablelogproc.dita
rrefdisablelogproc.dita rrefonlinebackupdbnowaitproc.dita
Author: fuzzylogic
Date: Thu Apr 13 14:43:11 2006
New Revision: 393949
URL: http://svn.apache.org/viewcvs?rev=393949&view=rev
Log:
DERBY-916: missed files from previous checkin
Added:
db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita (with props)
db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita (with props)
db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita (with props)
db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita (with props)
Added: db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita?rev=393949&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita Thu Apr 13 14:43:11 2006
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!--
+Copyright 1997, 2005 The Apache Software Foundation or its licensors, as applicable.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rrefbackupdbenablelognowaitproc" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT</title>
+<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><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)
+</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>
+</dlentry><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, online archived log files that were created before this
+backup will be deleted. The log files are deleted only after a successful
+backup.</dd>
+</dlentry></dl></section>
+<section><title>JDBC example</title><p>The following example backs up the
+database to the <codeph>c:/backupdir</codeph> directory and enables log archive
+mode:</p><codeblock>CallableStatement cs = conn.prepareCall
+("CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT(?, ?)");
+cs.setString(1, "c:/backupdir");
+cs.setInt(2, 0);
+cs.execute();</codeblock></section>
+<section><title>SQL examples</title><p>The following example backs up the
+database to the <codeph>c:/backupdir</codeph> directory, enables log archive
+mode, and does not delete any existing online archived log files:</p><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT('c:/backupdir', 0)</codeblock
+><p>The following example backs up the database to the <codeph>c:/backupdir</codeph> directory
+and, if this backup is successful, deletes existing online archived log files:<codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE_NOWAIT('c:/backupdir', 1)</codeblock
+></p></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefbackupdbenablelognowaitproc.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita?rev=393949&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita Thu Apr 13 14:43:11 2006
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!--
+Copyright 1997, 2005 The Apache Software Foundation or its licensors, as applicable.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+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>
+<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>
+<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>
+<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>
+</dlentry><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, online archived log files that were created before this
+backup will be deleted. The log files are deleted only after a successful
+backup.</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_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE(?, ?)");
+cs.setString(1, "c:/backupdir");
+cs.setInt(2, 0);
+cs.execute();</codeblock></section>
+<section><title>SQL examples</title><p>The following example backs up the
+database to the <codeph>c:/backupdir</codeph> directory, enables log archive
+mode, and does not delete any existing online archived log files:</p><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE('c:/backupdir', 0)</codeblock
+><p>The following example backs up the database to the <codeph>c:/backupdir</codeph> directory
+and, if this backup is successful, deletes existing online archived log files:</p><codeblock>SYSCS_UTIL.SYSCS_BACKUP_DATABASE_AND_ENABLE_LOG_ARCHIVE_MODE('c:/backupdir', 1)</codeblock
+></section>
+</refbody>
+</reference>
+<?Pub *0000002908?>
Propchange: db/derby/docs/trunk/src/ref/rrefbackupdbenablelogproc.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita?rev=393949&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita Thu Apr 13 14:43:11 2006
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!--
+Copyright 1997, 2005 The Apache Software Foundation or its licensors, as applicable.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<reference id="rrefdisablelogproc" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE</title>
+<refbody>
+<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>
+<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
+not deleted.</dd>
+</dlentry></dl></section>
+<section><title>JDBC example</title><p>The following example disables log
+archive mode for the database and deletes any existing log archive files.</p><codeblock>CallableStatement cs = conn.prepareCall
+("CALL SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE(?)");
+cs.setInt(1, 1);
+cs.execute();
+cs.close();</codeblock></section>
+<section><title>SQL examples</title><p>The following example disables log
+archive mode for the database and retains any existing log archive files:</p><codeblock>CALL SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE DELETE_ARCHIVED_LOG_FILES(0);</codeblock
+><p>The following example disables log archive mode for the database and deletes
+any existing log archive files:</p><codeblock>CALL SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE DELETE_ARCHIVED_LOG_FILES(1);</codeblock></section>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefdisablelogproc.dita
------------------------------------------------------------------------------
svn:eol-style = native
Added: db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita
URL: http://svn.apache.org/viewcvs/db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita?rev=393949&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita Thu Apr 13 14:43:11 2006
@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "reference.dtd">
+<!--
+Copyright 1997, 2005 The Apache Software Foundation or its licensors, as applicable.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+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>
+<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
+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())
+</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>
+</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(?)");
+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>
+</refbody>
+</reference>
Propchange: db/derby/docs/trunk/src/ref/rrefonlinebackupdbnowaitproc.dita
------------------------------------------------------------------------------
svn:eol-style = native