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 2014/06/18 20:14:45 UTC
svn commit: r1603559 [1/2] - /db/derby/docs/trunk/src/ref/
Author: chaase3
Date: Wed Jun 18 18:14:43 2014
New Revision: 1603559
URL: http://svn.apache.org/r1603559
Log:
DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element
Modified 39 Reference Manual topics.
Patch: DERBY-6379-ref-attrib.diff
Modified:
db/derby/docs/trunk/src/ref/rrefattrib10035.dita
db/derby/docs/trunk/src/ref/rrefattrib15290.dita
db/derby/docs/trunk/src/ref/rrefattrib16471.dita
db/derby/docs/trunk/src/ref/rrefattrib17246.dita
db/derby/docs/trunk/src/ref/rrefattrib24612.dita
db/derby/docs/trunk/src/ref/rrefattrib26867.dita
db/derby/docs/trunk/src/ref/rrefattrib34183.dita
db/derby/docs/trunk/src/ref/rrefattrib42100.dita
db/derby/docs/trunk/src/ref/rrefattrib42686.dita
db/derby/docs/trunk/src/ref/rrefattrib56769.dita
db/derby/docs/trunk/src/ref/rrefattrib60346.dita
db/derby/docs/trunk/src/ref/rrefattrib72457.dita
db/derby/docs/trunk/src/ref/rrefattrib88843.dita
db/derby/docs/trunk/src/ref/rrefattribcollation.dita
db/derby/docs/trunk/src/ref/rrefattribdecryptdb.dita
db/derby/docs/trunk/src/ref/rrefattribderegister.dita
db/derby/docs/trunk/src/ref/rrefattribdrop.dita
db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita
db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita
db/derby/docs/trunk/src/ref/rrefattribfailover.dita
db/derby/docs/trunk/src/ref/rrefattribnewbootpw.dita
db/derby/docs/trunk/src/ref/rrefattribnewencryptkey.dita
db/derby/docs/trunk/src/ref/rrefattribretrievemsgtext.dita
db/derby/docs/trunk/src/ref/rrefattribsecmech.dita
db/derby/docs/trunk/src/ref/rrefattribslavehost.dita
db/derby/docs/trunk/src/ref/rrefattribslaveport.dita
db/derby/docs/trunk/src/ref/rrefattribssl.dita
db/derby/docs/trunk/src/ref/rrefattribstartmaster.dita
db/derby/docs/trunk/src/ref/rrefattribstartslave.dita
db/derby/docs/trunk/src/ref/rrefattribstopmaster.dita
db/derby/docs/trunk/src/ref/rrefattribstopslave.dita
db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita
db/derby/docs/trunk/src/ref/rrefattribtracefile.dita
db/derby/docs/trunk/src/ref/rrefattribtracefileappend.dita
db/derby/docs/trunk/src/ref/rrefattribtracelevel.dita
db/derby/docs/trunk/src/ref/rrefattribupgrade.dita
db/derby/docs/trunk/src/ref/rrefcreatefrom.dita
db/derby/docs/trunk/src/ref/rrefrestorefrom.dita
db/derby/docs/trunk/src/ref/rrefrollforward.dita
Modified: db/derby/docs/trunk/src/ref/rrefattrib10035.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib10035.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib10035.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib10035.dita Wed Jun 18 18:14:43 2014
@@ -20,19 +20,24 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib10035" xml:lang="en-us">
<title>user=userName attribute</title>
+<shortdesc>The <i>user=userName</i> attribute specifies a valid user name for
+the system, in conjunction with a password.</shortdesc>
<prolog><metadata>
<keywords><indexterm>user=userName database connection URL attribute</indexterm>
+<indexterm>attributes<indexterm>user</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section> <p>Specifies a valid user name for the system, specified with a
-password. A valid user name and password are required when user authentication
+<section><p>A valid user name and password are required when user authentication
is turned on.</p></section>
-<section><title>Combining with other attributes</title> <p>Use
-in conjunction with the <i><xref href="rrefattrib42686.dita#rrefattrib42686">password=userPassword</xref></i> attribute.</p> </section>
+<section><title>Combining with other attributes</title>
+<p>Use this attribute in conjunction with the
+<i><xref href="rrefattrib42686.dita">password=userPassword</xref></i>
+attribute.</p>
+</section>
<example><title>Example</title>
-<p>The following database connection URL connects the user jill
-to <i>toursDB</i>:</p> <codeblock><b>jdbc:derby:toursDB;user=jill;password=toFetchAPail</b></codeblock> </example>
+<codeblock><b>-- connect the user jill to toursDB
+jdbc:derby:toursDB;user=jill;password=toFetchAPail</b></codeblock> </example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattrib15290.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib15290.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib15290.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib15290.dita Wed Jun 18 18:14:43 2014
@@ -20,17 +20,19 @@ limitations under the License.
-->
<reference id="rrefattrib15290" xml:lang="en-us">
<title>dataEncryption=true attribute</title>
+<shortdesc>The <i>dataEncryption=true</i> attribute specifies data encryption on
+disk for a new database or to configure an existing unencrypted database for
+encryption.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>dataEncryption=true attribute</indexterm><indexterm>encrypting
-databases<indexterm>data encryption</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-data encryption</indexterm></indexterm><indexterm>attributes<indexterm>dataEncryption</indexterm></indexterm>
+<keywords><indexterm>dataEncryption=true database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>data encryption</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>dataEncryption</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies data encryption on disk for a
-new database or to configure an existing unencrypted database for encryption.
-For information about data encryption, see "Configuring database encryption"
-in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
+<section><p>For information about data encryption, see "Configuring database
+encryption" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
<p>After you encrypt a database, you can return it to the unencrypted
state by specifying the
<i><xref href="rrefattribdecryptdb.dita#rrefattribdecryptdb">decryptDatabase=true</xref></i>
Modified: db/derby/docs/trunk/src/ref/rrefattrib16471.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib16471.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib16471.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib16471.dita Wed Jun 18 18:14:43 2014
@@ -20,42 +20,50 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib16471" xml:lang="en-us">
<title>shutdown=true attribute</title>
+<shortdesc>The <i>shutdown=true</i> attribute shuts down the specified database
+if you specify a <i>databaseName</i>. (Reconnecting to the database reboots the
+database.)</shortdesc>
<prolog><metadata>
<keywords><indexterm>shutdown=true database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>shutting down</indexterm></indexterm>
+<indexterm>attributes<indexterm>shutdown</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>Shuts down the specified database if you
-specify a <i>databaseName</i>. (Reconnecting to the database reboots the database.)
-For a database for which authentication and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref>
-can perform shutdown of that database.
-See "Configuring user authentication" and "Configuring user authorization" in
-the <ph conref="../conrefs.dita#pub/citsec"></ph>
-for more information.
-</p> <p>Shuts
-down the entire <ph conref="../conrefs.dita#prod/productshortname"></ph> system
-if and only if you do not specify a <i>databaseName</i>.</p>
-<p>When you are
-shutting down a single database, it lets <ph conref="../conrefs.dita#prod/productshortname"></ph> perform
-a final checkpoint on the database.</p> <p>When you are shutting down a system,
-it lets <ph conref="../conrefs.dita#prod/productshortname"></ph> perform a
-final checkpoint on all system databases, deregister the JDBC driver (if
-permitted; see <i><xref href="rrefattribderegister.dita#rrefattribderegister">deregister=false</xref></i>),
-and shut down within the JVM before the JVM exits. A successful shutdown always
-results in an <i>SQLException</i> indicating that <ph conref="../conrefs.dita#prod/productshortname"></ph> has
-shut down and that there is no connection. Once <ph conref="../conrefs.dita#prod/productshortname"></ph> is
-shut down, you can restart it by reloading the driver. For details on restarting <ph
-conref="../conrefs.dita#prod/productshortname"></ph>, see
-"Shutting down the system" in the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p> <p><i>Checkpointing</i> means
-writing all data and transaction information to disk so that no recovery needs
-to be performed at the next connection.</p> <p>Used to shut down the entire
-system only when it is embedded in an application. <note>Any request to
-the <i>DriverManager</i> with a <i>shutdown=true</i> attribute raises an exception.</note></p> </section>
+<section>
+<p>For a database for which authentication and SQL authorization are both
+enabled, only the <xref href="rrefattrib26867.dita">database owner</xref> can
+perform shutdown of that database. See "Configuring user authentication" and
+"Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</p>
+<p>Shuts down the entire
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system if and only if
+you do not specify a <i>databaseName</i>.</p>
+<p>When you are shutting down a single database, the attribute lets
+<ph conref="../conrefs.dita#prod/productshortname"></ph> perform a final
+checkpoint on the database.</p>
+<p>When you are shutting down a system, the attribute lets
+<ph conref="../conrefs.dita#prod/productshortname"></ph> perform a final
+checkpoint on all system databases, deregister the JDBC driver (if permitted;
+see <i><xref href="rrefattribderegister.dita">deregister=false</xref></i>), and
+shut down within the JVM before the JVM exits. A successful shutdown always
+results in an <i>SQLException</i> indicating that
+<ph conref="../conrefs.dita#prod/productshortname"></ph> has shut down and that
+there is no connection. Once
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is shut down, you can
+restart it by reloading the driver. For details on restarting
+<ph conref="../conrefs.dita#prod/productshortname"></ph>, see "Shutting down the
+system" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
+<p><i>Checkpointing</i> means writing all data and transaction information to
+disk so that no recovery needs to be performed at the next connection.</p>
+<p>The attribute is used to shut down the entire system only when it is embedded
+in an application.
+<note>Any request to the <i>DriverManager</i> with a <i>shutdown=true</i>
+attribute raises an exception.</note></p>
+</section>
<section><title>Combining with other attributes</title>
<p>This attribute may be combined with the
-<i><xref href="rrefattribderegister.dita#rrefattribderegister">deregister=false</xref></i>
+<i><xref href="rrefattribderegister.dita">deregister=false</xref></i>
attribute.</p>
<p>When you shut down a database, if authentication is turned on, you must
specify this attribute in conjunction with the <i><xref
Modified: db/derby/docs/trunk/src/ref/rrefattrib17246.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib17246.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib17246.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib17246.dita Wed Jun 18 18:14:43 2014
@@ -20,14 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib17246" xml:lang="en-us">
<title>databaseName=nameOfDatabase attribute</title>
+<shortdesc>The <i>databaseName=nameOfDatabase</i> attribute specifies a database
+path name for a connection.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>databaseName=nameOfDatabase database connection URL
-attribute</indexterm>
-<indexterm>Connecting to a database (using databaseName attribute)</indexterm>
-</keywords></metadata></prolog>
+<keywords><indexterm>databaseName=nameOfDatabase database connection URL attribute</indexterm>
+<indexterm>connecting to a database (using databaseName attribute)</indexterm>
+<indexterm>databases<indexterm>connecting to</indexterm></indexterm>
+<indexterm>attributes<indexterm>databaseName</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>Specifies a database path name for a
-connection. You can use this attribute instead of specifying the database name
+<section><p>You can use this attribute instead of specifying the database name
after the subprotocol.</p>
<p>The <i>nameOfDatabase</i> value can be either an absolute path name or a
path name relative to <i>derby.system.home</i>. For example,
@@ -46,21 +49,26 @@ equivalent:
to <i>toursDB</i> in the <i>Properties</i> object passed into a connection
request)</li>
</ul></p>
-<p>If you use a subsubprotocol to specify the database (for example,
-<i>memory</i> for an in-memory database), include the subsubprotocol
-as part of the <i>databaseName</i> attribute specification. For example:</p>
+<p>If you use a subsubprotocol to specify the database (for example,
+<i>memory</i> for an in-memory database), include the subsubprotocol as part of
+the <i>databaseName</i> attribute specification. For example:</p>
<codeblock><b>jdbc:derby:;databaseName=memory:myDB</b></codeblock>
-<p>If the database name is specified both in the URL (as a subname)
-and as an attribute, the database name set as the subname has priority. For
-example, the following database connection URL connects to <i>toursDB</i>:</p>
+<p>If the database name is specified both in the URL (as a subname) and as an
+attribute, the database name set as the subname has priority. For example, the
+following database connection URL connects to <i>toursDB</i>:</p>
<codeblock><b>jdbc:derby:toursDB;databaseName=flightsDB</b></codeblock>
-<p>Allowing the database name to be set as an attribute allows the <i>getPropertyInfo</i> method
-to return a list of choices for the database name based on the set of databases
-known to <ph conref="../conrefs.dita#prod/productshortname"></ph>. For more
-information, see <i><xref href="rrefjdbc34954.dita#rrefjdbc34954"></xref>.</i></p> </section>
-<section><title>Combining with other attributes</title> <p>You
-can combine this attribute with all other attributes.</p> </section>
-<example> <codeblock><b>jdbc:derby:;databaseName=newDB;create=true</b></codeblock> </example>
+<p>Allowing the database name to be set as an attribute allows the
+<i>getPropertyInfo</i> method to return a list of choices for the database name
+based on the set of databases known to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>. For more information,
+see <i><xref href="rrefjdbc34954.dita"/>.</i></p>
+</section>
+<section><title>Combining with other attributes</title>
+<p>You can combine this attribute with all other attributes.</p>
+</section>
+<example><title>Example</title>
+<codeblock><b>jdbc:derby:;databaseName=newDB;create=true</b></codeblock>
+</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattrib24612.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib24612.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib24612.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib24612.dita Wed Jun 18 18:14:43 2014
@@ -23,18 +23,19 @@ limitations under the License.
you to supply a list of attributes to its database connection URL, which is
a JDBC feature.</shortdesc>
<refbody>
-<section><p>The attributes are specific to <ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></section>
+<section><p>The attributes are specific to
+<ph conref="../conrefs.dita#prod/productshortname"></ph>.</p></section>
<section><p>You typically set attributes in a semicolon-separated list following
the protocol and subprotocol (and, in some cases, the subsubprotocol). For
-information on how you set attributes, see <xref
-href="rrefjdbc10889.dita#rrefjdbc10889"></xref>. This section provides reference
-information only.</p>
+information on how you set attributes, see <xref href="rrefjdbc10889.dita"/>.
+This section provides reference information only.</p>
<p>The <i>DriverManager.getConnection</i> method can take both a connection URL
and a <i>Properties</i> object as arguments. If you specify any attributes both
on the connection URL and in a <i>Properties</i> object, the attributes on the
connection URL override the attributes in the <i>Properties</i> object.</p>
</section>
-<section> <note>Attributes are not parsed for correctness. If you pass in
-an incorrect attribute or corresponding value, it is simply ignored.</note></section>
+<section><note>Attributes are not parsed for correctness. If you pass in an
+incorrect attribute or corresponding value, it is simply ignored.</note>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattrib26867.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib26867.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib26867.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib26867.dita Wed Jun 18 18:14:43 2014
@@ -20,53 +20,52 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib26867" xml:lang="en-us">
<title>create=true attribute</title>
+<shortdesc>The <i>create=true</i> attribute creates the standard database
+specified within the database connection URL
+<ph conref="../conrefs.dita#prod/productshortname"></ph> system and then
+connects to it.</shortdesc>
<prolog><metadata>
<keywords><indexterm>create=true database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>creating</indexterm></indexterm>
+<indexterm>attributes<indexterm>create</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>Creates the standard database specified
-within the database connection URL <ph conref="../conrefs.dita#prod/productshortname"></ph> system
-and then connects to it. If the database cannot be created, the 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>If the database already exists,
-creates a connection to the existing database and an <i>SQLWarning</i> is
-issued.</p> <p>JDBC does not remove the database on failure to connect at
-create time if failure occurs after the database call occurs. If a database
-connection URL used <i>create=true</i> and the connection fails to be created,
-check for the database directory. If it exists, remove it and its contents
-before the next attempt to create the database.</p>
+<section><p>If the database cannot be created, the 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>If the database already exists, the attribute creates a connection to the
+existing database, and an <i>SQLWarning</i> is issued.</p>
+<p>JDBC does not remove the database on failure to connect at create time if
+failure occurs after the database call occurs. If a database connection URL used
+<i>create=true</i> and the connection fails to be created, check for the
+database directory. If it exists, remove it and its contents before the next
+attempt to create the database.</p>
</section>
-<section><title>Database owner</title> <p>
- When the database is created, the current authorization identifier
- becomes the database owner (see the
- <i><xref href="rrefattrib10035.dita#rrefattrib10035"></xref></i>).
- If authentication and SQL authorization are both enabled (see "Configuring
- user authentication" and "Configuring user authorization" in
- the <ph conref="../conrefs.dita#pub/citsec"></ph>),
- only the database owner can
- <xref href="rrefattrib16471.dita#rrefattrib16471">shut down</xref>
- or <xref href="rrefattribdrop.dita#rrefattribdrop">drop</xref>
- the database,
- <xref href="rrefattrib15290.dita#rrefattrib15290">encrypt</xref> it,
- reencrypt it with a new
- <xref href="rrefattribnewbootpw.dita#rrefattribnewbootpw">boot password</xref>
- or new
- <xref href="rrefattribnewencryptkey.dita#rrefattribnewencryptkey">encryption key</xref>,
- or perform a full upgrade.
- If authentication is not enabled, and no
- user is supplied, the database owner defaults to "APP", which is also
- the name of the default schema (see <xref href="rrefsqlj32268.dita#rrefsqlj32268"></xref>).
-</p>
+<section><title>Database owner</title>
+<p>When the database is created, the current authorization identifier becomes
+the database owner (see the
+<i><xref href="rrefattrib10035.dita">user=userName</xref></i> attribute). If
+authentication and SQL authorization are both enabled (see "Configuring user
+authentication" and "Configuring user authorization" in the
+<ph conref="../conrefs.dita#pub/citsec"></ph>), only the database owner can
+<xref href="rrefattrib16471.dita">shut down</xref> or
+<xref href="rrefattribdrop.dita">drop</xref> the database,
+<xref href="rrefattrib15290.dita">encrypt</xref> it, reencrypt it with a new
+<xref href="rrefattribnewbootpw.dita">boot password</xref> or new
+<xref href="rrefattribnewencryptkey.dita">encryption key</xref>, or perform a
+full upgrade. If authentication is not enabled, and no user is supplied, the
+database owner defaults to "APP", which is also the name of the default schema
+(see <xref href="rrefsqlj32268.dita"></xref>).</p>
</section>
-<section><title>Combining with other attributes</title> <p>You
-must specify a <i>databaseName</i> (after the subprotocol or subsubprotocol in
-the database
-connection URL) or a <i><xref href="rrefattrib17246.dita#rrefattrib17246">databaseName=nameofDatabase</xref></i> attribute
-with this attribute.</p> <p>You can combine this attribute with other attributes.
-To specify a locale when creating a database, use the
-<i><xref href="rrefattrib56769.dita#rrefattrib56769">territory=ll_CC</xref></i>
-attribute.</p>
+<section><title>Combining with other attributes</title>
+<p>You must specify a <i>databaseName</i> (after the subprotocol or
+subsubprotocol in the database connection URL) or a
+<i><xref href="rrefattrib17246.dita">databaseName=nameofDatabase</xref></i>
+attribute with this attribute.</p>
+<p>You can combine this attribute with other attributes. To specify a locale
+when creating a database, use the
+<i><xref href="rrefattrib56769.dita">territory=ll_CC</xref></i> attribute.</p>
</section>
<example><title>Examples</title>
<p>Creating a file system database:</p>
Modified: db/derby/docs/trunk/src/ref/rrefattrib34183.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib34183.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib34183.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib34183.dita Wed Jun 18 18:14:43 2014
@@ -20,16 +20,23 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib34183" xml:lang="en-us">
<title>Creating a connection without specifying attributes</title>
+<shortdesc>If no attributes are specified, you must specify a
+<i>databaseName</i>.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>Attributes to database connection URL</indexterm></keywords>
+<keywords>
+<indexterm>database connection URL attributes</indexterm>
+<indexterm>attributes<indexterm>database connection URL</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section> <p>If no attributes are specified, you must specify a <i>databaseName.</i></p> <p><ph
-conref="../conrefs.dita#prod/productshortname"></ph> opens a connection to
-an existing database with that name in the current system directory. If the
-database does not exist, the connection attempt returns an <i>SQLException</i> indicating
-that the database cannot be found. </p></section>
-<example> <codeblock>jdbc:derby:mydb</codeblock> </example>
+<section>
+<p><ph conref="../conrefs.dita#prod/productshortname"></ph> opens a connection
+to an existing database with that name in the current system directory. If the
+database does not exist, the connection attempt returns an <i>SQLException</i>
+indicating that the database cannot be found.</p></section>
+<example><title>Example</title>
+<codeblock><b>jdbc:derby:mydb</b></codeblock>
+</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattrib42100.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib42100.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib42100.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib42100.dita Wed Jun 18 18:14:43 2014
@@ -20,14 +20,17 @@ limitations under the License.
-->
<reference id="rrefattrib42100" xml:lang="en-us">
<title>bootPassword=key attribute</title>
+<shortdesc>The <i>bootPassword=key</i> attribute specifies a boot password
+(encryption key).</shortdesc>
<prolog><metadata>
-<keywords><indexterm>bootPassword=key attribute</indexterm><indexterm>encrypting databases<indexterm>boot
-password key</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-boot password key</indexterm></indexterm><indexterm>attributes<indexterm>bootPassword</indexterm></indexterm>
+<keywords><indexterm>bootPassword=key database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>boot password key</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>bootPassword</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies the key to use to: <ul>
+<section><p>The attribute specifies the key to use to:<ul>
<li>Encrypt a new database</li>
<li>Configure an existing unencrypted database for encryption</li>
<li>Boot an existing encrypted database</li>
Modified: db/derby/docs/trunk/src/ref/rrefattrib42686.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib42686.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib42686.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib42686.dita Wed Jun 18 18:14:43 2014
@@ -20,15 +20,21 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib42686" xml:lang="en-us">
<title>password=userPassword attribute</title>
+<shortdesc>The <i>password=userPassword</i> attribute specifies a valid password
+for the given user name.</shortdesc>
<prolog><metadata>
<keywords><indexterm>password=userPassword database connection URL attribute</indexterm>
+<indexterm>attributes<indexterm>password</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>A valid password for the given user name. </p> </section>
-<section><title>Combining with other attributes</title> <p>Use
-in conjunction with the <i><xref href="rrefattrib10035.dita#rrefattrib10035">user=userName</xref></i> attribute.</p> </section>
+<section><title>Combining with other attributes</title>
+<p>Use this attribute in conjunction with the
+<i><xref href="rrefattrib10035.dita">user=userName</xref></i> attribute.</p>
+</section>
<example><title>Example</title>
-<codeblock><b>jdbc:derby:toursDB;user=jack;password=upTheHill</b></codeblock> </example>
+<codeblock><b>-- connect the user jack to toursDB
+jdbc:derby:toursDB;user=jack;password=upTheHill</b></codeblock>
+</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattrib56769.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib56769.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib56769.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib56769.dita Wed Jun 18 18:14:43 2014
@@ -20,23 +20,25 @@ limitations under the License.
-->
<reference id="rrefattrib56769" xml:lang="en-us">
<title>territory=ll_CC attribute</title>
+<shortdesc>The <i>territory=ll_CC</i> attribute associates a non-default locale
+with a database at database creation time.</shortdesc>
<prolog><metadata>
<keywords><indexterm>territory=ll_CC database connection URL attribute</indexterm>
-<indexterm>Databases<indexterm>locale</indexterm></indexterm>
+<indexterm>databases<indexterm>specifying locale</indexterm></indexterm>
<indexterm>locale<indexterm>database</indexterm></indexterm>
-<indexterm>Internationalization features<indexterm>setting locale</indexterm></indexterm>
+<indexterm>internationalization features<indexterm>setting locale</indexterm></indexterm>
+<indexterm>attributes<indexterm>territory</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>When creating a database,
-use this attribute to associate a non-default locale with the database.
-Setting the <i>territory=ll_CC</i> attribute overrides the default system locale
-for that database. To find the default system locale, use the
-<i>java.util.Locale.getDefault</i> method.</p> <p>Specify
-a locale in the form <i>ll_CC</i>, where <i>ll</i> is the two-letter language
-code, and <i>CC</i> is the two-letter country code. </p> <p>Language codes
-consist of a pair of lowercase letters that conform to ISO 639-1. The following
-table shows some examples.</p>
+<section>
+<p>Setting the <i>territory=ll_CC</i> attribute overrides the default system
+locale for that database. To find the default system locale, use the
+<i>java.util.Locale.getDefault</i> method.</p>
+<p>Specify a locale in the form <i>ll_CC</i>, where <i>ll</i> is the two-letter
+language code, and <i>CC</i> is the two-letter country code.</p>
+<p>Language codes consist of a pair of lowercase letters that conform to
+ISO 639-1. The following table shows some examples.</p>
<table frame="all">
<title>Sample language codes</title>
<desc>This table lists and describes some examples of language codes.</desc>
@@ -69,9 +71,9 @@ table shows some examples.</p>
</tbody>
</tgroup>
</table>
-<p>To see a full list of ISO 639 codes, go to <xref format="html"
-href="http://www.loc.gov/standards/iso639-2/php/code_list.php" scope="external">
-<i>http://www.loc.gov/standards/iso639-2/php/code_list.php</i></xref>.</p>
+<p>To see a full list of ISO 639 codes, go to <i><xref format="html"
+href="http://www.loc.gov/standards/iso639-2/php/code_list.php"
+scope="external"/></i>.</p>
<p>Country codes consist of two uppercase letters that conform to ISO 3166. The
following table shows some examples.</p>
<table frame="all">
@@ -110,21 +112,21 @@ following table shows some examples.</p>
</tbody>
</tgroup>
</table>
-<p>A copy of ISO 3166 can be found at <xref format="html"
+<p>A copy of ISO 3166 can be found at <i><xref format="html"
href="http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html"
-scope="external"><i>http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</i>
-</xref>.</p> </section>
+scope="external"/></i>.</p> </section>
<section><title>Combining with other attributes</title>
<p>Use the <i>territory=ll_CC</i> attribute only when you create a database.</p>
+</section>
+<section><title>Example</title>
<p>In the following example, the new database has a locale of Spanish language
and Mexican nationality.</p>
<codeblock><b>jdbc:derby:MexicanDB;create=true;territory=es_MX</b></codeblock>
<p>You can use the
-<xref href="rrefattribcollation.dita#rrefattribcollation">
-<i>collation=collation</i></xref> attribute with
-the <i>territory=ll_CC</i> attribute to specify that collation is based
-on the locale, instead of being based on Unicode codepoint collation. For more
-information, see "Creating a database with locale-based collation",
+<xref href="rrefattribcollation.dita"><i>collation=collation</i></xref>
+attribute with the <i>territory=ll_CC</i> attribute to specify that collation is
+based on the locale, instead of being based on Unicode codepoint collation. For
+more information, see "Creating a database with locale-based collation",
"Creating a case-insensitive database", and "Character-based collation in
<ph conref="../conrefs.dita#prod/productshortname"></ph>" in the
<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
Modified: db/derby/docs/trunk/src/ref/rrefattrib60346.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib60346.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib60346.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib60346.dita Wed Jun 18 18:14:43 2014
@@ -20,20 +20,26 @@ limitations under the License.
-->
<reference id="rrefattrib60346" xml:lang="en-us">
<title>encryptionAlgorithm=algorithm attribute</title>
+<shortdesc>The <i>encryptionAlgorithm=algorithm</i> attribute specifies the
+algorithm for data encryption.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>encryptionAlgorithm=algorithm attribute</indexterm><indexterm>encrypting
-databases<indexterm>encryption algorithms</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-encryption algorithm</indexterm></indexterm><indexterm>attributes<indexterm>encryptionAlgorithm</indexterm></indexterm>
+<keywords><indexterm>encryptionAlgorithm=algorithm database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>encryption algorithms</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>encryptionAlgorithm</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies the algorithm for data encryption. </p><p>Use
-the Java conventions when you specify the algorithm, for example: <codeblock><b><b><i>algorithmName</i></b>/<b><i>feedbackMode</i></b>/<b><i>padding</i
-></b></b></codeblock></p><p>The only padding type that is allowed with <ph
-conref="../conrefs.dita#prod/productshortname"></ph> is <i>NoPadding</i>.</p><p>If
-no encryption algorithm is specified, the default value is <i>DES/CBC/NoPadding</i>.</p><p>For
-information about data encryption, see "Configuring database encryption" in the
-<ph conref="../conrefs.dita#pub/citsec"></ph>.</p> </section>
+<section><p>Use the Java conventions when you specify the algorithm. For
+example:</p>
+<codeblock><b><i>algorithmName</i>/<i>feedbackMode</i>/<i>padding</i></b></codeblock>
+<p>The only padding type that is allowed with
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is
+<i>NoPadding</i>.</p>
+<p>If no encryption algorithm is specified, the default value is
+<i>DES/CBC/NoPadding</i>.</p>
+<p>For information about data encryption, see "Configuring database encryption"
+in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p> </section>
<section><title>Combining with other attributes</title>
<p>The <i>encryptionAlgorithm=algorithm</i> attribute must be combined with the
<i><xref href="rrefattrib15290.dita#rrefattrib15290">dataEncryption=true</xref></i>
Modified: db/derby/docs/trunk/src/ref/rrefattrib72457.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib72457.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib72457.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib72457.dita Wed Jun 18 18:14:43 2014
@@ -20,14 +20,17 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattrib72457" xml:lang="en-us">
<title>logDevice=logDirectoryPath attribute</title>
+<shortdesc>The <i>logDevice=logDirectoryPath</i> attribute specifies the path to
+the directory on which to store the database log during database creation or
+restoration.</shortdesc>
<prolog><metadata>
<keywords><indexterm>logDevice=logDirectoryPath database connection URL attribute</indexterm>
+<indexterm>databases<indexterm>specifying log file location</indexterm></indexterm>
+<indexterm>attributes<indexterm>logDevice</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title> <p>The <i>logDirectoryPath</i> specifies
-the path to the directory on which to store the database log during database
-creation or restore. Even if specified as a relative path, the <i>logDirectoryPath</i> is
+<section><p>Even if specified as a relative path, the <i>logDirectoryPath</i> is
stored internally as an absolute path.</p>
<p>For more information about using this attribute, see "Using the
logDevice=logDirectoryPath attribute" in the
Modified: db/derby/docs/trunk/src/ref/rrefattrib88843.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib88843.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib88843.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib88843.dita Wed Jun 18 18:14:43 2014
@@ -20,18 +20,20 @@ limitations under the License.
-->
<reference id="rrefattrib88843" xml:lang="en-us">
<title>encryptionProvider=providerName attribute</title>
+<shortdesc>The <i>encryptionProvider=providerName</i> attribute specifies the
+provider for data encryption.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>encryptionProvider=providerName attribute</indexterm><indexterm>data
-encryption<indexterm>providers attribute</indexterm></indexterm><indexterm>encryption<indexterm>providers
-attribute</indexterm></indexterm><indexterm>attributes<indexterm>encryptionProvider</indexterm></indexterm>
+<keywords><indexterm>encryptionProvider=providerName database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>provider attribute</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>encryptionProvider</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies the provider for data encryption.
-For information about data encryption, see "Configuring database encryption"
-in the <ph conref="../conrefs.dita#pub/citsec"></ph>. </p><p>If
-this attribute is not specified, the default encryption provider is the one
-included in the JVM that you are using.</p> </section>
+<section><p>For information about data encryption, see "Configuring database
+encryption" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
+<p>If this attribute is not specified, the default encryption provider is the
+one included in the JVM that you are using.</p></section>
<section><title>Combining with other attributes</title>
<p>The <i>encryptionProvider=providerName</i> attribute
must be combined with the
Modified: db/derby/docs/trunk/src/ref/rrefattribcollation.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribcollation.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribcollation.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribcollation.dita Wed Jun 18 18:14:43 2014
@@ -20,17 +20,18 @@ limitations under the License.
-->
<reference id="rrefattribcollation" xml:lang="en-us">
<title>collation=collation attribute</title>
+<shortdesc>The <i>collation=collation</i> attribute is an optional attribute
+that specifies whether collation is based on the locale specified for the
+database or on Unicode codepoint collation.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>collation<indexterm>database attribute</indexterm></indexterm>
-<indexterm>database attribute<indexterm>collation</indexterm></indexterm>
-<indexterm>TERRITORY_BASED <indexterm>collation attribute</indexterm></indexterm>
+<keywords><indexterm>collation=collation database connection URL attribute</indexterm>
+<indexterm>attributes<indexterm>collation</indexterm></indexterm>
+<indexterm>TERRITORY_BASED<indexterm>collation attribute</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>The <i>collation=collation</i> attribute
-is an optional attribute that specifies whether collation is based on the
-locale specified for the database or on Unicode codepoint collation. The valid
-values for the <i>collation=collation</i> attribute are:</p>
+<section><p>The valid values for the <i>collation=collation</i> attribute
+are:</p>
<dl>
<dlentry>
<dt>UCS_BASIC</dt>
@@ -98,7 +99,7 @@ attribute specifies
Spanish for the language code and Mexico for the country code. The
<i>collation=collation</i> attribute
specifies that the collation for the database is locale based.</p>
-<codeblock>jdbc:derby:MexicanDB;create=true;territory=es_MX;collation=TERRITORY_BASED </codeblock>
+<codeblock><b>jdbc:derby:MexicanDB;create=true;territory=es_MX;collation=TERRITORY_BASED</b></codeblock>
</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribdecryptdb.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribdecryptdb.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribdecryptdb.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribdecryptdb.dita Wed Jun 18 18:14:43 2014
@@ -20,18 +20,18 @@ limitations under the License.
-->
<reference id="rrefattribdecryptdb" xml:lang="en-us">
<title>decryptDatabase=true attribute</title>
+<shortdesc>The <i>decryptDatabase=true</i> attribute returns an encrypted
+database to an unencrypted state.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>decryptDatabase=true attribute</indexterm>
+<keywords><indexterm>decryptDatabase=true database connection URL attribute</indexterm>
<indexterm>encrypting databases<indexterm>database decryption</indexterm></indexterm>
-<indexterm>databases<indexterm>attributes, data decryption</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
<indexterm>attributes<indexterm>decryptDatabase</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Returns an encrypted database to an unencrypted state. For information about
-data encryption, see "Configuring database encryption" in the
-<ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
+<section><p>For information about data encryption, see "Configuring database
+encryption" in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
<p>You must shut down the database before you decrypt it. An attempt to decrypt
a booted database has no effect.</p>
<p>Specifying this attribute for an unencrypted database has no effect.</p>
@@ -58,8 +58,7 @@ decryption succeeded only if there were
jdbc:derby:encryptedDB;decryptDatabase=true;bootPassword=cLo4u922sc23aPe
<ph>-- decrypt a database with authentication and SQL authorization enabled</ph>
jdbc:derby:salesdb;decryptDatabase=true;user=user1;password=mypass;
- bootPassword=cLo4u922sc23aPe
-</b></codeblock>
+ bootPassword=cLo4u922sc23aPe</b></codeblock>
</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribderegister.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribderegister.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribderegister.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribderegister.dita Wed Jun 18 18:14:43 2014
@@ -20,20 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribderegister" xml:lang="en-us">
<title>deregister=false attribute</title>
+<shortdesc>The <i>deregister=false</i> attribute, if set to <i>true</i> (the
+default), deregisters the embedded JDBC driver from the <i>DriverManager</i>
+after a shutdown, so that the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> classes can be
+garbage-collected.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>deregister=false database connection URL
-attribute</indexterm>
+<keywords><indexterm>deregister=false database connection URL attribute</indexterm>
<indexterm>embedded driver<indexterm>deregistering</indexterm></indexterm>
<indexterm>driver<indexterm>deregistering embedded</indexterm></indexterm>
<indexterm>attributes<indexterm>deregister</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>If set to <i>true</i> (the default), deregisters the embedded
-JDBC driver from the <i>DriverManager</i> after a shutdown, so that the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> classes can be
-garbage-collected.</p>
+<section>
<p>If you are running with a security manager on JDK 8 or higher, you must grant
the following permission to <i>derby.jar</i> to allow the JDBC driver to be
deregistered:</p>
@@ -50,9 +50,9 @@ method such as <i>DriverManager.getDrive
<i>DriverManager.getConnection()</i>.</p>
<p>Once the embedded driver is registered, you can shut down the
<ph conref="../conrefs.dita#prod/productshortname"></ph> engine by using the
-<i><xref href="rrefattrib16471.dita#rrefattrib16471">shutdown=true</xref></i>
-connection URL attribute. If you also specify <i>deregister=false</i> with the
-shutdown URL, the following will happen:</p>
+<i><xref href="rrefattrib16471.dita">shutdown=true</xref></i> connection URL
+attribute. If you also specify <i>deregister=false</i> with the shutdown URL,
+the following will happen:</p>
<ul>
<li>The embedded driver will remain registered.</li>
<li>The <ph conref="../conrefs.dita#prod/productshortname"></ph> classes will
@@ -67,8 +67,8 @@ you shut down the database, the followin
<li>The <ph conref="../conrefs.dita#prod/productshortname"></ph> classes will be
garbage-collected.</li>
<li>You will have to call
-<i>Class.forName("org.apache.derby.jdbc.EmbeddedDriver").newInstance()</i> before
-you obtain a new <ph conref="../conrefs.dita#prod/productshortname"></ph>
+<i>Class.forName("org.apache.derby.jdbc.EmbeddedDriver").newInstance()</i>
+before you obtain a new <ph conref="../conrefs.dita#prod/productshortname"></ph>
connection by calling <i>DriverManager.getConnection()</i>.</li>
</ul>
<p>This attribute has no meaning if it is used with the network driver.</p>
@@ -77,12 +77,11 @@ connection by calling <i>DriverManager.g
<p>This attribute is valid only when issued in conjunction with the
<i>shutdown=true</i> attribute.</p>
</section>
-<example><title>Example</title>
+<example><title>Examples</title>
<codeblock><b>-- shut down salesDB and deregister the driver
jdbc:derby:salesDB;shutdown=true
-- shut down salesDB, but do not deregister the driver
-jdbc:derby:salesDB;shutdown=true;deregister=false
-</b></codeblock>
+jdbc:derby:salesDB;shutdown=true;deregister=false</b></codeblock>
</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribdrop.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribdrop.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribdrop.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribdrop.dita Wed Jun 18 18:14:43 2014
@@ -20,17 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribdrop" xml:lang="en-us">
<title>drop=true attribute</title>
+<shortdesc>The <i>drop=true</i> attribute removes the in-memory database
+specified within the database connection URL.</shortdesc>
<prolog><metadata>
<keywords><indexterm>drop=true database connection URL attribute</indexterm>
<indexterm>in-memory databases<indexterm>removing</indexterm></indexterm>
<indexterm>databases<indexterm>removing in-memory</indexterm></indexterm>
+<indexterm>attributes<indexterm>drop</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Removes the in-memory database specified within the database connection URL.
-Generates the <i>SQLException</i> 08006 if successful. If the database does not
-exist, generates an error reporting that the database could not be found.</p>
+<section>
+<p>The attribute generates the <i>SQLException</i> 08006 if successful. If the
+database does not exist, it generates an error reporting that the database could
+not be found.</p>
<p>For a database for which authentication and SQL authorization are both
enabled, only the
<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref>
Modified: db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribencryptkey.dita Wed Jun 18 18:14:43 2014
@@ -20,14 +20,17 @@ limitations under the License.
-->
<reference id="rrefattribencryptkey" xml:lang="en-us">
<title>encryptionKey=key attribute</title>
+<shortdesc>The <i>encryptionKey=key</i> attribute specifies an external
+encryption key.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>encryptionKey=key attribute</indexterm><indexterm>encrypting
-databases<indexterm>encryption key</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-encryption key</indexterm></indexterm><indexterm>attributes<indexterm>encryptionKey</indexterm></indexterm>
+<keywords><indexterm>encryptionKey=key database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>encryption key</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>encryptionKey</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies the external key to use to: <ul>
+<section><p>The attribute specifies the external key to use to:<ul>
<li>Encrypt a new database</li>
<li>Configure an existing unencrypted database for encryption</li>
<li>Boot an existing encrypted database</li>
@@ -37,35 +40,32 @@ contain an even number of digits.</p>
<p>For information about data encryption, see "Configuring database encryption"
in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
</section>
-<section><title>Combining with other attributes</title><p>When creating a
-new database, you must combine the <i>encryptionKey=key</i> attribute with the
-<i><xref href="rrefattrib26867.dita#rrefattrib26867">create=true</xref></i> and
-<i><xref href="rrefattrib15290.dita#rrefattrib15290">dataEncryption=true</xref></i>
-attributes. </p><p>When
-you configure an existing unencrypted database for encryption, the
-<i>encryptionKey=key</i> attribute
-must be combined with the <i>dataEncryption=true</i> attribute.
-For an existing, unencrypted database for which authentication
-and SQL authorization are both
-enabled, only the
-<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref>
-can perform encryption.
+<section><title>Combining with other attributes</title>
+<p>When creating a new database, you must combine the <i>encryptionKey=key</i>
+attribute with the <i><xref href="rrefattrib26867.dita">create=true</xref></i>
+and <i><xref href="rrefattrib15290.dita">dataEncryption=true</xref></i>
+attributes.</p>
+<p>When you configure an existing unencrypted database for encryption, the
+<i>encryptionKey=key</i> attribute must be combined with the
+<i>dataEncryption=true</i> attribute. For an existing, unencrypted database for
+which authentication and SQL authorization are both enabled, only the
+<xref href="rrefattrib26867.dita">database owner</xref> can perform encryption.
See "Configuring user authentication" and "Configuring user authorization"
-in the <ph conref="../conrefs.dita#pub/citsec"></ph>
-for more information.
-</p>
+in the <ph conref="../conrefs.dita#pub/citsec"></ph> for more information.</p>
<p>The <i>encryptionKey=key</i> attribute can optionally be combined with the
-<i><xref href="rrefattrib88843.dita#rrefattrib88843">encryptionProvider=providerName</xref></i>,
-<i><xref href="rrefattrib60346.dita#rrefattrib60346">encryptionAlgorithm=algorithm</xref></i>,
-and/or <i><xref href="rrefattribencryptkeylength.dita#rrefattribencryptkeylength">encryptionKeyLength=length</xref></i>
-attributes.</p></section>
-<example><title>Examples</title><p><b>Example of a JDBC URL that creates a
-new encrypted database:</b></p><codeblock>jdbc:derby:newDB;create=true;dataEncryption=true;
- encryptionKey=6162636465666768</codeblock><p><b>Example
-of a JDBC URL that configures an existing unencrypted database for encryption:</b>
-<codeblock>jdbc:derby:salesdb;dataEncryption=true;encryptionKey=6162636465666768
-</codeblock></p><p><b>Example of a JDBC URL that boots an encrypted database:</b>
-<codeblock>jdbc:derby:encryptedDB;encryptionKey=6162636465666768</codeblock
-></p> </example>
+<i><xref href="rrefattrib88843.dita">encryptionProvider=providerName</xref></i>,
+<i><xref href="rrefattrib60346.dita">encryptionAlgorithm=algorithm</xref></i>,
+and/or <i><xref href="rrefattribencryptkeylength.dita">encryptionKeyLength=length</xref></i>
+attributes.</p>
+</section>
+<example><title>Examples</title>
+<codeblock><b>-- create a new encrypted database
+jdbc:derby:newDB;create=true;dataEncryption=true;
+ encryptionKey=6162636465666768
+-- configure an existing unencrypted database for encryption
+jdbc:derby:salesdb;dataEncryption=true;encryptionKey=6162636465666768
+-- boot an encrypted database
+jdbc:derby:encryptedDB;encryptionKey=6162636465666768</b></codeblock>
+</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribencryptkeylength.dita Wed Jun 18 18:14:43 2014
@@ -20,19 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribencryptkeylength" xml:lang="en-us">
<title>encryptionKeyLength=length attribute</title>
+<shortdesc>The <i>encryptionKeyLength=length</i> attribute specifies the number
+of bits in the encryption key to be generated when a database is encrypted with
+the <i>bootPassword=key</i> attribute.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>encryptionKeyLength=length attribute</indexterm>
+<keywords><indexterm>encryptionKeyLength=length database connection URL attribute</indexterm>
<indexterm>encrypting databases<indexterm>encryption key length</indexterm></indexterm>
-<indexterm>databases<indexterm>attributes, encryption key length</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
<indexterm>attributes<indexterm>encryptionKeyLength</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies the number of bits in the encryption key to be generated when a
-database is encrypted with the
-<i><xref href="rrefattrib42100.dita#rrefattrib42100">bootPassword=key</xref></i>
-attribute.</p>
+<section>
+<p>See <xref href="rrefattrib42100.dita"><i>bootPassword=key</i>
+attribute</xref> for details.</p>
<p>The default encryption key length is 128.</p>
<p>You need to specify <i>encryptionKeyLength=length</i> only if all of
the following circumstances apply:
Modified: db/derby/docs/trunk/src/ref/rrefattribfailover.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribfailover.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribfailover.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribfailover.dita Wed Jun 18 18:14:43 2014
@@ -20,20 +20,17 @@ limitations under the License.
-->
<reference id="rrefattribfailover" xml:lang="en-us">
<title>failover=true attribute</title>
+<shortdesc>The <i>failover=true</i> attribute stops database replication on the
+slave system and converts the slave database into a normal database.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>failover=true database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>forcing
-failover</indexterm></indexterm><indexterm>database
-replication<indexterm>forcing failover</indexterm></indexterm>
-<indexterm>databases<indexterm>attributes, forcing
-failover</indexterm></indexterm>
+<keywords><indexterm>failover=true database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>forcing failover</indexterm></indexterm>
+<indexterm>database replication<indexterm>forcing failover</indexterm></indexterm>
<indexterm>attributes<indexterm>failover</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Stops database replication on the slave system and converts the slave
-database into a normal database.</p>
+<section>
<p>If you specify the <i>failover=true</i> attribute on the master, the
attribute sends the remaining log records to the slave instance and then sends a
failover message to the slave. The replication functionality and the database
Modified: db/derby/docs/trunk/src/ref/rrefattribnewbootpw.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribnewbootpw.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribnewbootpw.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribnewbootpw.dita Wed Jun 18 18:14:43 2014
@@ -20,19 +20,21 @@ limitations under the License.
-->
<reference id="rrefattribnewbootpw" xml:lang="en-us">
<title>newBootPassword=newPassword attribute</title>
+<shortdesc>The <i>newBootPassword=newPassword</i> attribute specifies a new boot
+password for an encrypted database.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>newBootPassword=newPassword attribute</indexterm><indexterm>encrypting
-databases<indexterm>new boot password</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-new boot password</indexterm></indexterm><indexterm>attributes<indexterm>newBootPassword</indexterm></indexterm>
+<keywords><indexterm>newBootPassword=newPassword database connection URL attribute</indexterm>
+<indexterm>encrypting databases<indexterm>new boot password</indexterm></indexterm>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>newBootPassword</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies a new boot password for an encrypted
-database. A new encryption key is generated internally by the engine and the
+<section><p>A new encryption key is generated internally by the engine, and the
key is protected using the new boot password. The newly generated encryption
key encrypts the database, including the existing data. For more information
about this attribute, see "Encrypting databases with a new boot password"
-in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p> </section>
+in the <ph conref="../conrefs.dita#pub/citsec"></ph>.</p></section>
<section><title>Combining with other attributes</title>
<p>The <i>newBootPassword=newPassword</i> attribute must be combined with the
<i><xref href="rrefattrib42100.dita#rrefattrib42100">bootPassword=key</xref></i>
Modified: db/derby/docs/trunk/src/ref/rrefattribnewencryptkey.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribnewencryptkey.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribnewencryptkey.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribnewencryptkey.dita Wed Jun 18 18:14:43 2014
@@ -20,18 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribnewencryptkey" xml:lang="en-us">
<title>newEncryptionKey=key attribute</title>
+<shortdesc>The <i>newEncryptionKey=key</i> attribute specifies a new external
+encryption key for an encrypted database.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>newEncryptionKey=key attribute</indexterm>
+<keywords><indexterm>newEncryptionKey=key database connection URL attribute</indexterm>
<indexterm>encrypting databases<indexterm>new encryption key</indexterm></indexterm>
-<indexterm>databases<indexterm>attributes, new encryption key</indexterm></indexterm>
-<indexterm>attributes<indexterm>newEncryptionKey</indexterm></indexterm></keywords>
+<indexterm>databases<indexterm>encryption attributes</indexterm></indexterm>
+<indexterm>attributes<indexterm>newEncryptionKey</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies a new external encryption key
-for an encrypted database. All of the existing data in the database is encrypted
-using the new encryption key and any new data written to the database will
-use this key for encryption. For more information about this attribute, see
-"Encrypting databases with a new external encryption key" in the
+<section><p>All of the existing data in the database is encrypted using the new
+encryption key, and any new data written to the database will use this key for
+encryption. For more information about this attribute, see "Encrypting databases
+with a new external encryption key" in the
<ph conref="../conrefs.dita#pub/citsec"></ph>.</p>
<p>The encryption key value must be a hexadecimal string at least 16 digits in
length (8 bytes), and it must contain an even number of digits.</p>
Modified: db/derby/docs/trunk/src/ref/rrefattribretrievemsgtext.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribretrievemsgtext.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribretrievemsgtext.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribretrievemsgtext.dita Wed Jun 18 18:14:43 2014
@@ -20,21 +20,22 @@ limitations under the License.
-->
<reference id="rrefattribretrievemsgtext" xml:lang="en-us">
<title>retrieveMessageText=false attribute</title>
+<shortdesc>The <i>retrieveMessageText=false</i> attribute, if set to <i>true</i>
+(the default), retrieves the message text for each <i>SQLException</i> from the
+server.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>retrieveMessageText=false database connection URL
-attribute</indexterm>
+<keywords><indexterm>retrieveMessageText=false database connection URL attribute</indexterm>
<indexterm>messages<indexterm>turning off</indexterm></indexterm>
<indexterm>exception messages<indexterm>turning off</indexterm></indexterm>
<indexterm>attributes<indexterm>retrieveMessageText</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>If set to <i>true</i> (the default), retrieves the message text for each
-<i>SQLException</i> from the server. A stored procedure call retrieves the
-message text and may start a new unit of work.</p>
-<p>Set this property to false if you do not want the performance impact of the
-procedure call or do not want to start a new unit of work.</p>
+<section>
+<p>A stored procedure call retrieves the message text and may start a new unit
+of work.</p>
+<p>Set this property to <i>false</i> if you do not want the performance impact
+of the procedure call or do not want to start a new unit of work.</p>
<p>This attribute is meaningful only if used with the network driver.</p>
</section>
<section><title>Combining with other attributes</title>
@@ -42,8 +43,7 @@ procedure call or do not want to start a
</section>
<example><title>Example</title>
<codeblock><b>-- do not retrieve message text for SQLExceptions
-jdbc:derby://localhost:1527/salesDB;retrieveMessageText=false
-</b></codeblock>
+jdbc:derby://localhost:1527/salesDB;retrieveMessageText=false</b></codeblock>
</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribsecmech.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribsecmech.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribsecmech.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribsecmech.dita Wed Jun 18 18:14:43 2014
@@ -20,14 +20,17 @@ limitations under the License.
-->
<reference id="rrefattribsecmech" xml:lang="en-us">
<title>securityMechanism=value attribute</title>
+<shortdesc>The <i>securityMechanism=value</i> attribute specifies a security
+mechanism for client access to the Network Server.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>securityMechanism=value attribute</indexterm>
-<indexterm>databases<indexterm>attributes, security mechanism</indexterm></indexterm>
-<indexterm>attributes<indexterm>securityMechanism</indexterm></indexterm></keywords>
+<keywords><indexterm>securityMechanism=value database connection URL attribute</indexterm>
+<indexterm>Network Server<indexterm>specifying security mechanism</indexterm></indexterm>
+<indexterm>attributes<indexterm>securityMechanism</indexterm></indexterm>
+</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title><p>Specifies a security mechanism
-for client access to the Network Server. The <i>value</i> is numeric.</p>
+<section>
+<p>The <i>value</i> is numeric.</p>
<p>Valid numeric values are:</p>
<!-- (Kim - March 2007) The values are out of numeric order because the last
two are defaults that users don't need to specify; they're present for
Modified: db/derby/docs/trunk/src/ref/rrefattribslavehost.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribslavehost.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribslavehost.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribslavehost.dita Wed Jun 18 18:14:43 2014
@@ -20,20 +20,17 @@ limitations under the License.
-->
<reference id="rrefattribslavehost" xml:lang="en-us">
<title>slaveHost=hostname attribute</title>
+<shortdesc>The <i>slaveHost=hostname</i> attribute specifies the system that will serve as the
+slave for database replication.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>slaveHost=hostname database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>specifying the
-slave host</indexterm></indexterm><indexterm>database
-replication<indexterm>specifying the slave
-host</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-specifying replication slave host</indexterm></indexterm>
+<keywords><indexterm>slaveHost=hostname database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>specifying the slave host</indexterm></indexterm>
+<indexterm>database replication<indexterm>specifying the slave host</indexterm></indexterm>
<indexterm>attributes<indexterm>slaveHost</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies the system that will serve as the slave for database replication.
-</p>
+<section>
<p>For more information, see the topics under "Replicating databases" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
</section>
Modified: db/derby/docs/trunk/src/ref/rrefattribslaveport.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribslaveport.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribslaveport.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribslaveport.dita Wed Jun 18 18:14:43 2014
@@ -20,20 +20,17 @@ limitations under the License.
-->
<reference id="rrefattribslaveport" xml:lang="en-us">
<title>slavePort=portValue attribute</title>
+<shortdesc>The <i>slavePort=portValue</i> attribute specifies the port that the
+slave system will use in database replication.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>slavePort=portValue database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>specifying the
-slave port</indexterm></indexterm><indexterm>database
-replication<indexterm>specifying the slave
-port</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-specifying replication slave port</indexterm></indexterm>
+<keywords><indexterm>slavePort=portValue database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>specifying the slave port</indexterm></indexterm>
+<indexterm>database replication<indexterm>specifying the slave port</indexterm></indexterm>
<indexterm>attributes<indexterm>slavePort</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies the port that the slave system will use in database replication.
-</p>
+<section>
<p>For more information, see the topics under "Replicating databases" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p>
</section>
Modified: db/derby/docs/trunk/src/ref/rrefattribssl.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribssl.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribssl.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribssl.dita Wed Jun 18 18:14:43 2014
@@ -20,22 +20,26 @@ limitations under the License.
"../dtd/reference.dtd">
<reference id="rrefattribssl" xml:lang="en-us">
<title>ssl=sslMode attribute</title>
+<shortdesc>The <i>ssl=sslMode</i> attribute specifies the SSL mode of the
+client.</shortdesc>
<prolog><metadata>
<keywords><indexterm>ssl=sslMode database connection URL attribute</indexterm>
+<indexterm>network client<indexterm>specifying SSL mode</indexterm></indexterm>
+<indexterm>attributes<indexterm>ssl</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section>
-<title>Function</title>
-<p>Specifies the SSL mode of the client. The
-<i>sslMode</i> can be <codeph>basic</codeph>,
+<section>
+<p>The <i>sslMode</i> can be <codeph>basic</codeph>,
<codeph>peerAuthentication</codeph>, or <codeph>off</codeph> (the default). See
"Configuring SSL/TLS" in the <ph conref="../conrefs.dita#pub/citsec"></ph> for
details.</p></section>
-
-<section><title>Combining with other attributes</title> <p>May be combined with all other attributes.</p> </section>
+<section><title>Combining with other attributes</title>
+<p>May be combined with all other attributes.</p>
+</section>
<example> <title>Example</title>
-<p>Connecting to <codeph>mydb</codeph> with basic SSL encryption:</p> <codeblock><b>jdbc:derby://localhost/mydb;ssl=basic</b></codeblock> </example>
+<codeblock><b>-- connect to mydb with basic SSL encryption
+jdbc:derby://localhost/mydb;ssl=basic</b></codeblock>
+</example>
</refbody>
</reference>
-
Modified: db/derby/docs/trunk/src/ref/rrefattribstartmaster.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribstartmaster.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribstartmaster.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribstartmaster.dita Wed Jun 18 18:14:43 2014
@@ -20,22 +20,21 @@ limitations under the License.
-->
<reference id="rrefattribstartmaster" xml:lang="en-us">
<title>startMaster=true attribute</title>
+<shortdesc>The <i>startMaster=true</i> attribute starts replication of a
+database in master mode.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>startMaster=true database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>starting the
-master</indexterm></indexterm><indexterm>database replication<indexterm>starting
-the master</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-starting the replication master</indexterm></indexterm>
+<keywords><indexterm>startMaster=true database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>starting the master</indexterm></indexterm>
+<indexterm>database replication<indexterm>starting the master</indexterm></indexterm>
<indexterm>attributes<indexterm>startMaster</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Starts replication of a database in master mode. Before you specify this
-attribute, you must cleanly shut down the database on the master system, perform a
-file system copy of the database to the slave system, and specify the
-<i><xref
-href="rrefattribstartslave.dita#rrefattribstartslave">startSlave=true</xref></i>
+<section>
+<p>Before you specify this attribute, you must cleanly shut down the database on
+the master system, perform a file system copy of the database to the slave
+system, and specify the
+<i><xref href="rrefattribstartslave.dita">startSlave=true</xref></i>
attribute. For details, see the topic "Starting and running replication" under
"Replicating databases" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>.
</p>
Modified: db/derby/docs/trunk/src/ref/rrefattribstartslave.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribstartslave.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribstartslave.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribstartslave.dita Wed Jun 18 18:14:43 2014
@@ -20,21 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribstartslave" xml:lang="en-us">
<title>startSlave=true attribute</title>
+<shortdesc>The <i>startSlave=true</i> attribute starts replication of a database
+in slave mode.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>startSlave=true database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>starting the
-slave</indexterm></indexterm><indexterm>database replication<indexterm>starting
-the slave</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-starting the replication slave</indexterm></indexterm>
+<keywords><indexterm>startSlave=true database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>starting the slave</indexterm></indexterm>
+<indexterm>database replication<indexterm>starting the slave</indexterm></indexterm>
<indexterm>attributes<indexterm>startSlave</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Starts replication of a database in slave mode. Before you specify this
-attribute, you must cleanly shut down the database on the master system and then
-perform a file system copy of the database to the slave system.
-</p>
+<section>
+<p>Before you specify this attribute, you must cleanly shut down the database on
+the master system and then perform a file system copy of the database to the
+slave system.</p>
<p>The <i>startSlave=true</i> attribute does the following:</p>
<ol>
<li>Partially boots the specified database</li>
Modified: db/derby/docs/trunk/src/ref/rrefattribstopmaster.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribstopmaster.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribstopmaster.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribstopmaster.dita Wed Jun 18 18:14:43 2014
@@ -20,21 +20,20 @@ limitations under the License.
-->
<reference id="rrefattribstopmaster" xml:lang="en-us">
<title>stopMaster=true attribute</title>
+<shortdesc>The <i>stopMaster=true</i> attribute stops database replication on
+the master system.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>stopMaster=true database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>stopping the
-master</indexterm></indexterm><indexterm>database replication<indexterm>stopping
-the master</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-stopping the replication master</indexterm></indexterm>
+<keywords><indexterm>stopMaster=true database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>stopping the master</indexterm></indexterm>
+<indexterm>database replication<indexterm>stopping the master</indexterm></indexterm>
<indexterm>attributes<indexterm>stopMaster</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Stops database replication on the master system. This attribute sends a
-stop-slave message to the slave system if the network connection is working.
-Then it shuts down all replication-related functionality, without shutting down
-the specified database.</p>
+<section>
+<p>This attribute sends a stop-slave message to the slave system if the network
+connection is working. Then it shuts down all replication-related functionality,
+without shutting down the specified database.</p>
<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> instance where
this attribute is specified must be the replication master for the specified
database.</p>
Modified: db/derby/docs/trunk/src/ref/rrefattribstopslave.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribstopslave.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribstopslave.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribstopslave.dita Wed Jun 18 18:14:43 2014
@@ -20,23 +20,21 @@ limitations under the License.
-->
<reference id="rrefattribstopslave" xml:lang="en-us">
<title>stopSlave=true attribute</title>
+<shortdesc>The <i>stopSlave=true</i> attribute stops database replication on the
+slave system.</shortdesc>
<prolog><metadata>
-<keywords><indexterm>stopSlave=true database connection URL
-attribute</indexterm><indexterm>replicating databases<indexterm>stopping the
-slave</indexterm></indexterm><indexterm>database replication<indexterm>stopping
-the slave</indexterm></indexterm><indexterm>databases<indexterm>attributes,
-stopping the replication slave</indexterm></indexterm>
+<keywords><indexterm>stopSlave=true database connection URL attribute</indexterm>
+<indexterm>replicating databases<indexterm>stopping the slave</indexterm></indexterm>
+<indexterm>database replication<indexterm>stopping the slave</indexterm></indexterm>
<indexterm>attributes<indexterm>stopSlave</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Stops database replication on the slave system.</p>
+<section>
<p>You can specify this connection URL attribute only if the network connection
between the master and slave systems is down. If the network connection is
working, the slave system accepts commands only from the master, so you must
-specify the <i><xref
-href="rrefattribstopmaster.dita#rrefattribstopmaster">stopMaster=true</xref></i>
+specify the <i><xref href="rrefattribstopmaster.dita">stopMaster=true</xref></i>
attribute on the master system to stop replication on both the master and slave
systems.</p>
<p>When this attribute is specified, or when a stop-slave message is sent as
Modified: db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribtracedirectory.dita Wed Jun 18 18:14:43 2014
@@ -3,21 +3,23 @@
"../dtd/reference.dtd">
<reference id="rrefattribtracedirectory" xml:lang="en-us">
<title>traceDirectory=path attribute</title>
-<prolog>
-<metadata><keywords>
+<shortdesc>The <i>traceDirectory=path</i> attribute specifies a directory to
+which the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
+Client will send JDBC trace information.</shortdesc>
+<prolog><metadata>
+<keywords>
<indexterm>traceDirectory=path database connection URL attribute</indexterm>
-</keywords></metadata>
-</prolog>
+<indexterm>network client<indexterm>tracing</indexterm></indexterm>
+<indexterm>attributes<indexterm>traceDirectory</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies a directory to which the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client will
-send JDBC trace information. If the program or session has multiple connections,
-the Network Client creates a separate file for each connection. By default, the
-files are named <codeph>_driver_0</codeph>, <codeph>_driver_1</codeph>, and so
-on. Use the
-<i><xref href="rrefattribtracefile.dita#rrefattribtracefile">traceFile=path</xref></i>
-attribute to specify a file name for the trace file.</p>
+<section>
+<p>If the program or session has multiple connections, the Network Client
+creates a separate file for each connection. By default, the files are named
+<codeph>_driver_0</codeph>, <codeph>_driver_1</codeph>, and so on. Use the
+<i><xref href="rrefattribtracefile.dita">traceFile=path</xref></i> attribute to
+specify a file name for the trace file.</p>
<p>If the directory does not exist,
<ph conref="../conrefs.dita#prod/productshortname"></ph> issues an error
message. If you do not specify an absolute path name, the directory is assumed
@@ -25,23 +27,23 @@ to be relative to the current directory.
<p>For more information about tracing, see "Network client tracing" in the
<ph conref="../conrefs.dita#pub/citadmin"></ph>. See
<i>traceFile=path</i>,
-<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
-and
-<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
-for other attributes related to tracing.
-</p>
+<i><xref href="rrefattribtracefileappend.dita">traceFileAppend=true</xref></i>,
+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>You can combine this attribute with other attributes.</p>
</section>
<example><title>Examples</title>
-<codeblock><b>-- enable tracing on an existing database that will have multiple connections
+<codeblock><b>-- enable tracing on an existing database that will have multiple
+-- connections
jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir
-- specify a trace file name within the directory
-jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir;traceFile=trace.out
+jdbc:derby://localhost:1527/mydb;
+ traceDirectory=/home/mydir/mydbtracedir;traceFile=trace.out
-- append to the default trace file
-jdbc:derby://localhost:1527/mydb;traceDirectory=/home/mydir/mydbtracedir;traceFileAppend=true
-</b></codeblock>
+jdbc:derby://localhost:1527/mydb;
+ traceDirectory=/home/mydir/mydbtracedir;traceFileAppend=true</b></codeblock>
</example>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/rrefattribtracefile.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattribtracefile.dita?rev=1603559&r1=1603558&r2=1603559&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattribtracefile.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattribtracefile.dita Wed Jun 18 18:14:43 2014
@@ -3,38 +3,38 @@
"../dtd/reference.dtd">
<reference id="rrefattribtracefile" xml:lang="en-us">
<title>traceFile=path attribute</title>
-<prolog>
-<metadata><keywords>
+<shortdesc>The <i>traceFile=path</i> attribute specifies a file to which the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client will
+send JDBC trace information.</shortdesc>
+<prolog><metadata>
+<keywords>
<indexterm>traceFile=path database connection URL attribute</indexterm>
-</keywords></metadata>
-</prolog>
+<indexterm>network client<indexterm>tracing</indexterm></indexterm>
+<indexterm>attributes<indexterm>traceFile</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
<refbody>
-<section><title>Function</title>
-<p>Specifies a file to which the
-<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Client will
-send JDBC trace information. If you do not specify an absolute path name, the
-file is placed in the <i>derby.system.home</i> directory (see "Defining the
-system directory" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph> for
-details).</p>
+<section>
+<p>If you do not specify an absolute path name, the file is placed in the
+<i>derby.system.home</i> directory (see "Defining the system directory" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph> for details).</p>
<p>If you specify both <i>traceFile=path</i> and
-<i><xref href="rrefattribtracefileappend.dita#rrefattribtracefileappend">traceFileAppend=true</xref></i>,
+<i><xref href="rrefattribtracefileappend.dita">traceFileAppend=true</xref></i>,
the output is appended to the specified file, if it exists. If you specify
-<i>traceFile=path</i> but do not specify <i>traceFileAppend=true</i>, any previous version of the file
-of the file is overwritten.</p>
+<i>traceFile=path</i> but do not specify <i>traceFileAppend=true</i>, any
+previous version of the file of the 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><xref href="rrefattribtracedirectory.dita#rrefattribtracedirectory">traceDirectory=path</xref></i>
-and
-<i><xref href="rrefattribtracelevel.dita#rrefattribtracelevel">traceLevel=value</xref></i>
-for other attributes related to tracing.</p>
+<i><xref href="rrefattribtracedirectory.dita">traceDirectory=path</xref></i> 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>You can combine this attribute with other attributes.</p>
</section>
<example><title>Example</title>
<codeblock><b>-- enable tracing on a new database
-jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out
-</b></codeblock>
+jdbc:derby://localhost:1527/mydb;create=true;traceFile=trace.out</b></codeblock>
</example>
</refbody>
</reference>