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/03/13 16:22:33 UTC
svn commit: r1577193 - in /db/derby/docs/trunk/src: adminguide/ devguide/
ref/ tools/
Author: chaase3
Date: Thu Mar 13 15:22:32 2014
New Revision: 1577193
URL: http://svn.apache.org/r1577193
Log:
DERBY-6462 Provide more information about database name and path syntax
Modified 5 Developer's Guide topics, 2 Reference Manual topics and the map file, 2 Tools Guide topics, and 1 Admin Guide topic.
Patch: DERBY-6462-3.diff
Modified:
db/derby/docs/trunk/src/adminguide/cadminappsclient.dita
db/derby/docs/trunk/src/devguide/cdevdvlp40350.dita
db/derby/docs/trunk/src/devguide/rdevcsecure871406.dita
db/derby/docs/trunk/src/devguide/rdevcsecure871422.dita
db/derby/docs/trunk/src/devguide/rdevcsecure871439.dita
db/derby/docs/trunk/src/devguide/rdevdvlp847152.dita
db/derby/docs/trunk/src/ref/refderby.ditamap
db/derby/docs/trunk/src/ref/rrefattrib17246.dita
db/derby/docs/trunk/src/ref/rrefjdbc37352.dita
db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
db/derby/docs/trunk/src/tools/rtoolsijpropref28146.dita
Modified: db/derby/docs/trunk/src/adminguide/cadminappsclient.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/adminguide/cadminappsclient.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/adminguide/cadminappsclient.dita (original)
+++ db/derby/docs/trunk/src/adminguide/cadminappsclient.dita Thu Mar 13 15:22:32 2014
@@ -34,7 +34,13 @@ authentication.</shortdesc>
<i>databaseName</i>[;<i>URL-attribute</i>=<i>value</i> [;...]]</codeblock>
where the <codeph><i>URL-attribute</i></codeph> is either a <ph
conref="../conrefs.dita#prod/productshortname"></ph> embedded or network
-client attribute.</p>
+client attribute. Neither the database name nor the name of a directory in the
+database path can contain a colon (<codeph>:</codeph>), although the colon after
+the drive name in a Windows path is allowed. The path separator in the
+connection URL is a forward slash (<codeph>/</codeph>).</p>
+<p>For complete information about the connection URL, see the
+<ph conref="../conrefs.dita#pub/citref"></ph> and the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
<p>When you access the Network Server using a connection URL, the network
client driver is loaded automatically.</p>
<p>To access an in-memory database using the Network Server, the syntax is:</p>
Modified: db/derby/docs/trunk/src/devguide/cdevdvlp40350.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/cdevdvlp40350.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/cdevdvlp40350.dita (original)
+++ db/derby/docs/trunk/src/devguide/cdevdvlp40350.dita Thu Mar 13 15:22:32 2014
@@ -31,11 +31,14 @@ path when outside system</indexterm></in
<conbody>
<p>The path must do one of the following:</p>
<ul>
-<li>refer to a previously created <ph conref="../conrefs.dita#prod/productshortname"></ph> database</li>
-<li>specify the <i>create=true</i> attribute</li>
+<li>Refer to a previously created
+<ph conref="../conrefs.dita#prod/productshortname"></ph> database</li>
+<li>Specify the <i>create=true</i> attribute</li>
</ul>
-<p>The path separator in the connection URL is / (forward slash), as in the
-standard <i>file:// </i>URL protocol.</p>
+<p>Neither the database name nor the name of a directory in the database path
+can contain a colon (<codeph>:</codeph>), although the colon after the drive
+name in a Windows path is allowed. The path separator in the connection URL is
+a forward slash (<codeph>/</codeph>).</p>
<p>You can specify only databases that are local to the machine on which the
JVM is running. NFS file systems on UNIX and remote shared files on Windows
(//<i>machine/directory</i>) are not guaranteed to work. Using <i>derby.system.home</i> and
Modified: db/derby/docs/trunk/src/devguide/rdevcsecure871406.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevcsecure871406.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevcsecure871406.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevcsecure871406.dita Thu Mar 13 15:22:32 2014
@@ -30,7 +30,7 @@ system home when it is specified by the
<example>
<codeblock><b>/* Note derby.system.home must be an absolute pathname */</b>
-grant codeBase "file://f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
+grant codeBase "file:/f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
permission java.lang.RuntimePermission "createClassLoader";
permission java.util.PropertyPermission "derby.*", "read";
Modified: db/derby/docs/trunk/src/devguide/rdevcsecure871422.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevcsecure871422.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevcsecure871422.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevcsecure871422.dita Thu Mar 13 15:22:32 2014
@@ -27,7 +27,7 @@ system home when it defaults to the curr
<prolog></prolog>
<refbody>
<example>
-<codeblock>grant codeBase "file://f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
+<codeblock>grant codeBase "file:/f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
permission java.lang.RuntimePermission "createClassLoader";
permission java.util.PropertyPermission "derby.*", "read";
permission java.util.PropertyPermission "user.dir", "read";
Modified: db/derby/docs/trunk/src/devguide/rdevcsecure871439.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevcsecure871439.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevcsecure871439.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevcsecure871439.dita Thu Mar 13 15:22:32 2014
@@ -30,7 +30,7 @@ home.</shortdesc>
<example>
<codeblock><b>/* Note derby.system.home must be an absolute pathname */</b>
-grant codeBase "file://f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
+grant codeBase "file:/f:/<ph conref="../conrefs.dita#prod/productlowercase"></ph>/lib/derby.jar" {
permission java.lang.RuntimePermission "createClassLoader";
permission java.util.PropertyPermission "derby.*", "read";
Modified: db/derby/docs/trunk/src/devguide/rdevdvlp847152.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/devguide/rdevdvlp847152.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/devguide/rdevdvlp847152.dita (original)
+++ db/derby/docs/trunk/src/devguide/rdevdvlp847152.dita Thu Mar 13 15:22:32 2014
@@ -20,8 +20,9 @@ limitations under the License.
-->
<reference id="rdevdvlp847152" xml:lang="en-us">
<title>Using the databaseName attribute</title>
-<shortdesc>You can use a databaseName attribute on a database connection URL
-to specify the name of the database to which you want to connect.</shortdesc>
+<shortdesc>You can use a <codeph>databaseName</codeph> attribute on a database
+connection URL to specify the name of the database to which you want to
+connect.</shortdesc>
<prolog><metadata>
<keywords><indexterm>Database name attribute<indexterm>use of in database
connection URL</indexterm></indexterm><indexterm>Read-only databases<indexterm>accessing</indexterm></indexterm>
@@ -36,5 +37,11 @@ the subsubprotocol, like this:</p></sect
<section><p>Or, if the jar or zip file has been included in the classpath,
like this:</p></section>
<example> <codeblock>jdbc:derby:classpath:<i>databasePathWithinArchive</i></codeblock></example>
+<section>
+<p>Neither the database name nor the name of a directory in the database path
+can contain a colon (<codeph>:</codeph>), although the colon after the drive
+name in a Windows path is allowed. The path separator in the connection URL is a
+forward slash (<codeph>/</codeph>).</p>
+</section>
</refbody>
</reference>
Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Mar 13 15:22:32 2014
@@ -1129,7 +1129,7 @@ URL syntax"></topicref>
<topicref href="rrefattrib26867.dita" navtitle="create=true attribute"></topicref>
<topicref href="rrefcreatefrom.dita" navtitle="createFrom=path attribute">
</topicref>
-<topicref href="rrefattrib17246.dita" navtitle="databaseName=nameofDatabase attribute">
+<topicref href="rrefattrib17246.dita" navtitle="databaseName=nameOfDatabase attribute">
</topicref>
<topicref href="rrefattrib15290.dita" navtitle="dataEncryption=true attribute">
</topicref>
Modified: db/derby/docs/trunk/src/ref/rrefattrib17246.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefattrib17246.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefattrib17246.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefattrib17246.dita Thu Mar 13 15:22:32 2014
@@ -19,7 +19,7 @@ limitations under the License.
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
"../dtd/reference.dtd">
<reference id="rrefattrib17246" xml:lang="en-us">
-<title>databaseName=nameofDatabase attribute</title>
+<title>databaseName=nameOfDatabase attribute</title>
<prolog><metadata>
<keywords><indexterm>databaseName=nameOfDatabase database connection URL
attribute</indexterm>
@@ -27,7 +27,12 @@ attribute</indexterm>
</keywords></metadata></prolog>
<refbody>
<section><title>Function</title> <p>Specifies a database name for a connection;
-it can be used instead of specifying the database name after the subprotocol.</p> <p>For example, these
+it can be used instead of specifying the database name after the subprotocol.</p>
+<p>Neither the database name nor the name of a directory in the database path
+can contain a colon (<codeph>:</codeph>), although the colon after the drive
+name in a Windows path is allowed. The path separator in the connection URL is
+a forward slash (<codeph>/</codeph>).</p>
+<p>For example, these
URL (and Properties object) combinations are equivalent: <ul>
<li><i>jdbc:derby:toursDB</i></li>
<li><i>jdbc:derby:;databaseName=toursDB</i></li>
Modified: db/derby/docs/trunk/src/ref/rrefjdbc37352.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefjdbc37352.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefjdbc37352.dita (original)
+++ db/derby/docs/trunk/src/ref/rrefjdbc37352.dita Thu Mar 13 15:22:32 2014
@@ -75,7 +75,11 @@ the database.</p></li>
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>
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>. Neither the database name nor
+the name of a directory in the database path can contain a colon
+(<codeph>:</codeph>), although the colon after the drive name in a Windows path
+is allowed. The path separator in the connection URL is a forward slash
+(<codeph>/</codeph>).</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>
Modified: db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita (original)
+++ db/derby/docs/trunk/src/tools/ctoolsijtools16011.dita Thu Mar 13 15:22:32 2014
@@ -28,9 +28,10 @@ driver recognizes it and connects to it.
a JDBC URL is referred to as a database connection URL.</p>
<p>After the driver is loaded, an application must specify the correct database
connection URL to connect to a specific database. The <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-connection URL allows you to accomplish tasks other than simply connecting.
-For more information about the <ph conref="../conrefs.dita#prod/productshortname"></ph> database
-connection URLs, see the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p>
+connection URL allows you to accomplish tasks other than simply connecting.</p>
+<p>For complete information about the database connection URL, see
+the <ph conref="../conrefs.dita#pub/citref"></ph> and the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
<p>A JDBC URL always starts with <i>jdbc:</i>. After that, the format for
the database connection URL depends on the JDBC driver. </p>
<p>Here is the format for the database connection URL for connecting to an
@@ -46,7 +47,10 @@ Network Client is: <ul>
<p>The italicized items stand for something the user fills in: <ul>
<li><i id="rtoolsijtools16246">databaseName</i> <p>The name of the database
you want to connect to. This might also include the file system path to the
-database.</p></li>
+database. Neither the database name nor the name of a directory in the database
+path can contain a colon (<codeph>:</codeph>), although the colon after the
+drive name in a Windows path is allowed. The path separator in the connection
+URL is a forward slash (<codeph>/</codeph>).</p></li>
<li><i id="rtoolsijtools12861">URLAttributes</i> <p>One or more of the supported
attributes of the database connection URL, such as <i>upgrade=true</i>, <i>create=true</i> or <i>territory=ll_CC</i>.
For more information, see "Setting attributes for the database connection URL"
@@ -63,7 +67,5 @@ of the database connection URL (everythi
which is called the subprotocol, is informally considered part of the protocol.
Later in this book you might see references to protocol. Consider protocol
to be everything that comes before <i>databaseName</i>.</p></section>
-<section><p>For complete information about the database connection URL, see
-the <cite><ph conref="../conrefs.dita#pub/citdevelop"></ph></cite>.</p></section>
</conbody>
</concept>
Modified: db/derby/docs/trunk/src/tools/rtoolsijpropref28146.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/tools/rtoolsijpropref28146.dita?rev=1577193&r1=1577192&r2=1577193&view=diff
==============================================================================
--- db/derby/docs/trunk/src/tools/rtoolsijpropref28146.dita (original)
+++ db/derby/docs/trunk/src/tools/rtoolsijpropref28146.dita Thu Mar 13 15:22:32 2014
@@ -24,15 +24,20 @@ limitations under the License.
</metadata></prolog>
<refbody>
<section><title>Function</title> <p>Creates a connection to the database name
-listed indicated by the property when <codeph>ij</codeph> starts up. You can
-specify the complete connection URL (including protocol) with this property
-or just the database name if you also specify <i>ij.protocol</i> on the command
-line. After it boots, <codeph>ij</codeph> displays the generated name of the
-connection made with this property.</p> </section>
-<refsyn><title>Syntax</title> <codeblock><b>ij.database=<b><i>databaseConnectionURL</i></b></b></codeblock> <p>When
-specified on the command line the <i>databaseConnectionURL</i> should not
-be enclosed in single quotations, however, if the database path contains special
-characters (e.g. a space) it must be enclosed in double quotes.</p> </refsyn>
+specified by the property when <codeph>ij</codeph> starts up. You can
+specify the complete connection URL (including protocol) with this property, or
+you can specify just the database name if you also specify <i>ij.protocol</i>
+on the command line. After it boots, <codeph>ij</codeph> displays the generated
+name of the connection made with this property.</p> </section>
+<refsyn><title>Syntax</title> <codeblock><b>ij.database=<b><i>databaseConnectionURL</i></b></b></codeblock>
+<p>Neither the database name nor the name of a directory in the database path
+can contain a colon (<codeph>:</codeph>), although the colon after the drive
+name in a Windows path is allowed. The path separator in the connection URL is
+a forward slash (<codeph>/</codeph>).</p>
+<p>When specified on the command line, the <i>databaseConnectionURL</i> should
+not be enclosed in single quotes. However, if the database path contains special
+characters (such as a space), it must be enclosed in double quotes.</p>
+</refsyn>
<example><title>Example</title> <codeblock><b>java -Dij.protocol=jdbc:derby:
-Dij.database=wombat;create=true org.apache.derby.tools.ij</b>
ij version <ph conref="../conrefs.dita#vers/shortversionnumber"></ph>