db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1603559 [2/2] - /db/derby/docs/trunk/src/ref/
Date Wed, 18 Jun 2014 18:14:45 GMT
Modified: db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita Wed Jun 18 18:14:43 2014
@@ -3,41 +3,44 @@
  "../dtd/reference.dtd">
 <reference id="rrefattribtracefileappend" xml:lang="en-us">
 <title>traceFileAppend=true attribute</title>
-<prolog>
-<metadata><keywords>
+<shortdesc>The <i>traceFileAppend=true</i> attribute specifies that the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client should
+append JDBC trace information to a trace file.</shortdesc>
+<prolog><metadata>
+<keywords>
 <indexterm>traceFileAppend=true database connection URL attribute</indexterm>
-</keywords></metadata>
-</prolog>
+<indexterm>network client<indexterm>tracing</indexterm></indexterm>
+<indexterm>attributes<indexterm>traceFileAppend</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
 <refbody>
-<section><title>Function</title>
-<p>Specifies that the <ph conref="../conrefs.dita#prod/productshortname"></ph>
-Network Client should append JDBC trace information to a trace file. The file
-can be specified by the
-<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>
-attribute. If you do not specify a trace file but you specify the
-<i><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
+<section>
+<p>The file can be specified by the
+<i><xref href="rrefattribtracefile.dita">traceFile=path</xref></i>
attribute. If
+you do not specify a trace file but you specify the
+<i><xref href="rrefattribtracedirectory.dita">traceDirectory=path</xref></i>
 attribute, the trace information is appended to the default file. If you do not
 specify <i>traceFileAppend=true</i>, any previous version of the trace file is
 overwritten.</p>
 <p>For more information about tracing, see "Network client tracing" in the
 <ph conref="../conrefs.dita#pub/citadmin"></ph>. See <i>traceDirectory=path</i>
-and
-<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
-for other attributes related to tracing.</p>
+and <i><xref href="rrefattribtracelevel.dita">traceLevel=value</xref></i>
for
+other attributes related to tracing.</p>
 </section>
 <section><title>Combining with other attributes</title>
 <p>This attribute must be specified in conjunction with either the 
 <i>traceFile=path</i> attribute or the <i>traceDirectory=path</i>
attribute. You
 can also combine this attribute with other attributes.</p>
 </section>
-<example><title>Example</title>
+<example><title>Examples</title>
 <codeblock><b>-- enable tracing on an existing database, appending to the
 --   specified file
-jdbc:derby://localhost:1527/mydb;traceFile=trace.out;traceFileAppend=true
+jdbc:derby://localhost:1527/mydb;traceFile=trace.out;
+    traceFileAppend=true
 -- enable tracing on an existing database, appending to the default file 
 --   within the specified directory, relative to the Derby home directory
-jdbc:derby://localhost:1527/mydb;traceDirectory=mytracedir;traceFileAppend=true
-</b></codeblock>
+jdbc:derby://localhost:1527/mydb;traceDirectory=mytracedir;
+    traceFileAppend=true</b></codeblock>
 </example>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita Wed Jun 18 18:14:43 2014
@@ -3,24 +3,26 @@
  "../dtd/reference.dtd">
 <reference id="rrefattribtracelevel" xml:lang="en-us">
 <title>traceLevel=value attribute</title>
-<prolog>
-<metadata><keywords>
+<shortdesc>If tracing is enabled, the <i>traceLevel=value</i> attribute
+specifies the level of tracing to be used by the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network
+Client.</shortdesc>
+<prolog><metadata>
+<keywords>
 <indexterm>traceLevel=value database connection URL attribute</indexterm>
-</keywords></metadata>
-</prolog>
+<indexterm>network client<indexterm>tracing</indexterm></indexterm>
+<indexterm>attributes<indexterm>traceLevel</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
 <refbody>
-<section><title>Function</title>
-<p>If tracing is enabled, specifies the level of tracing to be used by the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client. The

-<i>value</i> is numeric. If you 
-do not specify a trace level, the default is TRACE_ALL.
-</p>
+<section>
+<p>The <i>value</i> is numeric. If you do not specify a trace level, the
default
+is TRACE_ALL.</p>
 <p>For more information about tracing, see "Network client tracing" in the
 <ph conref="../conrefs.dita#pub/citadmin"></ph>. See 
-<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>,
-<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
-and 
-<i><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
+<i><xref href="rrefattribtracefile.dita">traceFile=path</xref></i>,
+<i><xref href="rrefattribtracefileappend.dita">traceFileAppend=true</xref></i>,
+and <i><xref href="rrefattribtracedirectory.dita">traceDirectory=path</xref></i>
 for other attributes related to tracing.
 </p></section>
 <section><title>Tracing levels</title>
@@ -138,8 +140,8 @@ flows, specify this value for traceLevel
 </section>
 <example><title>Example</title>
 <codeblock><b>-- enable tracing on a new database
-jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out;traceLevel=65
-</b></codeblock>
+jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out;
+    traceLevel=65</b></codeblock>
 </example>
 </refbody>
 </reference>

Modified: db/derby/docs/trunk/src/ref/rrefattribupgrade.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribupgrade.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribupgrade.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribupgrade.dita Wed Jun 18 18:14:43 2014
@@ -3,17 +3,21 @@
  "../dtd/reference.dtd">
 <reference id="rrefattribupgrade" xml:lang="en-us">
 <title>upgrade=true attribute</title>
-<prolog>
-<metadata><keywords>
-<indexterm>upgrade=true database connection URL attribute</indexterm>
-</keywords></metadata>
-</prolog>
-<refbody>
-<section><title>Function</title>
-<p>Upgrades a database that was created using an earlier version of
+<shortdesc>The <i>upgrade=true</i> attribute upgrades a database that was
+created using an earlier version of
 <ph conref="../conrefs.dita#prod/productshortname"></ph> to the current version
 of <ph conref="../conrefs.dita#prod/productshortname"></ph>, then connects to
-it. If the database does not exist, an error appears in the error log and the
+it.</shortdesc>
+<prolog><metadata>
+<keywords>
+<indexterm>upgrade=true database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>upgrading</indexterm></indexterm>
+<indexterm>attributes<indexterm>upgrade</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section>
+<p>If the database does not exist, an error appears in the error log and the
 connection attempt fails with an <i>SQLException</i> indicating that the
 database cannot be found.</p>
 <p>This operation performs a full upgrade, as defined in "Upgrading a database"
@@ -44,7 +48,7 @@ attribute with this attribute.</p>
 or <i><xref href="rrefattrib56769.dita#rrefattrib56769">territory=ll_CC</xref></i>
 attributes.</p>
 </section>
-<example><title>Example</title>
+<example><title>Examples</title>
 <codeblock><b>jdbc:derby:sampleDB;upgrade=true
 
 jdbc:derby:;databaseName=sampleDB;upgrade=true;</b></codeblock>

Modified: db/derby/docs/trunk/src/ref/rrefcreatefrom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefcreatefrom.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefcreatefrom.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefcreatefrom.dita Wed Jun 18 18:14:43 2014
@@ -20,29 +20,35 @@ limitations under the License.
  "../dtd/reference.dtd">
 <reference id="rrefcreatefrom" xml:lang="en-us">
 <title>createFrom=path attribute</title>
+<shortdesc>The <i>createFrom=path</i> attribute creates a database using
a full
+backup at a specified location.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>createFrom=path database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>creating from backup</indexterm></indexterm>
+<indexterm>attributes<indexterm>createFrom</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<section><title>Function</title> <p>You can specify the <i>createFrom=path</i>
attribute
-in the boot time connection URL to create a database using a full backup at
-a specified location. If there is a database with the same name in derby.system.home,
-an error will occur and the existing database will be left intact. If there
-is not an existing database with the same name in the current derby.system.home
-location, the whole database is copied from the backup location to the derby.system.home
-location and started. </p> <p>The Log files are copied to the default location.
-The logDevice attribute can be used in conjunction with <i>createFrom=path</i>
to
-store logs in a different location. With <i>createFrom=path</i> you do not
-need to copy the individual log files to the log directory.</p> 
+<section><p>If there is a database with the same name in
+<i>derby.system.home</i>, an error will occur and the existing database will
be
+left intact. If there is not an existing database with the same name in the
+current <i>derby.system.home</i> location, the whole database is copied from
the
+backup location to the <i>derby.system.home</i> location and started.</p>
+<p>The log files are copied to the default location. The
+<i><xref href="rrefattrib72457.dita">logDevice=logDirectoryPath</xref></i>
+attribute can be used in conjunction with <i>createFrom=path</i> to store logs
+in a different location. With <i>createFrom=path</i> you do not need to copy
the
+individual log files to the log directory.</p> 
 <p>For more information about using this attribute, see "Creating a database
 from a backup copy" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
 </section>
-<section><title>Combining with other attributes</title> <p>Do
-not combine this attribute with <i>rollForwardRecoveryFrom</i>, <i>restoreFrom</i>,
or 
-<i>create</i>.</p> </section>
+<section><title>Combining with other attributes</title>
+<p>Do not combine this attribute with <i>rollForwardRecoveryFrom</i>,
+<i>restoreFrom</i>, or <i>create</i>.</p> </section>
 <example><title>Example</title>
-<codeblock>URL: jdbc:derby:wombat;createFrom=d:/backup/wombat</codeblock> </example>
+<codeblock><b>-- create the wombat database from a backup copy
+jdbc:derby:wombat;createFrom=d:/backup/wombat</b></codeblock>
+</example>
 </refbody>
 </reference>
 

Modified: db/derby/docs/trunk/src/ref/rrefrestorefrom.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefrestorefrom.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefrestorefrom.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefrestorefrom.dita Wed Jun 18 18:14:43 2014
@@ -20,27 +20,34 @@ limitations under the License.
  "../dtd/reference.dtd">
 <reference id="rrefrestorefrom" xml:lang="en-us">
 <title>restoreFrom=path attribute</title>
+<shortdesc>The <i>restoreFrom=path</i> attribute restores a database using
a
+full backup from the specified location.</shortdesc>
 <prolog><metadata>
 <keywords><indexterm>restoreFrom=path database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>restoring from backup</indexterm></indexterm>
+<indexterm>attributes<indexterm>restoreFrom</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<section><title>Function</title> <p>You can specify the <i>restoreFrom=path</i>
attribute
-in the boot time connection URL to restore a database using a full backup
-from the specified location. If a database with the same name exists in the
-derby.system.home location, the whole database is deleted, copied from the
-backup location, and then restarted.</p> <p>The log files are copied to the
-same location they were in when the backup was taken. The logDevice attribute
-can be used in conjunction with <i>restoreFrom=path</i> to store logs in a
-different location.</p> 
+<section>
+<p>If a database with the same name exists in the <i>derby.system.home</i>
+location, the whole database is deleted, copied from the backup location, and
+then restarted.</p>
+<p>The log files are copied to the same location they were in when the backup
+was taken. The
+<i><xref href="rrefattrib72457.dita">logDevice=logDirectoryPath</xref></i>
+attribute can be used in conjunction with <i>restoreFrom=path</i> to store logs
+in a different location.</p> 
 <p>For more information about using this attribute, see "Restoring a database
 from a backup copy" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
 </section>
-<section><title>Combining with other attributes</title> <p>Do
-not combine this attribute with <i>createFrom</i>, 
+<section><title>Combining with other attributes</title>
+<p>Do not combine this attribute with <i>createFrom</i>, 
 <i>rollForwardRecoveryFrom</i>, or <i>create</i>.</p> </section>
 <example><title>Example</title>
-<codeblock>URL: jdbc:derby:wombat;restoreFrom=d:/backup/wombat</codeblock> </example>
+<codeblock><b>-- restore the wombat database from a backup copy
+jdbc:derby:wombat;restoreFrom=d:/backup/wombat</b></codeblock>
+</example>
 </refbody>
 </reference>
 

Modified: db/derby/docs/trunk/src/ref/rrefrollforward.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefrollforward.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefrollforward.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefrollforward.dita Wed Jun 18 18:14:43 2014
@@ -20,27 +20,32 @@ limitations under the License.
  "../dtd/reference.dtd">
 <reference id="rrefrollforward" xml:lang="en-us">
 <title>rollForwardRecoveryFrom=path attribute</title>
+<shortdesc>The <i>rollForwardRecoveryFrom=path</i> attribute restores a
+database using a backup copy and performs roll-forward recovery using archived
+and active logs.</shortdesc>
 <prolog><metadata>
-<keywords><indexterm>rollforwardRecovery=path (database connection URL attribute)</indexterm>
+<keywords><indexterm>rollforwardRecovery=path database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>restoring from backup</indexterm></indexterm>
+<indexterm>attributes<indexterm>rollForwardRecoveryFrom</indexterm></indexterm>
 </keywords>
 </metadata></prolog>
 <refbody>
-<section><title>Function</title> <p>You can specify the <i>
rollForwardRecoveryFrom=path</i> in
-the boot time URL to restore the database using a backup copy and perform
-rollforward recovery using archived and active logs.</p> <p>To restore a database
-using rollforward recovery, you must already have a backup copy of the database,
-all the archived logs since then, and the active log files. All the log files
-should be in the database log directory.</p> <p>After a database is restored
-from full backup, transactions from the online archived logs and the active
-logs are replayed.</p> 
+<section>
+<p>To restore a database using roll-forward recovery, you must already have a
+backup copy of the database, all the archived logs since then, and the active
+log files. All the log files should be in the database log directory.</p>
+<p>After a database is restored from full backup, transactions from the online
+archived logs and the active logs are replayed.</p> 
 <p>For more information about using this attribute, see "Roll-forward recovery"
 in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
 </section>
-<section><title>Combining with other attributes</title> <p>Do
-not combine this attribute with <i>createFrom</i>, <i>restoreFrom</i>,
or 
+<section><title>Combining with other attributes</title>
+<p>Do not combine this attribute with <i>createFrom</i>, <i>restoreFrom</i>,
or 
 <i>create</i>.</p> </section>
 <example><title>Example</title>
-<codeblock>URL: jdbc:derby:wombat;rollForwardRecoveryFrom=d:/backup/wombat</codeblock>
</example>
+<codeblock><b>-- restore and recover the wombat database
+jdbc:derby:wombat;rollForwardRecoveryFrom=d:/backup/wombat</b></codeblock>
+</example>
 </refbody>
 </reference>
 



Mime
View raw message