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/02/20 17:06:09 UTC
svn commit: r1570249 - in /db/derby/docs/branches/10.10/src:
devguide/cdevdvlp17453.dita devguide/cdevdvlp34964.dita
devguide/cdevdvlp51654.dita devguide/rdevdvlp22102.dita
ref/rrefjdbc27433.dita ref/rrefjdbc37352.dita
Author: chaase3
Date: Thu Feb 20 16:06:09 2014
New Revision: 1570249
URL: http://svn.apache.org/r1570249
Log:
DERBY-6473 Manuals are inconsistent in subsubprotocol information
Merged DERBY-6473.diff to 10.10 code branch from trunk revision 1570232.
Modified:
db/derby/docs/branches/10.10/src/devguide/cdevdvlp17453.dita
db/derby/docs/branches/10.10/src/devguide/cdevdvlp34964.dita
db/derby/docs/branches/10.10/src/devguide/cdevdvlp51654.dita
db/derby/docs/branches/10.10/src/devguide/rdevdvlp22102.dita
db/derby/docs/branches/10.10/src/ref/rrefjdbc27433.dita
db/derby/docs/branches/10.10/src/ref/rrefjdbc37352.dita
Modified: db/derby/docs/branches/10.10/src/devguide/cdevdvlp17453.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/devguide/cdevdvlp17453.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/devguide/cdevdvlp17453.dita (original)
+++ db/derby/docs/branches/10.10/src/devguide/cdevdvlp17453.dita Thu Feb 20 16:06:09 2014
@@ -28,54 +28,33 @@ to a database by obtaining a <i>Connecti
client/server versions</indexterm></indexterm></keywords>
</metadata></prolog>
<conbody>
-<p>The standard way to obtain a <codeph><i>Connection</i></codeph> object
-is to call the method <codeph><i>DriverManager.getConnection</i></codeph>,
-which takes a String containing a connection URL (uniform resource locator).
-A JDBC connection URL provides a way of identifying a database. It also allows
-you to perform a number of high-level tasks, such as creating a database or
-shutting down the system.</p>
+<p>The standard way to obtain a <i>Connection</i> object is to call the method
+<i>DriverManager.getConnection</i>, which takes a <i>String</i> containing a
+connection URL (uniform resource locator). A JDBC connection URL provides a way
+of identifying a database. It also allows you to perform a number of high-level
+tasks, such as creating a database or shutting down the system.</p>
+<p>The following example shows the use of the connection URL:</p>
+<codeblock>Connection conn = DriverManager.getConnection("jdbc:derby:sample");</codeblock>
<p>An application in an embedded environment uses a different connection URL
-from that used by applications using the <ph conref="../conrefs.dita#prod/productshortname"></ph> Network
-Server in a client/server environment. See the <cite><ph conref="../conrefs.dita#pub/citadmin"></ph></cite> for
-more information on the Network Server. </p>
+from that used by applications using the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Network Server in a
+client/server environment. See "Accessing the Network Server by using the
+network client driver" in the <ph conref="../conrefs.dita#pub/citadmin"></ph>
+for more information.</p>
<p>However, all versions of the connection URL (which you can use for tasks
besides connecting to a database) have common features:</p>
<ul>
-<li>you can specify the name of the database you want to connect to</li>
-<li>you can specify a number of attributes and values that allow you to accomplish
-tasks. For more information about what you can specify with the <ph conref="../conrefs.dita#prod/productshortname"></ph> connection
-URL, see <xref href="rdevdvlp22102.dita#rdevdvlp22102"></xref>.</li>
-</ul>
-<p>The connection URL syntax is as follows:</p>
-<codeblock>jdbc:derby:[subsubprotocol:][<i>databaseName</i>][;<i>attribute</i>=<i>value</i>]*</codeblock>
-<p><i>Subsubprotocol</i>, which is not typically specified, determines
-how <ph conref="../conrefs.dita#prod/productshortname"></ph> looks for a database:
-in a directory, in memory, in a class path, or in a jar file. <i>Subsubprotocol</i> is one of
-the following:</p>
-<ul>
-<li><i>directory</i>: The default, which need not be specified explicitly. The
-database is in the file system, and the path is either relative to the system
-directory or absolute.</li>
-<li><i>memory</i>: Databases exist only in main memory and are not written to
-disk. An in-memory database may be useful when there is no need to persist the
-database -- for example, in some testing situations.</li>
-<li><i>classpath</i>: Databases are treated as read-only databases, relative to
-the <i>classpath</i> directory. See
-<xref href="cdevdvlp91854.dita#cdevdvlp91854"></xref> for details.</li>
-<li><i>jar</i>: Databases are treated as read-only databases. <i>DatabaseNames</i> might
-require a leading slash, because you specify them "relative" to the jar file.
-See <xref href="cdevdvlp24155.dita#cdevdvlp24155"></xref> for details.
-<p><i>jar</i> requires an additional element immediately before the
-database name:</p>
-<codeblock>(<i>pathToArchive</i>)</codeblock>
-<p><i>pathToArchive</i> is the path to the jar or zip file that holds
-the database.</p></li>
+<li>You can specify the name of the database you want to connect to.</li>
+<li>You can specify a number of attributes and values that allow you to
+accomplish tasks.</li>
</ul>
-<p>For detailed reference about connection URL attributes and values, see
+<p>For more information about what you can specify with the
+<ph conref="../conrefs.dita#prod/productshortname"></ph> connection URL, see
+<xref href="cdevdvlp34964.dita#cdevdvlp34964"></xref>. For details on the
+connection URL syntax, see "Syntax of database connection URLs for applications
+with embedded databases" in the <ph conref="../conrefs.dita#pub/citref"></ph>.
+For detailed reference information on connection URL attributes and values, see
"Setting attributes for the database connection URL" in the
-<ph conref="../conrefs.dita#pub/citref"></ph>.
-</p>
-<p>The following example shows the use of the connection URL:</p>
-<codeblock>Connection conn = DriverManager.getConnection("jdbc:derby:sample");</codeblock>
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.10/src/devguide/cdevdvlp34964.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/devguide/cdevdvlp34964.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/devguide/cdevdvlp34964.dita (original)
+++ db/derby/docs/branches/10.10/src/devguide/cdevdvlp34964.dita Thu Feb 20 16:06:09 2014
@@ -24,6 +24,9 @@ limitations under the License.
URL as an argument to the <i>DriverManager.getConnection</i> call.</shortdesc>
<prolog></prolog>
<conbody>
+<p>For details on the syntax of the connection URL, see "Syntax of database
+connection URLs for applications with embedded databases" in the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
<p>You specify a path to the database within this connection URL.</p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.10/src/devguide/cdevdvlp51654.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/devguide/cdevdvlp51654.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/devguide/cdevdvlp51654.dita (original)
+++ db/derby/docs/branches/10.10/src/devguide/cdevdvlp51654.dita Thu Feb 20 16:06:09 2014
@@ -52,6 +52,7 @@ logging on separate devices</li>
the database connection URL" in the
<ph conref="../conrefs.dita#pub/citref"></ph>.</p>
<p>For detailed information about the connection URL syntax,
-see <xref href="cdevdvlp17453.dita#cdevdvlp17453"></xref>.</p>
+see "Syntax of database connection URLs for applications with embedded
+databases" in the <ph conref="../conrefs.dita#pub/citref"></ph>.</p>
</conbody>
</concept>
Modified: db/derby/docs/branches/10.10/src/devguide/rdevdvlp22102.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/devguide/rdevdvlp22102.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/devguide/rdevdvlp22102.dita (original)
+++ db/derby/docs/branches/10.10/src/devguide/rdevdvlp22102.dita Thu Feb 20 16:06:09 2014
@@ -27,9 +27,11 @@ for use in an embedded environment.</sho
</keywords>
</metadata></prolog>
<refbody>
-<section><p>This information also applies to the client connection URL in
-a client/server environment. For reference information about client connection
-URLs, see "java.sql.Connection interface" in the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>.</p></section>
+<section><p>For reference information about connection URLs, see "Syntax of
+database connection URLs for applications with embedded databases" in the
+<ph conref="../conrefs.dita#pub/citref"></ph> or "Accessing the Network Server
+by using the network client driver" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>.</p></section>
<section> <ul>
<li><i>jdbc:derby:db1</i> <p>Open a connection to the database <i>db1</i>. <i>db1</i> is
a directory located in the system directory.</p></li>
Modified: db/derby/docs/branches/10.10/src/ref/rrefjdbc27433.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefjdbc27433.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefjdbc27433.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefjdbc27433.dita Thu Feb 20 16:06:09 2014
@@ -19,18 +19,22 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<reference id="rrefjdbc27433" xml:lang="en-us">
-<title>Derby database connection
-URL syntax</title>
+<title><ph conref="../conrefs.dita#prod/productshortname"></ph> database
+connection URL syntax</title>
<prolog><metadata>
-<keywords><indexterm>Database connection URL</indexterm></keywords>
+<keywords><indexterm>database connection URL</indexterm></keywords>
</metadata></prolog>
<refbody>
<section><p>A <ph conref="../conrefs.dita#prod/productshortname"></ph> database
connection URL consists of the basic database connection URL followed by an
optional subsubprotocol and optional attributes.</p></section>
-<section><p>This section provides reference information only. For a more complete
-description, including examples, see "Connecting to Databases" in Chapter
-1 of the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p></section>
+<section><p>The following section provides reference information on the
+connection URL syntax for applications with embedded databases. For information
+on the connection URL syntax for accessing the Network Server, see "Accessing
+the Network Server by using the network client driver" in the
+<ph conref="../conrefs.dita#pub/citadmin"></ph>. For more conceptual
+information, including examples, see "Connecting to databases" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p></section>
</refbody>
</reference>
Modified: db/derby/docs/branches/10.10/src/ref/rrefjdbc37352.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefjdbc37352.dita?rev=1570249&r1=1570248&r2=1570249&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefjdbc37352.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefjdbc37352.dita Thu Feb 20 16:06:09 2014
@@ -19,43 +19,67 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<reference id="rrefjdbc37352" xml:lang="en-us">
-<title>Syntax of database connection URLs for applications with embedded databases </title>
+<title>Syntax of database connection URLs for applications with embedded
+databases</title>
<prolog><metadata>
-<keywords><indexterm>Database connection URL<indexterm>syntax in embedded
-mode</indexterm></indexterm></keywords>
+<keywords><indexterm>database connection URL<indexterm>syntax in embedded
+mode</indexterm></indexterm>
+<indexterm>subsubprotocol<indexterm>part of database connection URL
+syntax</indexterm></indexterm>
+<indexterm>classpath<indexterm>accessing read-only databases
+from</indexterm></indexterm></keywords>
</metadata></prolog>
<refbody>
<section><p>For applications with embedded databases, the syntax of the database
-connection URL is <codeblock><b>jdbc:derby: [<b><i>subsubprotocol:</i></b>][<i>databasename</i>][;<b><i>attributes</i></b>]*</b></codeblock><ul
-id="i1025762">
-<li><i id="jdbc31337">jdbc:derby:</i> <p>In JDBC lingo, <i>derby</i> is
-the <i>subprotocol</i> for connecting to a <ph conref="../conrefs.dita#prod/productshortname"></ph> database.
-The subprotocol is always <i>derby</i> and does not vary.</p></li>
-<li><i>subsubprotocol:<ph><indexterm>Subsubprotocol<indexterm>part of database
-connection URL syntax</indexterm></indexterm></ph></i> <p><i>subsubprotocol</i>,
-which is not typically specified, specifies where <ph conref="../conrefs.dita#prod/productshortname"></ph> looks
-for a database: in a directory, in a classpath, or in a jar file. It is used
-only in rare instances, usually for read-only databases. <i>subsubprotocol</i> is
-one of the following:</p><ul>
-<li>directory</li>
-<li>classpath: <indexterm>Classpath<indexterm>accessing read-only databases
-from</indexterm></indexterm>Databases are treated as read-only databases,
-and all <i>databaseNames</i> must begin with at least a slash, because you
-specify them "relative" to the classpath directory or archive. (You do not
-have to specify classpath as the subsubprotocol; it is implied.)</li>
-<li>jar Databases are treated as read-only databases.</li>
-</ul><p>jar: requires an additional element immediately before the <i>databaseName</i>:
- <codeblock><b><i>(<i>pathToArchive</i>)</i></b></codeblock></p><p><i>pathToArchive</i> is
-the path to the jar or zip file that holds the database and includes the name
-of the jar or zip file.</p><p>See the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite> for
-examples of database connection URLs for read-only databases.</p></li>
-<li><i>databaseName</i> <p>Specify the <i>databaseName</i> to connect to
-an existing database or a new one. </p> <p>You can specify the database name
-alone, or with a relative or absolute path. See "Standard Connections-Connecting
-to Databases in the File System" in Chapter 1 of the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p></li>
-<li><i>attributes</i> <p>Specify 0 or more database connection URL attributes
-as detailed in <xref href="rrefjdbc10889.dita#rrefjdbc10889"></xref>.</p></li>
-</ul></p></section>
+connection URL is</p>
+<codeblock><b>jdbc:derby:[<b><i>subsubprotocol:</i></b>][<i>databasename</i>][;<b><i>attributes</i></b>]*</b></codeblock>
+<ul>
+<li><codeph>jdbc:derby:</codeph>
+<p>In JDBC terminology, <codeph>derby</codeph> is the <i>subprotocol</i> for
+connecting to a <ph conref="../conrefs.dita#prod/productshortname"></ph>
+database. The subprotocol is always <codeph>derby</codeph> and does not vary.</p></li>
+<li><i>subsubprotocol:</i>
+<p><i>subsubprotocol</i> specifies where
+<ph conref="../conrefs.dita#prod/productshortname"></ph> looks for a database:
+in a directory, in memory, in a classpath, or in a jar file.
+<i>subsubprotocol</i> is one of the following:</p>
+<ul>
+<li><i>directory</i>: The default, which need not be specified explicitly. The
+database is in the file system, and the path is either relative to the system
+directory or absolute.</li>
+<li><codeph>memory</codeph>: Databases exist only in main memory and are not
+written to disk. An in-memory database may be useful when there is no need to
+persist the database -- for example, in some testing situations. See "Using
+in-memory databases" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>
+for more information.</li>
+<li><codeph>classpath</codeph>: Databases are treated as read-only databases,
+relative to the <codeph>classpath</codeph> directory. All <i>databaseNames</i>
+must begin with at least a slash, because you specify them "relative" to the
+classpath directory or archive. (You do not have to specify
+<codeph>classpath</codeph> as the subsubprotocol; it is implied.) See
+"Accessing databases from the classpath" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph> for more information.</li>
+<li><codeph>jar</codeph>: Databases are treated as read-only databases.
+<i>DatabaseNames</i> might require a leading slash, because you specify them
+"relative" to the jar file. See "Accessing databases from a jar or zip file" in
+the <ph conref="../conrefs.dita#pub/citdevelop"></ph> for details.
+<p><codeph>jar</codeph> requires an additional element immediately before the
+database name:</p>
+<codeblock>(<i>pathToArchive</i>)</codeblock>
+<p><i>pathToArchive</i> is the path to the jar or zip file that holds
+the database.</p></li>
+</ul>
+</li>
+<li><i>databaseName</i>
+<p>Specify the <i>databaseName</i> to connect to an existing database or a new
+one.</p>
+<p>You can specify the database name alone, or with a relative or absolute path.
+See "Connecting to databases" and its subsections in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p></li>
+<li><i>attributes</i>
+<p>Specify zero or more database connection URL attributes as detailed in
+<xref href="rrefjdbc10889.dita#rrefjdbc10889"></xref>.</p></li>
+</ul>
+</section>
</refbody>
</reference>
-