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/22 15:28:13 UTC
svn commit: r1341468 - in /db/derby/docs/trunk/src:
adminguide/cadmindbintegrity.dita adminguide/cadminpreface23947.dita
adminguide/derbyadmin.ditamap devguide/cdevdgpref11181.dita
devguide/cdevdvlp14839.dita
Author: chaase3
Date: Tue May 22 13:28:13 2012
New Revision: 1341468
URL: http://svn.apache.org/viewvc?rev=1341468&view=rev
Log:
DERBY-5691 Document that Write Caching must be disabled to avoid possible
database corruption
Added a new Admin Guide topic and modified another; modified two Developer's
Guide topics.
Patch: DERBY-5691-5.diff
Added:
db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita (with props)
Modified:
db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita
db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
db/derby/docs/trunk/src/devguide/cdevdgpref11181.dita
db/derby/docs/trunk/src/devguide/cdevdvlp14839.dita
Added: db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita?rev=1341468&view=auto
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita (added)
+++ db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita Tue May 22 13:28:13 2012
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
+ "../dtd/concept.dtd">
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You 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.
+-->
+<concept id="cadmindbintegrity" xml:lang="en-us">
+<title>Maintaining database integrity</title>
+<shortdesc>One of the most important responsibilities of a database
+administrator is to maintain the integrity of the database and prevent it from
+becoming corrupted.</shortdesc>
+<prolog><metadata>
+<keywords><indexterm>corruption<indexterm>avoiding</indexterm></indexterm>
+<indexterm>database corruption<indexterm>avoiding</indexterm></indexterm>
+<indexterm>data integrity<indexterm>maintaining</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<conbody>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> must be able to sync
+to disk. Some machine, disk, or operating system settings can prevent a proper
+sync and cause unrecoverable database corruption in the event of a power
+failure, system crash, or software crash. To avoid database corruption, you can
+do the following:</p>
+<ul>
+<li>Do not enable disk write caching on the hard drive that holds the database.
+Disable write caching if it is turned on (it is enabled by default on many
+Windows systems). Disk write caching can increase operating system performance.
+However, it can also result in the loss of information if a power failure,
+equipment failure, or software failure occurs. Consult your operating system
+support documentation for information on how to disable disk write caching.</li>
+<li>Run <ph conref="../conrefs.dita#prod/productshortname"></ph> on a local
+drive rather than on an NFS mounted, SMB mounted, or other network mounted
+disk.</li>
+<li>Make sure there is plenty of extra space on the disk that holds the
+database, because problems will occur if you run out of disk space in the middle
+of a database operation.</li>
+<li>Disable any other settings or options that might prevent a proper sync to
+disk when <ph conref="../conrefs.dita#prod/productshortname"></ph> is writing
+its transaction logs or other data.</li>
+</ul>
+<p>Many corruption issues can arise from improper backups or restores. Back up
+your database in a way that prevents it from becoming corrupted:</p>
+<ul>
+<li>Always make sure the database is shut down or frozen before using operating
+system commands to back it up.</li>
+<li>Always back up the database to a fresh location rather than overwriting
+any existing data.</li>
+<li>Always check the consistency of the database before performing a backup. See
+<xref href="cadminconsist01.dita#cadminconsist01"></xref> for details.</li>
+</ul>
+<p>See <xref href="cadminhubbkup98797.dita#cadminhubbkup98797"></xref> for more
+information.</p>
+</conbody>
+</concept>
Propchange: db/derby/docs/trunk/src/adminguide/cadmindbintegrity.dita
------------------------------------------------------------------------------
svn:eol-style = native
Modified: db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita?rev=1341468&r1=1341467&r2=1341468&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminpreface23947.dita Tue May 22 13:28:13 2012
@@ -45,10 +45,13 @@ Network Server sample programs for Netwo
</ul>
<p>Part two: <ph conref="../conrefs.dita#prod/productshortname"></ph> Administration Guide</p>
<ul>
+<li><i><xref href="cadmindbintegrity.dita#cadmindbintegrity"/></i>
+<p>Describes how to prevent
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database corruption.</p></li>
<li><i><xref href="cadminconsist01.dita#cadminconsist01"/></i>
<p>Describes how to check the consistency of <ph conref="../conrefs.dita#prod/productshortname"></ph> databases.</p></li>
<li><i><xref href="cadminhubbkup98797.dita#cadminhubbkup98797"/></i>
-<p>Describes how to back up a database when it is online.</p></li>
+<p>Describes how to back up and restore a database.</p></li>
<li><i><xref href="cadminimport16245.dita#cadminimport16245"/></i>
<p>Describes how to import and export large amounts of data between files and
database tables.</p></li>
Modified: db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap?rev=1341468&r1=1341467&r2=1341468&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap (original)
+++ db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap Tue May 22 13:28:13 2012
@@ -363,6 +363,8 @@ program"></topicref>
</topicref>
</topicref>
<topicref collection-type="family" href="cadminparttwo.dita" navtitle="Part two: Derby Administration Guide">
+<topicref href="cadmindbintegrity.dita" navtitle="Maintaining database integrity">
+</topicref>
<topicref collection-type="family" href="cadminconsist01.dita" navtitle="Checking database consistency">
<topicref href="radminconsist30301.dita" navtitle="The SYSCS_CHECK_TABLE function">
</topicref>
Modified: db/derby/docs/trunk/src/devguide/cdevdgpref11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdgpref11181.dita?rev=1341468&r1=1341467&r2=1341468&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdgpref11181.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdgpref11181.dita Tue May 22 13:28:13 2012
@@ -27,5 +27,15 @@ and is for developers building <ph conre
<p>It describes basic <ph conref="../conrefs.dita#prod/productshortname"></ph> concepts,
such as how you create and access <ph conref="../conrefs.dita#prod/productshortname"></ph> databases
through JDBC routines and how you can deploy <ph conref="../conrefs.dita#prod/productshortname"></ph> applications.</p>
+<p>When an application embeds
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, application users take
+on the role of database administrator and must maintain the integrity of the
+database. See "Part Two:
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Administration Guide"
+in the <ph conref="../conrefs.dita#pub/citadmin"></ph> for
+information on administrative tasks such as backing up and restoring
+databases. In particular, see the topic "Maintaining database integrity" for
+information on preventing database corruption. You will need to make this
+information available to users of your application.</p>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/devguide/cdevdvlp14839.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp14839.dita?rev=1341468&r1=1341467&r2=1341468&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp14839.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp14839.dita Tue May 22 13:28:13 2012
@@ -60,5 +60,15 @@ implementation of SQL in the <cite><ph c
<p><ph conref="../conrefs.dita#prod/productshortname"></ph> implements the JDBC
API so as to allow <ph conref="../conrefs.dita#prod/productshortname"></ph> to
serve as a resource manager in a Java EE compliant system.</p>
+<p>When an application embeds
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, application users take
+on the role of database administrator and must maintain the integrity of the
+database. See "Part Two:
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Administration Guide"
+in the <ph conref="../conrefs.dita#pub/citadmin"></ph> for
+information on administrative tasks such as backing up and restoring
+databases. In particular, see the topic "Maintaining database integrity" for
+information on preventing database corruption. You will need to make this
+information available to your users.</p>
</conbody>
</concept>