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 2013/11/11 16:40:43 UTC
svn commit: r1540754 [1/2] - /db/derby/docs/trunk/src/adminguide/
Author: chaase3
Date: Mon Nov 11 15:40:42 2013
New Revision: 1540754
URL: http://svn.apache.org/r1540754
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 46 Admin Guide reference topics.
Patch: DERBY-6379-adminreference.diff
Modified:
db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita
db/derby/docs/trunk/src/adminguide/radminappsresultsetdiffs.dita
db/derby/docs/trunk/src/adminguide/radminconfig.dita
db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita
db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
db/derby/docs/trunk/src/adminguide/radminconfigportnumber.dita
db/derby/docs/trunk/src/adminguide/radminconfigstartnetworkserver.dita
db/derby/docs/trunk/src/adminguide/radminconsist24642.dita
db/derby/docs/trunk/src/adminguide/radminconsist30301.dita
db/derby/docs/trunk/src/adminguide/radminconsist38781.dita
db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita
db/derby/docs/trunk/src/adminguide/radmindrdahost.dita
db/derby/docs/trunk/src/adminguide/radmindrdakeepalive.dita
db/derby/docs/trunk/src/adminguide/radmindrdamaxthreads.dita
db/derby/docs/trunk/src/adminguide/radmindrdaminthreads.dita
db/derby/docs/trunk/src/adminguide/radmindrdasecmechanism.dita
db/derby/docs/trunk/src/adminguide/radmindrdasslmode.dita
db/derby/docs/trunk/src/adminguide/radmindrdatimeslice.dita
db/derby/docs/trunk/src/adminguide/radminembeddedserverex.dita
db/derby/docs/trunk/src/adminguide/radminexportarguments.dita
db/derby/docs/trunk/src/adminguide/radminimport64241.dita
db/derby/docs/trunk/src/adminguide/radminimport91458.dita
db/derby/docs/trunk/src/adminguide/radminimportcodeset.dita
db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita
db/derby/docs/trunk/src/adminguide/radminjmxenabledisable.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablepwd.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablepwdssl.dita
db/derby/docs/trunk/src/adminguide/radminjmxenablesimpleauth.dita
db/derby/docs/trunk/src/adminguide/radminjmxintro.dita
db/derby/docs/trunk/src/adminguide/radminjmxjconsole.dita
db/derby/docs/trunk/src/adminguide/radminjmxtroubleshoot.dita
db/derby/docs/trunk/src/adminguide/radminlicense.dita
db/derby/docs/trunk/src/adminguide/radminlog800241.dita
db/derby/docs/trunk/src/adminguide/radminlog800279.dita
db/derby/docs/trunk/src/adminguide/radminnsdatasourcexmp.dita
db/derby/docs/trunk/src/adminguide/radminovnssample.dita
db/derby/docs/trunk/src/adminguide/radminsampleprograms.dita
db/derby/docs/trunk/src/adminguide/radminservlet810694.dita
db/derby/docs/trunk/src/adminguide/radminservlet810717.dita
db/derby/docs/trunk/src/adminguide/radminservlet810796.dita
db/derby/docs/trunk/src/adminguide/radminservlet810822.dita
db/derby/docs/trunk/src/adminguide/radminservlet810910.dita
Modified: db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap (original)
+++ db/derby/docs/trunk/src/adminguide/derbyadmin.ditamap Mon Nov 11 15:40:42 2013
@@ -161,7 +161,7 @@
<topicref href="cadminpreface23947.dita" navtitle="How this guide is organized">
</topicref>
</topicref>
-<topicref collection-type="family" href="cadminpartone.dita" navtitle="Part one: Derby Server Guide">
+<topicref collection-type="family" href="cadminpartone.dita" navtitle="Part One: Derby Server Guide">
<topicref collection-type="family" href="cadminov11108.dita" navtitle="Derby in a multi-user environment">
<topicref collection-type="family" href="cadminov17524.dita" navtitle="Derby in a server framework">
<topicref href="cadminov825125.dita" navtitle="Connectivity configurations">
@@ -289,7 +289,7 @@ navtitle="Setting Network Server propert
<topicref href="radminconfigdb2jdrdatracedirectory.dita" navtitle="derby.drda.traceDirectory property">
</topicref>
</topicref>
-<topicref href="tadminconfigverifyingstartup.dita" navtitle="Verifying Startup">
+<topicref href="tadminconfigverifyingstartup.dita" navtitle="Verifying startup">
</topicref>
</topicref>
<topicref collection-type="family" href="cadminjmxoverview.dita" navtitle="Using Java Management Extensions (JMX) technology">
@@ -360,7 +360,7 @@ program"></topicref>
</topicref>
</topicref>
</topicref>
-<topicref collection-type="family" href="cadminparttwo.dita" navtitle="Part two: Derby Administration Guide">
+<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">
Modified: db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminappsclientxmp.dita Mon Nov 11 15:40:42 2013
@@ -19,17 +19,20 @@ limitations under the License.
-->
<reference id="radminappsclientxmp" xml:lang="en-us">
<title>Network client driver examples</title>
+<shortdesc>The following examples specify the user and password URL
+attributes.</shortdesc>
<refbody>
<section>
-<p>The following examples specify the user and password URL attributes.
-To enable user authentication, you must either use NATIVE authentication or
-explicitly set the property <i>derby.connection.requireAuthentication</i>
-to true. Otherwise, <ph conref="../conrefs.dita#prod/productshortname"></ph>
-does not require a user name and password. For details on how to enable
-user authentication, see "Working with user authentication" in the
+<p>To enable user authentication, you must either use NATIVE authentication or
+explicitly set the property
+<codeph>derby.connection.requireAuthentication</codeph> to
+<codeph>true</codeph>. Otherwise,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> does not require a user
+name and password. For details on how to enable user authentication, see
+"Working with user authentication" in the
<ph conref="../conrefs.dita#pub/citdevelop"/>.</p>
<p>For a multi-user product, you would typically specify authentication for the
-system in the <i>derby.properties</i> file for your
+system in the <codeph>derby.properties</codeph> file for your
server, since it is in a trusted environment. The following property setting
specifies NATIVE authentication:</p>
<codeblock>derby.authentication.provider=NATIVE:myCredentialsDB:LOCAL</codeblock>
@@ -38,17 +41,22 @@ rely on NATIVE authentication, an extern
user-defined class for authentication. It is also strongly recommended that
production systems protect network connections with SSL/TLS.</note></p>
</section>
-<section><title>Example 1</title><p>The following example connects to the
-default server name localhost on the default port, 1527, and to the database
-sample.</p>
-<codeblock>jdbc:derby://localhost:1527/sample;user=judy;password=no12see</codeblock></section>
-<section><title>Example 2</title><p>The following example specifies both <ph
-conref="../conrefs.dita#prod/productshortname"></ph> and Network Client
-driver attributes: <codeblock>jdbc:derby://localhost:1527/sample;create=true;user=judy;
-password=no12see</codeblock></p></section>
-<section><title>Example 3</title><p>This example connects to the default server
-name localhost on the default port, 1527, and includes the path in the database
-name portion of the URL.</p><codeblock>jdbc:derby://localhost:1527/c:/my-db-dir/my-db-name;user=judy;
+<section><title>Example 1</title>
+<p>The following example connects to the default server name localhost on the
+default port, 1527, and to the database sample.</p>
+<codeblock>jdbc:derby://localhost:1527/sample;user=judy;password=no12see</codeblock>
+</section>
+<section><title>Example 2</title>
+<p>The following example specifies both
+<ph conref="../conrefs.dita#prod/productshortname"></ph> and Network Client
+driver attributes:</p>
+<codeblock>jdbc:derby://localhost:1527/sample;create=true;user=judy;password=no12see</codeblock>
+</section>
+<section><title>Example 3</title>
+<p>This example connects to the default server name <codeph>localhost</codeph>
+on the default port, 1527, and includes the path in the database name portion of
+the URL.</p>
+<codeblock>jdbc:derby://localhost:1527/c:/my-db-dir/my-db-name;user=judy;
password=no12see</codeblock>
<p>For a programming example that shows how to connect to the server using
NATIVE authentication, see "NATIVE authentication and SQL authorization example"
Modified: db/derby/docs/trunk/src/adminguide/radminappsresultsetdiffs.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminappsresultsetdiffs.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminappsresultsetdiffs.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminappsresultsetdiffs.dita Mon Nov 11 15:40:42 2013
@@ -19,11 +19,11 @@ limitations under the License.
-->
<concept id="radminappsresultsetdiffs" xml:lang="en-us">
<title>Updatable result sets</title>
-<conbody>
-<p>In <ph conref="../conrefs.dita#prod/productshortname"></ph>, the
+<shortdesc>In <ph conref="../conrefs.dita#prod/productshortname"></ph>, the
functionality of updatable result sets in a server environment and in an
embedded environment are similar, with the exception of the following
-differences:</p>
+differences.</shortdesc>
+<conbody>
<ul>
<li>The embedded driver allows for statement name changes when there is an
open result set on the statement object. This is not supported in a server
Modified: db/derby/docs/trunk/src/adminguide/radminconfig.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfig.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfig.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfig.dita Mon Nov 11 15:40:42 2013
@@ -20,16 +20,23 @@ limitations under the License.
-->
<reference id="radminconfig" xml:lang="en-us">
<title>derby.drda.traceAll property</title>
+<shortdesc>Turns tracing on for all sessions.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.traceAll property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Turns tracing on for all sessions.</section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.traceAll=[true|false]</codeblock> </refsyn>
-<section><title>Default</title> <p>False.</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.traceAll=true</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. You can change system
-values by using commands after the Network Server has been started.</p>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.traceAll={true|false}</codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>False.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.traceAll=true</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Dynamic. You can change system values by using commands after the Network
+Server has been started.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdalogconnections.dita Mon Nov 11 15:40:42 2013
@@ -19,18 +19,28 @@ limitations under the License.
-->
<reference id="radminconfigdb2jdrdalogconnections" xml:lang="en-us">
<title>derby.drda.logConnections property</title>
+<shortdesc>Indicates whether to log connections.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.logConnections property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Indicates whether to log connections. Also controls the logging of
-the connection number. Connection number tracing, if enabled, goes to both
-the <codeph>derby.log</codeph> file and the network server console.</section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.logConnections=[true|false]</codeblock> </refsyn>
-<section><title>Default</title> <p>False.</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.logConnections=true </b></codeblock></example>
-<section><title>Static or dynamic</title><p>Dynamic. You can change system
-values by using commands after the Network Server has been started.</p>
+<section>
+<p>This property also controls the logging of the connection number. Connection
+number tracing, if enabled, goes to both the <codeph>derby.log</codeph> file and
+the Network Server console.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.logConnections={true|false}</codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>False.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.logConnections=true</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Dynamic. You can change system values by using commands after the Network
+Server has been started.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigdb2jdrdatracedirectory.dita Mon Nov 11 15:40:42 2013
@@ -20,41 +20,37 @@ limitations under the License.
-->
<reference id="radminconfigdb2jdrdatracedirectory" xml:lang="en-us">
<title>derby.drda.traceDirectory property</title>
+<shortdesc>Indicates the location of tracing files.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.traceDirectory property</indexterm></keywords>
</metadata></prolog>
<refbody>
- <section>Indicates the location of tracing files.</section>
<section><title>Security Considerations</title>
-<p>
- The Network Server will attempt to create the trace directory
- (and any parent directories) if they do not exist.
- This will require that the Java security policy for
- <codeph>derbynet.jar</codeph>
- permits verification of the existence of the named trace directory
- and all necessary parent directories.
- For each directory created, the policy must allow
- <codeblock>
- permission java.io.FilePermission "<<i>directory</i>>", "read,write";
- </codeblock>
- and for the trace directory itself, the policy must allow
- <codeblock>
- permission java.io.FilePermission "<<i>tracedirectory</i>>${/}-", "write";
- </codeblock>
-</p>
-<p>
- See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
- information about customizing the Network Server's security policy.
-</p>
- </section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.traceDirectory=<i>tracefiledirectory</i></codeblock></refsyn>
-<section><title>Default</title> <p>If the derby.system.home property
- has been set, it is the default. Otherwise, the default is the current directory.</p>
+<p>The Network Server will attempt to create the trace directory (and any parent
+directories) if they do not exist. This will require that the Java security
+policy for <codeph>derbynet.jar</codeph> permits verification of the existence
+of the named trace directory and all necessary parent directories. For each
+directory created, the policy must allow</p>
+<codeblock>permission java.io.FilePermission "<i>directory</i>", "read,write";</codeblock>
+<p>and for the trace directory itself, the policy must allow</p>
+<codeblock>permission java.io.FilePermission "<i>tracedirectory</i>${/}-", "write";</codeblock>
+<p>See <xref href="tadminnetservcustom.dita#tadminnetservcustom"></xref> for
+information about customizing the Network Server's security policy.</p>
</section>
-<example> <title>Example</title><codeblock><b>derby.drda.traceDirectory=c:/<ph
-conref="../conrefs.dita#prod/productshortname"></ph>/trace</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. You can change system
-values by using commands after the Network Server has been started.</p>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.traceDirectory=<i>traceFileDirectory</i></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>If the <codeph>derby.system.home</codeph> property has been set, it is the
+default. Otherwise, the default is the current directory.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.traceDirectory=c:/<ph
+conref="../conrefs.dita#prod/productshortname"></ph>/trace</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Dynamic. You can change system values by using commands after the Network
+Server has been started.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigportnumber.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigportnumber.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigportnumber.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigportnumber.dita Mon Nov 11 15:40:42 2013
@@ -19,16 +19,22 @@ limitations under the License.
-->
<reference id="radminconfigportnumber" xml:lang="en-us">
<title>derby.drda.portNumber property</title>
+<shortdesc>Indicates the port number to use.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.portNumber property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Indicates the port number to use. </section>
-<refsyn><title>Syntax</title><codeblock>derby.drda.portNumber=<i>portnumber</i></codeblock> </refsyn>
-<section><title>Default</title><p>If no port number is specified, 1527 is
-the default.</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.portNumber=1110</b></codeblock> </example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for changes to take effect.</p> </section>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.portNumber=<i>portNumber</i></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>If no port number is specified, 1527 is the default.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.portNumber=1110</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconfigstartnetworkserver.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconfigstartnetworkserver.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconfigstartnetworkserver.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconfigstartnetworkserver.dita Mon Nov 11 15:40:42 2013
@@ -19,29 +19,38 @@ limitations under the License.
-->
<reference id="radminconfigstartnetworkserver" xml:lang="en-us">
<title>derby.drda.startNetworkServer property</title>
+<shortdesc>Indicates whether the Network Server will start automatically when
+you start <ph conref="../conrefs.dita#prod/productshortname"></ph>.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.startNetworkServer property</indexterm></keywords>
</metadata></prolog>
<refbody>
<section>
-<p>Use the derby.drda.startNetworkServer property to simplify
-embedding the Network Server in your Java application. When you set
-derby.drda.startNetworkServer to true, the Network Server will automatically
-start when you start <ph conref="../conrefs.dita#prod/productshortname"></ph>
-(in this context, <ph conref="../conrefs.dita#prod/productshortname"></ph>
-will start when the embedded driver is loaded). Only one Network Server
-can be started in a JVM.</p>
-<p>NOTE:
-If you start the Network Server with this property set to true, the Network
-Server will stop when your application ends or when you stop it by other means
-(e.g. by using the Java API, the command line interface, or by shutting down
-the Derby system), whichever comes first.</p>
+<p>Use the <codeph>derby.drda.startNetworkServer</codeph> property to simplify
+embedding the Network Server in your Java application. When you set this
+property to true, the Network Server will automatically start when you start
+<ph conref="../conrefs.dita#prod/productshortname"></ph> (in this context,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> will start when the
+embedded driver is loaded). Only one Network Server can be started in a JVM.</p>
+<p><note>If you start the Network Server with this property set to true, the
+Network Server will stop when your application ends or when you stop it by other
+means (for example, by using the Java API or the command line interface, or by
+shutting down the <ph conref="../conrefs.dita#prod/productshortname"></ph>
+system), whichever comes first.</note></p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.startNetworkServer={true|false}</codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>False.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.startNetworkServer=true</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must shut down the Network Server and restart
+<ph conref="../conrefs.dita#prod/productshortname"></ph> for this change to take
+effect.</p>
</section>
-<refsyn><title>Syntax</title><codeblock>derby.drda.startNetworkServer=[true | false]</codeblock> </refsyn>
-<section><title>Default</title><p>False.</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.startNetworkServer=true</b></codeblock> </example>
-<section><title>Static or dynamic</title><p>Static. You must shut down the
-Network Server and restart <ph conref="../conrefs.dita#prod/productshortname"></ph> for
-this change to take effect.</p> </section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconsist24642.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconsist24642.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconsist24642.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconsist24642.dita Mon Nov 11 15:40:42 2013
@@ -19,28 +19,35 @@ limitations under the License.
-->
<reference id="radminconsist24642" xml:lang="en-us">
<title>Sample SYSCS_CHECK_TABLE queries</title>
+<shortdesc>This section provides examples that illustrate how to use the
+<codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function in queries.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Queries<indexterm>Sample</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>This section provides examples that illustrate how to use the
-SYSCS_UTIL.SYSCS_CHECK_TABLE function in queries.</p></section>
+<section><p></p></section>
<section><p>To check the consistency of a single table, run a query that is
similar to the one shown in the following example:</p></section>
-<example><codeblock>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE('APP', 'FLIGHTS')</codeblock></example>
+<example>
+<codeblock><b>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE('APP', 'FLIGHTS')</b></codeblock>
+</example>
<section><p>To check the consistency of all of the tables in a schema, stopping
at the first failure, run a query that is similar to the one shown in the
following example:</p></section>
-<example><codeblock>SELECT tablename, SYSCS_UTIL.SYSCS_CHECK_TABLE(
+<example>
+<codeblock><b>SELECT tablename, SYSCS_UTIL.SYSCS_CHECK_TABLE(
'SAMP', tablename)
FROM sys.sysschemas s, sys.systables t
-WHERE s.schemaname = 'SAMP' AND s.schemaid = t.schemaid</codeblock></example>
+WHERE s.schemaname = 'SAMP' AND s.schemaid = t.schemaid</b></codeblock>
+</example>
<section><p>To check the consistency of an entire database, stopping at the
first failure, run a query that is similar to the one shown in the following
example::</p></section>
-<example><codeblock>SELECT schemaname, tablename,
+<example>
+<codeblock><b>SELECT schemaname, tablename,
SYSCS_UTIL.SYSCS_CHECK_TABLE(schemaname, tablename)
FROM sys.sysschemas s, sys.systables t
-WHERE s.schemaid = t.schemaid</codeblock></example>
+WHERE s.schemaid = t.schemaid</b></codeblock>
+</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminconsist30301.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconsist30301.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconsist30301.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconsist30301.dita Mon Nov 11 15:40:42 2013
@@ -19,30 +19,36 @@ limitations under the License.
-->
<reference id="radminconsist30301" xml:lang="en-us">
<title>The SYSCS_CHECK_TABLE function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function checks the
+consistency of a <ph conref="../conrefs.dita#prod/productshortname"></ph>
+table.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>org.apache.derby.database. ConsistencyChecker.checkTable</indexterm>
+<keywords><indexterm>org.apache.derby.database.ConsistencyChecker.checkTable</indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The SYSCS_UTIL.SYSCS_CHECK_TABLE() function checks the consistency
-of a <ph conref="../conrefs.dita#prod/productshortname"></ph> table. In
-particular, the <i>SYSCS_UTIL.SYSCS_CHECK_TABLE</i> function verifies the
-following conditions:<ul>
+<section><p>In particular, the <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph>
+function verifies the following conditions:<ul>
<li>Base tables are internally consistent</li>
<li>Base tables and all associated indexes contain the same number of rows</li>
<li>The values and row locations in each index match those of the base table</li>
<li>All BTREE indexes are internally consistent</li>
</ul>You run this function in an SQL statement, as follows:</p></section>
-<example> <codeblock>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE(
- <i>SchemaName</i>, <i>TableName</i>)</codeblock>where <i>SchemaName</i> and <i>TableName</i> are
-expressions that evaluate to a string data type. If you created a schema or
-table name as a non-delimited identifier, you must present their names in
-all upper case. For example:<codeblock>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE('APP', 'CITIES')</codeblock></example>
-<section><p>The SYSCS_UTIL.SYSCS_CHECK_TABLE function returns a smallint.
-If the table is consistent (or if you run SYSCS_UTIL.SYSCS_CHECK_TABLE on
-a view), SYSCS_UTIL.SYSCS_CHECK_TABLE returns a non-zero value. Otherwise,
-the function throws an exception on the first inconsistency that it finds.</p></section>
-<section><p>For a consistent table, the following result is displayed:</p></section>
+<example>
+<codeblock><b>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE(<i>SchemaName</i>, <i>TableName</i>)</b></codeblock>
+where <i>SchemaName</i> and <i>TableName</i> are expressions that evaluate to a
+string data type. If you created a schema or table name as a non-delimited
+identifier, you must present their names in all upper case. For example:
+<codeblock><b>VALUES SYSCS_UTIL.SYSCS_CHECK_TABLE('APP', 'CITIES')</b></codeblock>
+</example>
+<section><p>The <codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function returns a
+SMALLINT. If the table is consistent (or if you run
+<codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> on a view),
+<codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> returns a non-zero value.
+Otherwise, the function throws an exception on the first inconsistency that it
+finds.</p></section>
+<section><p>For a consistent table, the following result is displayed:</p>
+</section>
<example> <codeblock>1
-----
1
Modified: db/derby/docs/trunk/src/adminguide/radminconsist38781.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminconsist38781.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminconsist38781.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminconsist38781.dita Mon Nov 11 15:40:42 2013
@@ -19,15 +19,16 @@ limitations under the License.
-->
<reference id="radminconsist38781" xml:lang="en-us">
<title>Sample SYSCS_CHECK_TABLE error messages</title>
-<shortdesc>This section provides examples of error messages that the SYSCS_UTIL.SYSCS_CHECK_TABLE()
-function can return.</shortdesc>
+<shortdesc>This section provides examples of error messages that the
+<codeph>SYSCS_UTIL.SYSCS_CHECK_TABLE</codeph> function can return.</shortdesc>
<prolog><metadata>
<keywords><indexterm>SYSCS_CHECK_TABLE error messages</indexterm></keywords>
</metadata></prolog>
<refbody>
<section><p>If the row counts of the base table and an index differ, error
message X0Y55 is issued:</p></section>
-<example> <codeblock>ERROR X0Y55: The number of rows in the base table does not match
+<example>
+<codeblock>ERROR X0Y55: The number of rows in the base table does not match
the number of rows in at least 1 of the indexes on the table. Index
'T1_I' on table 'APP.T1' has 4 rows, but the base table has 5 rows.
The suggested corrective action is to recreate the index.</codeblock></example>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdaStreamOutBufferSize.dita Mon Nov 11 15:40:42 2013
@@ -22,27 +22,36 @@
-->
<reference id="radmindrdaStreamOutBufferSize" xml:lang="en-us">
<title>derby.drda.streamOutBufferSize property</title>
+<shortdesc>Configures the size of the buffer for streaming blob/clob data from
+server to client.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.streamOutBufferSize property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>
-Configure size of buffer for streaming blob/clob from server to client.
-If the configured size is 0 or less, the buffer is not placed.
-
+<section>
+<p>If the configured size is 0 or less, the buffer is not placed.</p>
<note>
-<p>This configuration is used when optimizing streaming blob/clob from server to client.</p>
-<p>If there were found many small packets, of which sizes are much lower than maximum size of packet possible in the network,
-it will improve performance of streaming to setting this configuration.</p>
-<p>Recommended value of this configuration is maximum packet size possible in the network minus appropriate size for header.</p>
+This configuration is used when optimizing streaming blob/clob from server to
+client.
+<p>If there were found many small packets, of which sizes are much lower than
+maximum size of packet possible in the network, it will improve performance of
+streaming to setting this configuration.</p>
+<p>Recommended value of this configuration is maximum packet size possible in
+the network minus appropriate size for header.</p>
</note>
-
</section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.streamOutBufferSize=<i>size of buffer</i></codeblock> </refsyn>
-<section><title>Default</title> <p>0</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.streamOutBufferSize=1024</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Dynamic. You can change system
-values by using commands after the Network Server has been started.</p>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.streamOutBufferSize=<i>sizeOfBuffer</i></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>0 (zero).</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.streamOutBufferSize=1024</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Dynamic. You can change system values by using commands after the Network
+Server has been started.</p>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdahost.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdahost.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdahost.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdahost.dita Mon Nov 11 15:40:42 2013
@@ -20,24 +20,35 @@ limitations under the License.
-->
<reference id="radmindrdahost" xml:lang="en-us">
<title>derby.drda.host property</title>
+<shortdesc>Causes the Network Server to listen on a specific network
+interface.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.host property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Causes the Network Server to listen on a specific network interface.
-This property allows multiple instances of Network Server to run on a single machine,
-each using its own unique host:port combination. The host needs to be set
-to enable remote connections. By default, the Network Server will listen only
-on the loopback address. If the property is set to 0.0.0.0, Network Server
-will listen on all interfaces. Ensure that you are running under the security
-manager and that user authorization is enabled before you enable remote
-connections with this property. </section>
-<refsyn><title>Syntax</title> <codeblock>derby.drda.host=<i>hostname</i></codeblock> </refsyn>
-<section><title>Default</title> <p>If no host name is specified, the Network Server
-listens on the loopback address of the current machine (localhost).</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.host=myhost</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Static. You must restart the
-Network Server for changes to take effect.</p> </section>
+<section><p>This property allows multiple instances of Network Server to run on
+a single machine, each using its own unique host:port combination. The host
+needs to be set to enable remote connections.</p>
+<p>By default, the Network Server will listen only on the loopback address. If
+the property is set to <codeph>0.0.0.0</codeph>, the Network Server will listen
+on all interfaces.</p>
+<p>Ensure that you are running under a security manager and that user
+authorization is enabled before you enable remote connections with this
+property.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.host=<i>hostName</i></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>If no host name is specified, the Network Server listens on the loopback
+address of the current machine (localhost).</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.host=myhost</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdakeepalive.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdakeepalive.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdakeepalive.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdakeepalive.dita Mon Nov 11 15:40:42 2013
@@ -19,25 +19,34 @@ limitations under the License.
-->
<reference id="radmindrdakeepalive" xml:lang="en-us">
<title>derby.drda.keepAlive property</title>
+<shortdesc>Indicates whether SO_KEEPALIVE is enabled on sockets.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.keepAlive property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>Indicates whether SO_KEEPALIVE is enabled on sockets. The keepAlive
-mechanism is used to detect when clients disconnect unexpectedly. A <i>keepalive
-probe</i> is sent to the client if a long time (by default, more than two
-hours) passes with no other data being sent or received.
-The <ph conref="../conrefs.dita#prod/productlowercase"></ph>.drda.keepAlive property is used to detect and clean up connections for
-clients on powered-off machines or clients that have disconnected unexpectedly.</p></section>
-<section><p>If the property is set to false, <ph conref="../conrefs.dita#prod/productshortname"></ph> will
-not attempt to clean up disconnected clients. The keepAlive mechanism might
-be disabled if clients need to resume work without reconnecting even after
-being disconnected from the network for some time. To disable keepAlive probes
-on Network Server connections, set this property to false.</p></section>
-<refsyn><title>Syntax</title><codeblock>derby.drda.keepAlive=[true|false] </codeblock></refsyn>
-<section><title>Default</title><p>True.</p></section>
-<example><title>Example</title><codeblock>derby.drdra.keepAlive=false </codeblock></example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for changes to take effect.</p></section>
+<section><p>The keepAlive mechanism is used to detect when clients disconnect
+unexpectedly. A <i>keepalive probe</i> is sent to the client if a long time (by
+default, more than two hours) passes with no other data being sent or received.
+The <codeph>derby.drda.keepAlive</codeph> property is used to detect and clean
+up connections for clients on powered-off machines or clients that have
+disconnected unexpectedly.</p></section>
+<section><p>If the property is set to <codeph>false</codeph>,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> will not attempt to
+clean up disconnected clients. The keepAlive mechanism might be disabled if
+clients need to resume work without reconnecting even after being disconnected
+from the network for some time. To disable keepAlive probes on Network Server
+connections, set this property to <codeph>false</codeph>.</p></section>
+<refsyn><title>Syntax</title>
+<codeblock>derby.drda.keepAlive={true|false} </codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>True.</p>
+</section>
+<example><title>Example</title>
+<codeblock>derby.drdra.keepAlive=false </codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdamaxthreads.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdamaxthreads.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdamaxthreads.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdamaxthreads.dita Mon Nov 11 15:40:42 2013
@@ -19,19 +19,30 @@ limitations under the License.
-->
<reference id="radmindrdamaxthreads" xml:lang="en-us">
<title>derby.drda.maxThreads property</title>
+<shortdesc>Sets the maximum number of connection threads that the Network Server
+will allocate.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.maxThreads property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Use the derby.drda.maxThreads property to set a maximum number of
-connection threads that Network Server will allocate. If all of the connection
-threads are currently being used and the Network Server has already allocated
-the maximum number of threads, the threads will be shared by using the derby.drda.timeSlice
-property to determine when sessions will be swapped.</section>
-<refsyn><title>Syntax</title><codeblock><ph>derby.drda.maxThreads=<i>numthreads</i></ph></codeblock> </refsyn>
-<section><title>Default</title><p>0</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.maxThreads=50</b></codeblock> </example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for changes to take effect.</p> </section>
+<section>
+<p>If all of the connection threads are currently being used and the Network
+Server has already allocated the maximum number of threads, the threads will be
+shared by using the <codeph><xref
+href="radmindrdatimeslice.dita#radmindrdatimeslice">derby.drda.timeSlice</xref></codeph>
+property to determine when sessions will be swapped.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><ph>derby.drda.maxThreads=<i>numThreads</i></ph></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>0 (zero).</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.maxThreads=50</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdaminthreads.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdaminthreads.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdaminthreads.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdaminthreads.dita Mon Nov 11 15:40:42 2013
@@ -19,17 +19,26 @@ limitations under the License.
-->
<reference id="radmindrdaminthreads" xml:lang="en-us">
<title>derby.drda.minThreads property</title>
+<shortdesc>Sets the minimum number of connection threads that the Network Server
+will allocate.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.minThreads property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Use the derby.drda.minThreads property to set the minimum number
-of connection threads that Network Server will allocate. By default, connection
-threads are allocated as needed.</section>
-<refsyn><title>Syntax</title><codeblock><ph>derby.drda.minThreads=<i>numthreads</i></ph></codeblock> </refsyn>
-<section><title>Default</title><p>0</p> </section>
-<example><title>Example</title><codeblock><b>derby.drda.minThreads=10</b></codeblock> </example>
-<section><title>Static or dynamic</title> <p>Static. You must restart the
-Network Server for changes to take effect.</p> </section>
+<section>
+<p>By default, connection threads are allocated as needed.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><ph>derby.drda.minThreads=<i>numThreads</i></ph></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>0 (zero).</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.minThreads=10</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdasecmechanism.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdasecmechanism.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdasecmechanism.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdasecmechanism.dita Mon Nov 11 15:40:42 2013
@@ -20,29 +20,37 @@ limitations under the License.
-->
<reference id="radmindrdasecmechanism" xml:lang="en-us">
<title>derby.drda.securityMechanism property</title>
+<shortdesc>Restricts the client connections based on the security
+mechanism.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.securityMechanism property</indexterm><indexterm>properties<indexterm>derby.drda.securityMechanism</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <codeph>derby.drda.securityMechanism</codeph> property restricts
-the client connections based on the security mechanism.</p>
-<p>If the <codeph>derby.drda.securityMechanism</codeph> property
-is set to a valid mechanism, the Network Server accepts only connections which
-use that security mechanism. No other types of connections are accepted.
-If the <codeph>derby.drda.securityMechanism</codeph> property is not set, the
-Network Server
-accepts any connection which uses a valid security mechanism.</p></section>
-<refsyn><title>Syntax</title><codeblock><ph>derby.drda.securityMechanism = [
+<section>
+<p>If the <codeph>derby.drda.securityMechanism</codeph> property is set to a
+valid mechanism, the Network Server accepts only connections which use that
+security mechanism. No other types of connections are accepted. If the
+<codeph>derby.drda.securityMechanism</codeph> property is not set, the Network
+Server accepts any connection which uses a valid security mechanism.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><ph>derby.drda.securityMechanism={
USER_ONLY_SECURITY |
CLEAR_TEXT_PASSWORD_SECURITY |
ENCRYPTED_USER_AND_PASSWORD_SECURITY
-] </ph></codeblock> </refsyn>
-<section><title>Default</title><p>None. </p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.securityMechanism=USER_ONLY_SECURITY
-</b></codeblock> The server that runs with this setting accepts only client
-connections with the USER_ONLY_SECURITY value. </example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for the changes that are associated with this property to take effect.</p> </section>
+}</ph></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>None.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.securityMechanism=USER_ONLY_SECURITY</b></codeblock>
+<p>The server that runs with this setting accepts only client connections with
+the <codeph>USER_ONLY_SECURITY</codeph> value.</p>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdasslmode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdasslmode.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdasslmode.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdasslmode.dita Mon Nov 11 15:40:42 2013
@@ -20,26 +20,31 @@ limitations under the License.
-->
<reference id="radmindrdasslmode" xml:lang="en-us">
<title>derby.drda.sslMode property</title>
+<shortdesc>Indicates whether the client connection is encrypted or not, and
+whether certificate-based peer authentication is enabled.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.sslMode property</indexterm><indexterm>properties<indexterm>derby.drda.sslMode</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The derby.drda.sslMode property indicates whether the client
-connection is encrypted or not, and whether certificate based peer
-authentication is enabled.</p>
-</section>
<refsyn>
<title>Syntax</title>
-<codeblock>
-<ph>derby.drda.sslMode = [ off | basic | peerAuthentication ]</ph>
-</codeblock>
+<codeblock><ph>derby.drda.sslMode={
+ off |
+ basic |
+ peerAuthentication
+}</ph></codeblock>
</refsyn>
-<section><title>Default</title><p><codeph>off</codeph></p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.sslMode=basic
-</b></codeblock> The server that runs with this setting accepts client
-connections encrypted with SSL.</example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for the changes that are associated with this property to take effect.</p> </section>
+<section><title>Default</title>
+<p><codeph>off</codeph>.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.sslMode=basic</b></codeblock>
+<p>The server that runs with this setting accepts client connections encrypted
+with SSL.</p>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radmindrdatimeslice.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radmindrdatimeslice.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radmindrdatimeslice.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radmindrdatimeslice.dita Mon Nov 11 15:40:42 2013
@@ -19,18 +19,28 @@ limitations under the License.
-->
<reference id="radmindrdatimeslice" xml:lang="en-us">
<title>derby.drda.timeSlice property</title>
+<shortdesc>Sets the number of milliseconds that each connection will use before
+yielding to another connection.</shortdesc>
<prolog><metadata>
<keywords><indexterm>derby.drda.timeSlice property</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section>Use the derby.drda.timeSlice property to set the number of milliseconds
-that each connection will use before yielding to another connection. This
-property is relevant only if the derby.drda.maxThreads property is set
-to a value greater than zero.</section>
-<refsyn><title>Syntax</title><codeblock><ph>derby.drda.timeSlice=<i>milliseconds</i></ph></codeblock> </refsyn>
-<section><title>Default</title><p>0</p> </section>
-<example> <title>Example</title><codeblock><b>derby.drda.timeSlice=2000</b></codeblock> </example>
-<section><title>Static or dynamic</title><p>Static. You must restart the Network
-Server for changes to take effect.</p> </section>
+<section><p>
+This property is relevant only if the
+<codeph><xref href="radmindrdamaxthreads.dita#radmindrdamaxthreads">derby.drda.maxThreads</xref></codeph>
+property is set to a value greater than zero.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock><ph>derby.drda.timeSlice=<i>milliseconds</i></ph></codeblock>
+</refsyn>
+<section><title>Default</title>
+<p>0 (zero).</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>derby.drda.timeSlice=2000</b></codeblock>
+</example>
+<section><title>Static or dynamic</title>
+<p>Static. You must restart the Network Server for changes to take effect.</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminembeddedserverex.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminembeddedserverex.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminembeddedserverex.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminembeddedserverex.dita Mon Nov 11 15:40:42 2013
@@ -19,13 +19,19 @@ limitations under the License.
-->
<reference id="radminembeddedserverex" xml:lang="en-us">
<title>Embedded server example</title>
+<shortdesc>You can start the Network Server in another thread automatically
+when <ph conref="../conrefs.dita#prod/productshortname"></ph> starts by setting
+the <codeph>derby.drda.startNetworkServer</codeph> property, or you can start it
+by using a program.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Embedded server example</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>You can start the Network Server in another thread automatically
-when <ph conref="../conrefs.dita#prod/productshortname"></ph> starts by setting
-the <i>derby.drda.startNetworkServer</i> property (see <xref href="tadminconfigsettingnetwrokserverproperties.dita#tadminconfigsettingnetwrokserverproperties"></xref>), or you can start it by using a program. The following example shows how to start the Network Server by using a program:</p></section>
+<section><p>See <xref
+href="tadminconfigsettingnetwrokserverproperties.dita#tadminconfigsettingnetwrokserverproperties"></xref>
+for details on this property.</p>
+<p>The following example shows how to start the Network Server by using
+a program:</p></section>
<example> <codeblock>import org.apache.derby.drda.NetworkServerControl;
import java.net.InetAddress;
NetworkServerControl server = new NetworkServerControl
Modified: db/derby/docs/trunk/src/adminguide/radminexportarguments.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminexportarguments.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminexportarguments.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminexportarguments.dita Mon Nov 11 15:40:42 2013
@@ -29,61 +29,61 @@ procedures use specific parameters.</sho
</keywords></metadata></prolog>
<refbody>
<section><dl><dlentry>
-<dt id="radminexportschemaname">SCHEMANAME</dt>
+<dt id="radminexportschemaname"><codeph>SCHEMANAME</codeph></dt>
<dd>Specifies the schema of the table. You can specify a NULL value to use the
-default schema name. The <parmname>SCHEMANAME</parmname> parameter takes an
+default schema name. The <codeph>SCHEMANAME</codeph> parameter takes an
input argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportselectstatement">SELECTSTATEMENT</dt>
+<dt id="radminexportselectstatement"><codeph>SELECTSTATEMENT</codeph></dt>
<dd>Specifies the SELECT statement query that returns the data to be exported.
Specifying a NULL value will result in an error. The
-<parmname>SELECTSTATEMENT</parmname> parameter takes an input argument that is
+<codeph>SELECTSTATEMENT</codeph> parameter takes an input argument that is
a VARCHAR(32672) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexporttablename">TABLENAME</dt>
+<dt id="radminexporttablename"><codeph>TABLENAME</codeph></dt>
<dd>Specifies the table name of the table or view from which the data is to
be exported. This table cannot be a system table or a declared temporary table.
The string must exactly match the case of the table name. Specifying a NULL
-value results in an error. The <parmname>TABLENAME</parmname> parameter takes
+value results in an error. The <codeph>TABLENAME</codeph> parameter takes
an input argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportfilename">FILENAME</dt>
+<dt id="radminexportfilename"><codeph>FILENAME</codeph></dt>
<dd>Specifies the file to which the data is to be exported. If the path is
omitted, the current working directory is used. If the name of a file that
already exists is specified, the export utility overwrites the contents of the
file; it does not append the information. The specified location of the file
should refer to the server-side location if you are using the Network Server.
-Specifying a NULL value results in an error. The <parmname>FILENAME</parmname>
+Specifying a NULL value results in an error. The <codeph>FILENAME</codeph>
parameter takes an input argument that is a VARCHAR(32672) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportcolumndelimiter">COLUMNDELIMITER</dt>
+<dt id="radminexportcolumndelimiter"><codeph>COLUMNDELIMITER</codeph></dt>
<dd>Specifies a column delimiter. The specified character is used in place of a
comma to signify the end of a column. You can specify a NULL value to use the
-default value of a comma. The <parmname>COLUMNDELIMITER</parmname> parameter
+default value of a comma. The <codeph>COLUMNDELIMITER</codeph> parameter
must be a CHAR(1) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportcharacterdelimiter">CHARACTERDELIMITER</dt>
+<dt id="radminexportcharacterdelimiter"><codeph>CHARACTERDELIMITER</codeph></dt>
<dd>Specifies a character delimiter. The specified character is used in place of
double quotation marks to enclose a character string. You can specify a NULL
value to use the default value of a double quotation mark. The
-<parmname>CHARACTERDELIMITER</parmname> parameter takes an input argument that
+<codeph>CHARACTERDELIMITER</codeph> parameter takes an input argument that
is a CHAR(1) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportcodeset">CODESET</dt>
+<dt id="radminexportcodeset"><codeph>CODESET</codeph></dt>
<dd>Specifies the code set of the data in the export file. The code set name
-should be one of the Java supported character encoding sets. Data is converted
+should be one of the Java supported character encoding sets. Data is converted
from the database code page to the specified code page before writing to the
file. You can specify a NULL value to write the data in the same code page
-as the JVM in which it is being executed. The <parmname>CODESET</parmname>
+as the JVM in which it is being executed. The <codeph>CODESET</codeph>
parameter takes an input argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminexportlobsfilename">LOBSFILENAME</dt>
+<dt id="radminexportlobsfilename"><codeph>LOBSFILENAME</codeph></dt>
<dd>Specifies the file that the large object data is exported to. If the path is
omitted, the LOB file is created in the same directory as the main export file.
If you specify the name of an existing file, the export utility overwrites the
contents of the file. The data is not appended to the file. If you are using the
Network Server, the file should be in a server-side location. Specifying a NULL
-value results in an error. The <parmname>LOBSFILENAME</parmname> parameter takes
+value results in an error. The <codeph>LOBSFILENAME</codeph> parameter takes
an input argument that is a VARCHAR(32672) data type.</dd>
</dlentry></dl>
<p>If you create a schema, table, or column name as a non-delimited identifier,
Modified: db/derby/docs/trunk/src/adminguide/radminimport64241.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminimport64241.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminimport64241.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminimport64241.dita Mon Nov 11 15:40:42 2013
@@ -30,68 +30,68 @@ procedures use specific parameters.</sho
<refbody>
<section>
<dl><dlentry>
-<dt id="radminimportschemaname">SCHEMANAME</dt>
+<dt id="radminimportschemaname"><codeph>SCHEMANAME</codeph></dt>
<dd>Specifies the schema of the table. You can specify a NULL value to use
-the default schema name. The <parmname>SCHEMANAME</parmname> parameter takes
+the default schema name. The <codeph>SCHEMANAME</codeph> parameter takes
an input argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimport27122">TABLENAME</dt>
+<dt id="radminimport27122"><codeph>TABLENAME</codeph></dt>
<dd>Specifies the name of the table into which the data is to be imported.
This table cannot be a system table or a declared temporary table. The string
must exactly match the case of the table name. Specifying a NULL value results
-in an error. The <parmname>TABLENAME</parmname> parameter takes an input
+in an error. The <codeph>TABLENAME</codeph> parameter takes an input
argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportinsertcolumns">INSERTCOLUMNS</dt>
+<dt id="radminimportinsertcolumns"><codeph>INSERTCOLUMNS</codeph></dt>
<dd>Specifies the comma-separated column names of the table into which the
data will be imported. You can specify a NULL value to import into all columns
-of the table. The <parmname>INSERTCOLUMNS</parmname> parameter takes an input
+of the table. The <codeph>INSERTCOLUMNS</codeph> parameter takes an input
argument that is a VARCHAR(32672) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportcolumnindexes">COLUMNINDEXES</dt>
+<dt id="radminimportcolumnindexes"><codeph>COLUMNINDEXES</codeph></dt>
<dd>Specifies the comma-separated column indexes (numbered from one) of the
input data fields that will be imported. You can specify a NULL value to use all
-input data fields in the file. The <parmname>COLUMNINDEXES</parmname> parameter
+input data fields in the file. The <codeph>COLUMNINDEXES</codeph> parameter
takes an input argument that is a VARCHAR(32672) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportfilename">FILENAME</dt>
+<dt id="radminimportfilename"><codeph>FILENAME</codeph></dt>
<dd>Specifies the name of the file that contains the data to be imported.
If the path is omitted, the current working directory is used. The specified
location of the file should refer to the server side location if you are using
the Network Server. Specifying a NULL value results in an error. The
-<parmname>FILENAME</parmname> parameter takes an input argument that is a
+<codeph>FILENAME</codeph> parameter takes an input argument that is a
VARCHAR(32672) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportcolumndelimiter">COLUMNDELIMITER</dt>
+<dt id="radminimportcolumndelimiter"><codeph>COLUMNDELIMITER</codeph></dt>
<dd>Specifies a column delimiter. The specified character is used in place
of a comma to signify the end of a column. You can specify a NULL value to
-use the default value of a comma. The <parmname>COLUMNDELIMITER</parmname>
+use the default value of a comma. The <codeph>COLUMNDELIMITER</codeph>
parameter takes an input argument that is a CHAR(1) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportcharacterdelimiter">CHARACTERDELIMITER</dt>
+<dt id="radminimportcharacterdelimiter"><codeph>CHARACTERDELIMITER</codeph></dt>
<dd>Specifies a character delimiter. The specified character is used in place
of double quotation marks to enclose a character string. You can specify a
NULL value to use the default value of a double quotation mark. The
-<parmname>CHARACTERDELIMITER</parmname> parameter takes an input argument that
+<codeph>CHARACTERDELIMITER</codeph> parameter takes an input argument that
is a CHAR(1) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportcodesetarg">CODESET</dt>
+<dt id="radminimportcodesetarg"><codeph>CODESET</codeph></dt>
<dd>Specifies the code set of the data in the input file. The code set name
should be one of the Java supported character encoding sets. Data is converted
from the specified code set to the database code set (UTF-8). You can specify
a NULL value to interpret the data file in the same code set as the JVM in
-which it is being executed. The <parmname>CODESET</parmname> parameter takes
+which it is being executed. The <codeph>CODESET</codeph> parameter takes
an input argument that is a VARCHAR(128) data type.</dd>
</dlentry><dlentry>
-<dt id="radminimportreplace">REPLACE</dt>
-<dd>A non-zero value for the replace parameter will import in REPLACE mode,
-while a zero value will import in INSERT mode. REPLACE mode deletes all existing
-data from the table by truncating the table and inserts the imported data.
-The table definition and the index definitions are not changed. You can import
-with REPLACE mode only if the table already exists. INSERT mode adds the
-imported data to the table without changing the existing table data. Specifying
-a NULL value results in an error. The <parmname>REPLACE</parmname> parameter
-takes an input argument that is a SMALLINT data type.</dd>
+<dt id="radminimportreplace"><codeph>REPLACE</codeph></dt>
+<dd>A non-zero value for the <codeph>REPLACE</codeph> parameter will import in
+REPLACE mode, while a zero value will import in INSERT mode. REPLACE mode
+deletes all existing data from the table by truncating the table and inserts the
+imported data. The table definition and the index definitions are not changed.
+You can import with REPLACE mode only if the table already exists. INSERT mode
+adds the imported data to the table without changing the existing table data.
+Specifying a NULL value results in an error. The <codeph>REPLACE</codeph>
+parameter takes an input argument that is a SMALLINT data type.</dd>
</dlentry></dl>
<p>If you create a schema, table, or column name as a non-delimited identifier,
you must pass the name to the import procedure using all uppercase characters.
Modified: db/derby/docs/trunk/src/adminguide/radminimport91458.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminimport91458.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminimport91458.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminimport91458.dita Mon Nov 11 15:40:42 2013
@@ -34,8 +34,8 @@ limitations under the License.
<p>The following example shows how to import data into the STAFF table in a
sample database from the <codeph>myfile.del</codeph> file. The data will be
appended to the existing data in the table.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
- null,'STAFF','myfile.del',null,null,null,0);</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
+ null,'STAFF','myfile.del',null,null,null,0);</b></codeblock>
</section>
<section><title>Example: Importing all data from a delimited file</title>
<p>The following example shows how to import data into the STAFF table in a
@@ -43,8 +43,8 @@ sample database from a delimited data fi
example defines the percentage character (<codeph>%</codeph>) as the string
delimiter, and a semicolon as the column delimiter. The data will be appended to
the existing data in the table.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
- null,'STAFF','c:\output\myfile.del',';','%',null,0);</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
+ null,'STAFF','c:\output\myfile.del',';','%',null,0);</b></codeblock>
</section>
<section><title>Example: Importing all data from a table, using a separate
import file for the LOB data</title>
@@ -54,8 +54,8 @@ import file <codeph>staff.del</codeph> i
references that point to a separate file which contains the LOB data. This
example specifies a comma as the column delimiter. The data will be appended to
the existing data in the table.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(
- null,'STAFF','c:\data\staff.del',',','"','UTF-8',0);</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE_LOBS_FROM_EXTFILE(
+ null,'STAFF','c:\data\staff.del',',','"','UTF-8',0);</b></codeblock>
</section>
<section><title>Example: Importing data into specific columns, using a separate
import file for the LOB data</title>
@@ -67,16 +67,16 @@ file which contains the LOB data. The da
double quotation marks (<codeph>"</codeph>) as the string delimiter and a comma
(<codeph>,</codeph>) as the column delimiter. The data will be appended to the
existing data in the STAFF table.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE(
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_DATA_LOBS_FROM_EXTFILE(
null, 'STAFF', 'NAME,DEPT,SALARY,PICTURE', '2,3,4,6',
- 'c:\data\staff.del', ',','"','UTF-8', 0);</codeblock>
+ 'c:\data\staff.del', ',','"','UTF-8', 0);</b></codeblock>
</section>
<section><title>Example: Exporting all data from a table to a single export
file</title>
<p>The following example shows how to export data from the STAFF table in a
sample database to the file <codeph>myfile.del</codeph>.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
- null,'STAFF','myfile.del',null,null,null);</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
+ null,'STAFF','myfile.del',null,null,null);</b></codeblock>
</section>
<section><title>Example: Exporting data from a table to a single delimited
export file</title>
@@ -84,25 +84,25 @@ export file</title>
delimited data file, <codeph>myfile.del</codeph>, with the percentage character
(<codeph>%</codeph>) as the character delimiter, and a semicolon as the column
delimiter from the STAFF table.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
- null,'STAFF','c:\output\myfile.del',';','%',null);</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
+ null,'STAFF','c:\output\myfile.del',';','%',null);</b></codeblock>
</section>
<section><title>Example: Exporting all data from a table, using a separate
export file for the LOB data</title>
<p>The following example shows how to export data from the STAFF table in a
sample database to the main file, <codeph>staff.del</codeph>, and the LOB export
file, <codeph>pictures.dat</codeph>.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE(null,'STAFF',
- 'c:\data\staff.del',',','"','UTF-8', 'c:\data\pictures.dat');</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE_LOBS_TO_EXTFILE(null,'STAFF',
+ 'c:\data\staff.del',',','"','UTF-8', 'c:\data\pictures.dat');</b></codeblock>
</section>
<section><title>Example: Exporting data from a query to a single export
file</title>
<p>The following example shows how to export employee data in department 20 from
the STAFF table in a sample database to the file
<codeph>awards.del</codeph>.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY(
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY(
'SELECT * FROM STAFF WHERE dept=20',
- 'c:\output\awards.del',null,null,null);</codeblock>
+ 'c:\output\awards.del',null,null,null);</b></codeblock>
</section>
<section><title>Example: Exporting data from a query, using a separate export
file for the LOB data </title>
@@ -110,10 +110,10 @@ file for the LOB data </title>
the STAFF table in a sample database to the main file,
<codeph>staff.del</codeph>, and the LOB data to the file
<codeph>pictures.dat</codeph>.</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE(
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_QUERY_LOBS_TO_EXTFILE(
'SELECT * FROM STAFF WHERE dept=20',
'c:\data\staff.del', ',' ,'"',
- 'UTF-8','c:\data\pictures.dat');</codeblock>
+ 'UTF-8','c:\data\pictures.dat');</b></codeblock>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminimportcodeset.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminimportcodeset.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminimportcodeset.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminimportcodeset.dita Mon Nov 11 15:40:42 2013
@@ -38,12 +38,12 @@ of character encodings, refer to your Ja
procedures</title>
<p>The following example shows how to specify UTF-8 encoding to export to the
<codeph>staff.dat</codeph> table:</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
- NULL,'STAFF','staff.dat',NULL,NULL,'UTF-8')</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE(
+ NULL,'STAFF','staff.dat',NULL,NULL,'UTF-8')</b></codeblock>
<p>The following example shows how to specify UTF-8 encoding to import from the
<codeph>staff.dat</codeph> table:</p>
-<codeblock>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
- NULL,'STAFF','staff.dat',NULL,NULL,'UTF-8',0)</codeblock>
+<codeblock><b>CALL SYSCS_UTIL.SYSCS_IMPORT_TABLE(
+ NULL,'STAFF','staff.dat',NULL,NULL,'UTF-8',0)</b></codeblock>
</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/adminguide/radminjmxcode.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxcode.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxcode.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxcode.dita Mon Nov 11 15:40:42 2013
@@ -20,6 +20,9 @@ limitations under the License.
<reference id="radminjmxcode" xml:lang="en-us">
<title>Using custom Java code to access the
<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans</title>
+<shortdesc>In addition to using a tool like JConsole, you can also access the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans from a Java
+application.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Java Management Extensions (JMX) technology</indexterm>
<indexterm>JMX<indexterm>using custom Java code</indexterm></indexterm>
@@ -27,12 +30,10 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>In addition to using a tool like JConsole, you can also access the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans from a Java
-application. How to do this may depend on how you configure the JVM that is
-running <ph conref="../conrefs.dita#prod/productshortname"></ph>, how you
-configure user authentication and authorization, or the host(s) from which you
-want to access the MBeans.</p>
+<p>How to do this may depend on how you configure the JVM that is running
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, how you configure user
+authentication and authorization, or the host(s) from which you want to access
+the MBeans.</p>
<p>This section has some example code to help you get started. You will find the
JMX classes you need in the packages <codeph>javax.management</codeph> and
<codeph>javax.management.remote</codeph>.</p>
@@ -160,8 +161,8 @@ a <codeph>ManagementMBean</codeph>:</p>
<ph conref="../conrefs.dita#prod/productshortname"></ph> MBean's object
name:</p>
<codeblock> // assuming we already have a reference to the ObjectName
- // of an MBean registered by Derby, for example the
- // Derby-registered ManagementMBean
+ // of an MBean registered by <ph conref="../conrefs.dita#prod/productshortname"></ph>, for example the
+ // <ph conref="../conrefs.dita#prod/productshortname"></ph>-registered ManagementMBean
String systemID = derbyMgmtObjectName.getKeyProperty("system");</codeblock>
</section>
<section><title>Accessing a specific
@@ -186,7 +187,7 @@ fully specifying its <codeph>String</cod
keyProps.put("type", "Version");
keyProps.put("jar", "derby.jar");
keyProps.put("system", systemID);
- // MBeans registered by Derby always belong to the
+ // MBeans registered by <ph conref="../conrefs.dita#prod/productshortname"></ph> always belong to the
// "org.apache.derby" domain
ObjectName versionObjectName =
new ObjectName("org.apache.derby", keyProps);
Modified: db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxdisable.dita Mon Nov 11 15:40:42 2013
@@ -19,6 +19,9 @@ limitations under the License.
-->
<reference id="radminjmxdisable" xml:lang="en-us">
<title>Disabling access to MBeans</title>
+<shortdesc>You may wish to disable or restrict access to MBeans in
+security-conscious environments. You can do this using either of the following
+techniques.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Java Management Extensions (JMX) technology</indexterm>
<indexterm>JMX<indexterm>disabling access</indexterm></indexterm>
@@ -26,8 +29,6 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>You may wish to disable or restrict access to MBeans in security-conscious
-environments. You can do this using either of the following techniques.</p>
<p>The first technique is to use the <codeph>stopManagement()</codeph> method of
<codeph>ManagementMBean</codeph>. This method unregisters all of the
<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans except
@@ -38,9 +39,9 @@ policy that does not grant <codeph>derby
register MBeans. For example, you can modify the Network Server's basic policy
(see <xref href="tadminnetservbasic.dita#tadminnetservbasic"></xref>) by
commenting out this section:</p>
-<codeblock>// Allows access to Derby's built-in MBeans, within the domain
+<codeblock>// Allows access to <ph conref="../conrefs.dita#prod/productshortname"></ph>'s built-in MBeans, within the domain
// org.apache.derby.
-// Derby must be allowed to register and unregister these MBeans.
+// <ph conref="../conrefs.dita#prod/productshortname"></ph> must be allowed to register and unregister these MBeans.
// It is possible to allow access only to specific MBeans, attributes or
// operations. To fine tune this permission, see the javadoc of
// javax.management.MBeanPermission or the JMX Instrumentation and Agent
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenabledisable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenabledisable.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenabledisable.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenabledisable.dita Mon Nov 11 15:40:42 2013
@@ -19,6 +19,8 @@ limitations under the License.
-->
<reference id="radminjmxenabledisable" xml:lang="en-us">
<title>Enabling and disabling JMX</title>
+<shortdesc>You can use JMX management and monitoring both locally and
+remotely.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Java Management Extensions (JMX) technology</indexterm>
<indexterm>JMX<indexterm>enabling and disabling</indexterm></indexterm>
@@ -26,13 +28,13 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>You can use JMX management and monitoring both locally and remotely. The
-term <term>local</term> means <i>on the same host (machine)</i> and <i>running
-as the same user</i>. For example, this means that local JMX access is possible
-only if the JVM you want to access is running on the same host and as the same
-user as the user who is running a JMX client such as JConsole (or a different user
-with sufficient file system permissions). In order to allow other users to access
-the JVM, or to allow access from other hosts, remote JMX must be enabled.</p>
+<p>The term <term>local</term> means <i>on the same host (machine)</i> and
+<i>running as the same user</i>. For example, this means that local JMX access
+is possible only if the JVM you want to access is running on the same host and
+as the same user as the user who is running a JMX client such as JConsole (or a
+different user with sufficient file system permissions). In order to allow other
+users to access the JVM, or to allow access from other hosts, remote JMX must be
+enabled.</p>
</section>
<section><title>Local JMX access</title>
<p>If you are using a Java SE 6 or later JVM, local JMX management and
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablenoauth.dita Mon Nov 11 15:40:42 2013
@@ -19,6 +19,10 @@ limitations under the License.
-->
<reference id="radminjmxenablenoauth" xml:lang="en-us">
<title>Enabling remote JMX with no authentication or SSL</title>
+<shortdesc>The following simple example starts the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server on the
+command line with <i>insecure</i> remote JMX management and monitoring enabled,
+using an Oracle JDK 6 or later JVM.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Java Management Extensions (JMX) technology</indexterm>
<indexterm>JMX<indexterm>enabling without authentication</indexterm></indexterm>
@@ -26,12 +30,8 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>The following simple example starts the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server on the
-command line with <i>insecure</i> remote JMX management and monitoring enabled,
-using an Oracle JDK 6 or later JVM. Password authentication over SSL is enabled by
-default, but here these security features are disabled, to keep the example
-simple.</p>
+<p>Password authentication over SSL is enabled by default, but here these
+security features are disabled, to keep the example simple.</p>
<p><note type="important">It is not recommended to disable authentication or SSL
in production environments.</note></p>
<codeblock><b>java -Dcom.sun.management.jmxremote.port=9999
Modified: db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita?rev=1540754&r1=1540753&r2=1540754&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita (original)
+++ db/derby/docs/trunk/src/adminguide/radminjmxenablepolicy.dita Mon Nov 11 15:40:42 2013
@@ -19,6 +19,8 @@ limitations under the License.
-->
<reference id="radminjmxenablepolicy" xml:lang="en-us">
<title>Fine-grained authorization using a security policy</title>
+<shortdesc>When you start the Network Server from the command line, it installs
+a security manager and a basic security policy by default.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Java Management Extensions (JMX) technology</indexterm>
<indexterm>JMX<indexterm>using a security policy</indexterm></indexterm>
@@ -26,10 +28,8 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section>
-<p>When you start the Network Server from the command line, it installs a
-security manager and a basic security policy by default. This policy includes
-the required permissions to allow JMX users to access the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans if JMX user
+<p>This policy includes the required permissions to allow JMX users to access
+the <ph conref="../conrefs.dita#prod/productshortname"></ph> MBeans if JMX user
authentication is disabled. If JMX user authentication is enabled, you may need
to grant additional permissions to specific users (JMXPrincipals).</p>
<p>The <codeph>NetworkServerMBean</codeph>'s <codeph>ping</codeph> operation
@@ -64,7 +64,7 @@ included in the code. Additional permiss
//
grant principal javax.management.remote.JMXPrincipal "controlRole" {
- // Derby system permissions (what is the user allowed to do?)
+ // <ph conref="../conrefs.dita#prod/productshortname"></ph> system permissions (what is the user allowed to do?)
// See API docs for SystemPermission and the specific MBeans for
// details.
permission org.apache.derby.security.SystemPermission "jmx", "control";
@@ -92,7 +92,7 @@ grant principal javax.management.remote.
// Extra permissions for application controlled ManagementMBean:
// Not needed if you do not intend to create/register your own
- // Derby Management MBean.
+ // <ph conref="../conrefs.dita#prod/productshortname"></ph> Management MBean.
// Wildcards (*) allow all domains, key properties and MBean members.
// You may want to be more specific here.
permission javax.management.MBeanPermission
@@ -104,7 +104,7 @@ grant principal javax.management.remote.
//
// jconsole:
// - most of these permissions are needed to let JConsole query the
- // MBean server and display information about Derby's mbeans as well
+ // MBean server and display information about <ph conref="../conrefs.dita#prod/productshortname"></ph>'s mbeans as well
// as some default platform MBeans/MXBeans.
// - if you don't use JConsole, but query the MBean server from your
// JMX client app, some of these permissions may be needed.
@@ -139,12 +139,12 @@ grant principal javax.management.remote.
grant codeBase "${derby.install.url}derby.jar"
{
- // Allows Derby to create an MBeanServer:
+ // Allows <ph conref="../conrefs.dita#prod/productshortname"></ph> to create an MBeanServer:
//
permission javax.management.MBeanServerPermission "createMBeanServer";
- // Allows access to Derby's built-in MBeans, within the domain
- // org.apache.derby. Derby must be allowed to register and unregister
+ // Allows access to <ph conref="../conrefs.dita#prod/productshortname"></ph>'s built-in MBeans, within the domain
+ // org.apache.derby. <ph conref="../conrefs.dita#prod/productshortname"></ph> must be allowed to register and unregister
// these MBeans.
// It is possible to allow access only to specific MBeans, attributes,
// or operations. To fine-tune this permission, see the API doc of
@@ -155,12 +155,12 @@ grant codeBase "${derby.install.url}derb
"org.apache.derby.*#[org.apache.derby:*]",
"registerMBean,unregisterMBean";
- // Trusts Derby code to be a source of MBeans and to register these in
+ // Trusts <ph conref="../conrefs.dita#prod/productshortname"></ph> code to be a source of MBeans and to register these in
// the MBean server.
//
permission javax.management.MBeanTrustPermission "register";
- // Gives permission for JMX to be used against Derby.
+ // Gives permission for JMX to be used against <ph conref="../conrefs.dita#prod/productshortname"></ph>.
// If JMX user authentication is being used, a whole set of
// fine-grained permissions needs to be granted to allow specific
// users access to MBeans and actions they perform (see JMXPrincipal
@@ -191,7 +191,7 @@ grant codeBase "${derby.install.url}derb
//
permission java.net.SocketPermission "*", "connect,resolve";
- // Gives permission for JMX to be used against Derby.
+ // Gives permission for JMX to be used against <ph conref="../conrefs.dita#prod/productshortname"></ph>.
// If JMX user authentication is being used, a whole set of
// fine-grained permissions need to be granted to allow specific users
// access to MBeans and actions they perform (see JMXPrincipal