db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r756616 - in /db/derby/docs/branches/10.5/src: devguide/ ref/ tuning/
Date Fri, 20 Mar 2009 16:51:40 GMT
Author: chaase3
Date: Fri Mar 20 16:51:39 2009
New Revision: 756616

URL: http://svn.apache.org/viewvc?rev=756616&view=rev
Log:
DERBY-2389: DOCS - Move Derby system and properties info from Tuning Guide into 
Reference Manual

Merged DERBY-2389-phase3-2.diff to 10.5 docs branch from trunk revision 756574.

Modified:
    db/derby/docs/branches/10.5/src/devguide/cdevdvlp846110.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop11561.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop12821.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop13074.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop24843.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop32443.dita
    db/derby/docs/branches/10.5/src/devguide/cdevsetprop824451.dita
    db/derby/docs/branches/10.5/src/ref/crefproper51399.dita
    db/derby/docs/branches/10.5/src/ref/rrefgetdbpropfunc.dita
    db/derby/docs/branches/10.5/src/ref/rrefsetdbpropproc.dita
    db/derby/docs/branches/10.5/src/ref/rrefsqlj31783.dita
    db/derby/docs/branches/10.5/src/tuning/ctunpropref11181.dita

Modified: db/derby/docs/branches/10.5/src/devguide/cdevdvlp846110.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevdvlp846110.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevdvlp846110.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevdvlp846110.dita Fri Mar 20 16:51:39 2009
@@ -31,6 +31,5 @@
 <p>For more information, see
 <xref href="cdevsetprop824451.dita#cdevsetprop824451"></xref> and 
 <xref href="cdevsetprop12821.dita#cdevsetprop12821"></xref>.</p>
-<note>You should work with database-level properties wherever possible.</note>
 </conbody>
 </concept>

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop11561.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop11561.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop11561.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop11561.dita Fri Mar 20 16:51:39 2009
@@ -50,16 +50,10 @@
 <section id="comparam"><title>As a parameter to the JVM command line</title>
 <p>You can set system-wide properties as parameters to the JVM command line when
 you start up the application or framework in which
-<ph conref="../conrefs.dita#prod/productshortname"></ph> is embedded.</p>
-<ul>
-<li><i>IBM Application Developer Kits</i>
-<p>With the IBM® SDK, you set JVM system properties by using a <i>-D</i>
flag
-on the Java command line. For example:</p>
+<ph conref="../conrefs.dita#prod/productshortname"></ph> is embedded. To do so,
+you typically use the <i>-D</i> option. For example:</p>
 <codeblock><b>java -Dderby.system.home=C:\home\<ph conref="../conrefs.dita#prod/productshortname"></ph>\

-    -Dderby.storage.pageSize=8192 JDBCTest</b></codeblock></li>
-</ul>
-<p>For other JVMs, see the JVM-specific documentation on setting system
-properties.</p>
+    -Dderby.storage.pageSize=8192 JDBCTest</b></codeblock>
 </section>
 <section id="propobj">
 <title>Using a Properties object within an application or statement</title>
@@ -69,13 +63,13 @@
 loading the <ph conref="../conrefs.dita#prod/productshortname"></ph> JDBC
 driver. The following example sets <i>derby.system.home</i> on Windows.</p>
 <codeblock><b>Properties p = System.getProperties();
-p.put("derby.system.home", "C:\databases\sample");</b></codeblock>
+p.setProperty("derby.system.home", "C:\databases\sample");</b></codeblock>
 <note>If you pass in a <i>Properties</i> object as an argument to the
 <i>DriverManager.getConnection</i> call when connecting to a database, those
 properties are used as database connection URL attributes, not as properties of
-the type discussed in this book. For more information, see
-"java.sql.DriverManager.getConnection method" and "Setting attributes for the
-database connection URL" in the <ph conref="../conrefs.dita#pub/citref"></ph>.
-</note>
+the type discussed in this section. For more information, see
+<xref href="cdevdvlp34964.dita#cdevdvlp34964"></xref> and
+<xref href="cdevdvlp51654.dita#cdevdvlp51654"></xref> as well as the
+<ph conref="../conrefs.dita#pub/citref"></ph>.</note>
 </section>
 </conbody></concept>

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop12821.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop12821.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop12821.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop12821.dita Fri Mar 20 16:51:39 2009
@@ -32,9 +32,9 @@
 <p>Database-wide properties, which affect a single database, are stored within
 the database itself. This allows different databases within a single <ph conref="../conrefs.dita#prod/productshortname"></ph>
system
 to have different properties and ensures that the properties are correctly
-set when a database is moved away from its original system or copied.  
-<note>You should use database-wide properties wherever possible for ease
-of deployment.</note></p>
+retained when a database is moved away from its original system or copied.</p>
+<p>You should use database-wide properties wherever possible for ease
+of deployment and for security.</p>
 <p>You set and verify database-wide properties using system procedures within SQL statements.</p>
 <p>To set a property, you connect to the database, create a statement, and
 then use the <codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph> procedure,
@@ -42,7 +42,9 @@
 <p>To check the current value of a property, you connect to the database,
 create a statement, and then use the <codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph>
function, passing in the name of the property.  </p>
 <p>If you specify an invalid value, <ph conref="../conrefs.dita#prod/productshortname"></ph>
uses the default value for
-the property.</p>
+the property. (If you call the
+<codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph> function, however, it
+displays the invalid value.)</p>
 <p>See the <cite><ph conref="../conrefs.dita#pub/citref"></ph></cite>
for more information on how to use these system
 functions and procedures.</p>
 </conbody></concept>

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop13074.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop13074.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop13074.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop13074.dita Fri Mar 20 16:51:39 2009
@@ -27,8 +27,8 @@
 <conbody>
 <p>You can set persistent system-wide properties in a text file called
 <i>derby.properties</i>, which must be placed in the directory specified by the
-<i>derby.system.home</i> property. There should be one <i>derby.properties</i>
-file per system, not per database. The file must be created in the system
+<i>derby.system.home</i> property. There is one <i>derby.properties</i>
+file per system, not one per database. The file must be created in the system
 directory. In a client/server environment, that directory is on the server.
 (For more information about a
 <ph conref="../conrefs.dita#prod/productshortname"></ph> system and the system

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop24843.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop24843.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop24843.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop24843.dita Fri Mar 20 16:51:39 2009
@@ -26,13 +26,11 @@
 </prolog>
 <conbody>
 <p>In a client/server environment, you must set the system properties for
-the <i>server</i>'s system. That means when you are using
-the <i>derby.properties</i> file, the file exists in the <i>server</i>'s
<i>derby.system.home</i> directory.
-Client applications can set database-wide because they are set via SQL statements.
-Client applications can set dynamic system-wide properties in an SQL statement,
-as shown in the example in
-<xref href="cdevsetprop11561.dita#cdevsetprop11561/propobj"></xref>.
- 
+the <i>server</i>'s system. That means that when you are using
+the <i>derby.properties</i> file, the file exists in the <i>server</i>'s
+<i>derby.system.home</i> directory.
+Client applications can set database-wide properties because they are set via
+SQL statements.</p>
 <table frame="all">
 <title>Summary of ways to set properties</title>
 <tgroup cols="2" colsep="1" rowsep="1">
@@ -49,13 +47,15 @@
 <entry colname="2">
 <ul>
 <li>In <i>derby.properties</i></li>
-<li>Programmatically (as a command-line option to the JVM when starting the
-application or within application code)</li>
+<li>As a command-line option when starting the JVM that holds the server or, if
+the server is started from within a program, programmatically by the program
+that hosts the server</li>
 </ul></entry></row>
 <row>
 <entry colname="1">Database-wide</entry>
-<entry colname="2">Using system procedures and functions in an SQL statement </entry></row>
+<entry colname="2">Using system procedures and functions in an SQL statement</entry></row>
 </tbody>
 </tgroup>
-</table></p>
-</conbody></concept>
+</table>
+</conbody>
+</concept>

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop32443.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop32443.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop32443.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop32443.dita Fri Mar 20 16:51:39 2009
@@ -41,6 +41,8 @@
 property appropriately:
 <codeblock><b>java -Dderby.system.home=c:\system_directory MyApp</b></codeblock>
 </p>
+<p>The command lines in this example assume that you are using a Windows
+system.</p>
 <p>You then create a new table:
 <codeblock><b>CREATE TABLE table1 (a INT, b VARCHAR(10))</b></codeblock></p>
 <p><ph conref="../conrefs.dita#prod/productshortname"></ph> takes the page
size
@@ -48,11 +50,12 @@
 since the property has not been set any other way.</p>
 <p>You shut down and then restart your application, setting the value of
 <i>derby.storage.pageSize</i> to 4096 programmatically, as a parameter to the
-JVM command line:
+JVM command line:</p>
 <codeblock><b>java -Dderby.system.home=c:\system_directory 
     -Dderby.storage.pageSize=4096 MyApp
+
 CREATE TABLE anothertable (a INT, b VARCHAR(10))</b></codeblock>
-The page size for the <i>anothertable</i> table will be 4096 bytes.</p>
+<p>The page size for the <i>anothertable</i> table will be 4096 bytes.</p>
 <p>You establish a connection to the database and set the value of the page
 size for all new tables to 32768 as a database-wide property:
 <codeblock><b>CallableStatement cs = 
@@ -63,9 +66,9 @@
 cs.close(); 
 </b></codeblock></p>
 <p>You then create a new table that automatically inherits the page size set
-by the property:
+by the property:</p>
 <codeblock><b>CREATE TABLE table2 (a INT, b VARCHAR(10))</b></codeblock>
-The page size for the <i>table2</i> table is 32768 bytes.</p>
+<p>The page size for the <i>table2</i> table is 32768 bytes.</p>
 <p>You shut down the application, then restart, this time forgetting to set
 the system-wide property programmatically (as a command-line option to the
 JVM):

Modified: db/derby/docs/branches/10.5/src/devguide/cdevsetprop824451.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/devguide/cdevsetprop824451.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/devguide/cdevsetprop824451.dita (original)
+++ db/derby/docs/branches/10.5/src/devguide/cdevsetprop824451.dita Fri Mar 20 16:51:39 2009
@@ -23,7 +23,6 @@
 <indexterm>properties<indexterm>scope of</indexterm></indexterm>
 <indexterm>properties<indexterm>system-wide scope</indexterm></indexterm>
 <indexterm>properties<indexterm>database-wide scope</indexterm></indexterm>
-<indexterm>properties<indexterm>conglomerate-specific scope</indexterm></indexterm>
 </keywords>
 </metadata>
 </prolog>
@@ -38,14 +37,20 @@
 is applicable. Some properties, such as error handling and automatic booting,
 can be configured only in this way, since they apply to the entire system. (For
 information about the <ph conref="../conrefs.dita#prod/productshortname"></ph>
-system, see <xref href="cdevdvlp27610.dita#cdevdvlp27610"></xref>.)</p>
-<p>When you change these properties, they affect any tables or indexes created
-<i>after</i> this change.</p></li>
+system, see <xref href="cdevdvlp27610.dita#cdevdvlp27610"></xref>.)</p></li>
 <li><i>database-wide</i>  
 <p>Some properties can also be set on a <i>database-wide</i> basis. That
is, the
 property is true for the selected database only and not for the other databases
-in the system unless it is set individually within each of them.</p>
-<p>When you change these properties, they affect any tables or indexes created
-<i>after</i> this change.</p></li>
+in the system unless it is set individually within each of them.</p></li>
 </ul></p>
+<p>For properties that affect conglomerates, changing the value of such
+properties affects only conglomerates that are created after the change.
+Conglomerates created earlier are unaffected.</p>
+<note>Database-wide properties are stored in the database and are simpler for
+deployment, in the sense that they follow the database. Database-wide properties
+are also recommended for security reasons when you use
+<ph conref="../conrefs.dita#prod/productshortname"></ph> built-in user
+authentication (see <xref href="cdevcsecuree.dita#cdevcsecuree"></xref>).
+System-wide properties can be more practical during the development
+process.</note>
 </conbody></concept>

Modified: db/derby/docs/branches/10.5/src/ref/crefproper51399.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/ref/crefproper51399.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/ref/crefproper51399.dita (original)
+++ db/derby/docs/branches/10.5/src/ref/crefproper51399.dita Fri Mar 20 16:51:39 2009
@@ -33,14 +33,15 @@
 is an optional file that can be created to set properties at the system level
 when the <ph conref="../conrefs.dita#prod/productshortname"></ph> driver is
 loaded. <ph conref="../conrefs.dita#prod/productshortname"></ph> looks for
-this file in the directory defined by the derby.system.home property. Any
-property except derby.system.home can be set by including it in the <i>derby.properties</i>
file.</p></li>
+this file in the directory defined by the <i>derby.system.home</i> property.
Any
+property except <i>derby.system.home</i> can be set by including it in the <i>derby.properties</i>
file.</p></li>
 </ul></li>
 <li id="rrefproper15705"><i>database-wide</i>   <p>A database-wide
property
-is stored in a database and is valid for that specific database only.</p><note>Database-wide
-properties are stored in the database and are simpler for deployment. System-wide
-parameters are probably easier for development.</note></li>
+is stored in a database and is valid for that specific database only.</p></li>
 </ul></p>
+<note>Database-wide properties are stored in the database and are simpler and
+safer for deployment. System-wide properties can be more practical during the
+development process.</note>
 <p>For more information about scopes, precedence, and persistence, see
 "Properties overview" in the <ph conref="../conrefs.dita#pub/citdevelop"></ph>.</p>
 </conbody>

Modified: db/derby/docs/branches/10.5/src/ref/rrefgetdbpropfunc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/ref/rrefgetdbpropfunc.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/ref/rrefgetdbpropfunc.dita (original)
+++ db/derby/docs/branches/10.5/src/ref/rrefgetdbpropfunc.dita Fri Mar 20 16:51:39 2009
@@ -22,11 +22,17 @@
 <title>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY system function</title>
 <refbody>
 <section><p>The <codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph>
function
-fetches the value of a property specified by <codeph>KEY</codeph> of the database
-on the current connection.</p></section>
+fetches the value of the specified property of the database on the current
+connection.</p>
+<p>If the value that was set for the property is invalid, the
+<codeph>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY</codeph> function returns the
+invalid value, but <ph conref="../conrefs.dita#prod/productshortname"></ph> uses
+the default value.</p></section>
 <section><title>Syntax</title> <codeblock>VARCHAR(32762) SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY(IN
KEY VARCHAR(128))</codeblock> <p>An
-error will be returned if <codeph>KEY</codeph> is null.</p></section>
-<section><title>Example</title> <codeblock>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('key_value_string');</codeblock></section>
+error will be returned if KEY is null.</p></section>
+<section><title>SQL example</title> <p>Retrieve the value of the
+<codeph>derby.locks.deadlockTimeout</codeph> property:</p>
+<codeblock>VALUES SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY('derby.locks.deadlockTimeout');</codeblock></section>
 </refbody>
 </reference>
 

Modified: db/derby/docs/branches/10.5/src/ref/rrefsetdbpropproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/ref/rrefsetdbpropproc.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/ref/rrefsetdbpropproc.dita (original)
+++ db/derby/docs/branches/10.5/src/ref/rrefsetdbpropproc.dita Fri Mar 20 16:51:39 2009
@@ -25,10 +25,15 @@
 procedure to set or delete the value of a property of the database on the
 current connection. For information about properties, see
 <xref href="rrefproper32213.dita#rrefproper32213"></xref>.</p></section>
-<section><p>If  "VALUE" is not null, then the property with key value "KEY"
-is set to "VALUE".  If "VALUE" is null, then the property with key value "KEY"
-is deleted from the database property set.</p></section>
-<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_GET_DATABASE_PROPERTY(IN
KEY VARCHAR(128),
+<section><p>If VALUE is not null, then the property with key value KEY
+is set to VALUE.  If VALUE is null, then the property with key value KEY
+is deleted from the database property set.</p>
+<p>If VALUE is an invalid value for the property,
+<ph conref="../conrefs.dita#prod/productshortname"></ph> uses the default value
+of the property, although
+<codeph>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY</codeph> returns the invalid
+value.</p></section>
+<section><title>Syntax</title> <codeblock>SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(IN
KEY VARCHAR(128),
 IN VALUE VARCHAR(32672))</codeblock> <p>This procedure does not return any
 results.</p></section>
 <section><title>JDBC example</title> <p>Set the
@@ -41,7 +46,7 @@
 cs.close();</codeblock></section>
 <section><title>SQL example</title> <p>Set the <codeph>derby.locks.deadlockTimeout</codeph>
property
 to a value of 10:</p> <codeblock>CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY
-('derby.locks.deadlockTimeout', '10');</codeblock></section>
+('derby.locks.deadlockTimeout', '10')</codeblock></section>
 </refbody>
 </reference>
 

Modified: db/derby/docs/branches/10.5/src/ref/rrefsqlj31783.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/ref/rrefsqlj31783.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/ref/rrefsqlj31783.dita (original)
+++ db/derby/docs/branches/10.5/src/ref/rrefsqlj31783.dita Fri Mar 20 16:51:39 2009
@@ -51,7 +51,10 @@
 the index is being updated.</p> 
 </section>
 <example> <codeblock><b>SELECT RECEIVED, SOURCE, SUBJECT, NOTE_TEXT FROM
SAMP.IN_TRAY FOR UPDATE
-</b></codeblock> </example>
+</b></codeblock>
+<p>For information about how indexes affect performance, see
+<ph conref="../conrefs.dita#pub/cittuning"></ph>.</p>
+</example>
 </refbody>
 </reference>
 

Modified: db/derby/docs/branches/10.5/src/tuning/ctunpropref11181.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.5/src/tuning/ctunpropref11181.dita?rev=756616&r1=756615&r2=756616&view=diff
==============================================================================
--- db/derby/docs/branches/10.5/src/tuning/ctunpropref11181.dita (original)
+++ db/derby/docs/branches/10.5/src/tuning/ctunpropref11181.dita Fri Mar 20 16:51:39 2009
@@ -23,6 +23,6 @@
 <conbody>
 <p>This guide, <cite><ph conref="../conrefs.dita#pub/cittuning"></ph></cite>,
 explains how to tune systems, databases, specific tables and indexes, and
-queries. This guide also provides performance tuning tips and an in-depth study
+queries for performance. This guide also provides an in-depth study
 of query optimization and performance issues.</p>
 </conbody></concept>



Mime
View raw message