Author: chaase3
Date: Thu Nov 13 08:09:44 2008
New Revision: 713746
URL: http://svn.apache.org/viewvc?rev=713746&view=rev
Log:
DERBY-2389: Move Derby system and properties info from Tuning Guide into Reference Manual
This patch adds the system properties reference topics to the Reference Manual and fixes references to the topics within the Reference Manual.
Patch: DERBY-2389-ref.diff
Added:
db/derby/docs/trunk/src/ref/crefproper22250.dita (with props)
db/derby/docs/trunk/src/ref/crefproper51399.dita (with props)
db/derby/docs/trunk/src/ref/crefproperdynstat.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper10607.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper13217.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper13766.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper18151.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper23835.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper24390.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper24846.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper25025.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper25581.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper26978.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper26985.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper27355.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper27467.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper27529.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper28026.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper32066.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper32213.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper33027.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper34037.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper35028.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper37341.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper39325.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper40346.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper40688.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper43414.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper43517.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper46141.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper81359.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper81405.dita (with props)
db/derby/docs/trunk/src/ref/rrefproper98166.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperauthdn.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperauthpw.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperbootall.dita (with props)
db/derby/docs/trunk/src/ref/rrefpropercachedn.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperdurability.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperlogbuffersize.dita (with props)
db/derby/docs/trunk/src/ref/rrefpropermaxlogshippinginterval.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperminlogshippinginterval.dita (with props)
db/derby/docs/trunk/src/ref/rrefpropernoautoboot.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperrowlocking.dita (with props)
db/derby/docs/trunk/src/ref/rrefpropersqlauth.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperstormin.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperverbose.dita (with props)
db/derby/docs/trunk/src/ref/rrefproperxatrantimeout.dita (with props)
Modified:
db/derby/docs/trunk/src/ref/crefmpref23947.dita
db/derby/docs/trunk/src/ref/refderby.ditamap
db/derby/docs/trunk/src/ref/rrefgetuseraccess.dita
db/derby/docs/trunk/src/ref/rrefsetdbpropproc.dita
db/derby/docs/trunk/src/ref/rrefsetuseraccess.dita
db/derby/docs/trunk/src/ref/rrefsqlj31580.dita
db/derby/docs/trunk/src/ref/rrefsqljgrant.dita
db/derby/docs/trunk/src/ref/rrefsqljrevoke.dita
db/derby/docs/trunk/src/ref/rrefsyscsdiagtables.dita
Modified: db/derby/docs/trunk/src/ref/crefmpref23947.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefmpref23947.dita?rev=713746&r1=713745&r2=713746&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/crefmpref23947.dita (original)
+++ db/derby/docs/trunk/src/ref/crefmpref23947.dita Thu Nov 13 08:09:44 2008
@@ -37,15 +37,23 @@
about
Information
about
Information
about the supported attributes to
Information about
Information
-about the supported attributes to
Notes
about proprietary APIs for
Territories
+supported by
Limitations
+of
The table
+
For information on how to set
+
To disable or turn off a database-wide property setting, set its value to
+null. To determine the result of this action, recall that the search order for
+properties is as follows (as stated in "Precedence of properties" in
+
[*] Not consulted if
+
Setting the database-wide property to null has the effect of removing the +property from the list of database properties and restoring the system property +setting from derby.properties if there is one. As always, if no value can +be determined from the search, the built-in default applies.
+For example, the following code fragment turns off a previous database-wide
+setting of the
If the property is a static one, the null setting does not take effect until
+you reboot the database. Moreover, the static property
+
* See the main page for this property for information +about when changes to the property are dynamic.
+There are additional properties associated with the
A property in
System-wide properties apply +to an entire system, including all its databases and tables if applicable.
+System-wide properties set +programmatically have precedence over database-wide properties and system-wide +properties set in the derby.properties file.
The derby.properties file
+is an optional file that can be created to set properties at the system level
+when the
A database-wide property +is stored in a database and is valid for that specific database only.
For more information about scopes, precedence, and persistence, see
+"Properties overview" in
Most properties are dynamic; that means you can set them while
+
Some properties are static, which means changes to their values will not
+take effect while
Only properties set in the following ways have the potential to be +dynamic:
+If
no permission is explicitly set for the user, the access permission for the
user is the value of the default connection mode. The default connection mode
-is set by using the
The value that is returned by this function is either
A return value of
The names of the connection permissions
match the existing names in use by
Determines the number of seconds after which
+
If this property is set to a higher value than
+derby.locks.waitTimeout, no deadlock checking occurs. See
+
For more information about deadlock checking, see "Deadlocks" in the
+
20 seconds.
+Dynamic; the change takes effect immediately. For information about dynamic
+changes to properties, see
+
Specifies whether to append to or overwrite (delete and recreate) the
+derby.log file when the
+
You can set this property even if the file does not yet exist;
+
False.
+By default, the file is deleted and then re-created.
+This property is static; if you change it while
+
Specifies the authentication provider
+for
Legal values include:
+An external LDAP directory service.
A user-defined class that provides user +authentication.
When using an external authentication service provider (LDAP), you must also +set:
+When using LDAP, you can set other LDAP-specific properties. See also:
+Alternatively, you can write your own class to provide a different external
+authentication service. This class must implement the public interface
+org.apache.derby.authentication.UserAuthenticator and throw exceptions
+of the type java.sql.SQLException where appropriate. Using a user-defined
+class makes
To enable any
For more information about user authentication, see the
BUILTIN
Static. For system-wide properties, you must reboot
+
Specifies name of the file to which the error log is written. If the file +name is relative, it is taken as relative to the system directory.
+If this property is set, the
+
derby.log.
+This property is static; if you change it while
+
Causes a detailed list of locks at the time of a deadlock or a timeout
+to be written to the error log (typically the file derby.log). For a
+deadlock,
False.
+Dynamic; the change takes effect immediately. For information about dynamic
+changes to properties, see
+
When set to true, this property ensures that database-wide properties cannot +be overridden by system-wide properties.
+When this property is set to false, or not set, database-wide properties can
+be overridden by system-wide properties (see "Precedence of properties" in
+
This property ensures that a database's environment cannot be modified by the +environment in which it is booted.
+This property can never be overridden by system properties.
+False.
+This property is dynamic; if you change it while
+
One of the user authorization properties.
+Defines the default connection mode for users of the database or system +for which this property is set. The possible values (which are case-insensitive) +are:
+Disallows connections.
Grants read-only connections.
Grants full access.
If the property is set to an invalid value, an exception is raised.
+For more information about user authorization, see "User Authorization"
+in the
fullAccess
+Dynamic. Current connections are not affected, but all future connections
+are affected. For information about dynamic changes to properties, see
+
One of the user authorization properties. Specifies a list of users to +which full (read-write) access to a database is granted. The list consists +of user names separated by commas. Do not put spaces after commas.
+When set as a system property, specifies a list of users for which full +access to all the databases in the system is granted.
+See also
A malformed list of user names raises an exception. Do not specify a user +both with this property and in derby.database.readOnlyAccessUsers.
+For more information about user authorization, see "User Authorization"
+in the
Dynamic. Current connections are not affected, but all future connections
+are affected. For information about dynamic changes to properties, see
+
Specifies the location of the external directory service that provides user
+authentication for the
The server must be known on the network.
+For more information about external user authentication, see "External
+directory service" in the
Not applicable. Note that if the protocol type is unspecified, it defaults to +LDAP.
Static. For system-wide properties, you must reboot
+
Specifies the root DN of the point in your hierarchy from which to begin +a guest or anonymous search for the user's DN. For example:
+When using Netscape Directory Server, set this property to the root DN, +the special entry to which access control does not apply.
+For more information about LDAP user authentication, see the
+
Static. For system-wide properties, you must reboot
+
Specifies which errors are logged to the
+
Any error raised in a
+
Errors that cause the statement to be rolled back, for example syntax errors +and constraint violations.
Errors that cause the transaction to be rolled back, for example +deadlocks.
Errors that cause the connection to be closed.
Errors that shut down the
+
40000.
+This property is static; if you change it while
+
Has two uses:
+This property creates valid clear-text users and passwords within
+
When you create users with +database-level properties, those users are available to the specified database +only.
+You set the property once for each user. To delete a user, set that user's +password to null.
When you create users with system-level +properties, those users are available to all databases in the system.
+You set the value of this system-wide property once for each user, so you can +set it several times. To delete a user, remove that user from the file.
+You can define this property in the usual ways -- typically in the +derby.properties file.
When a user name and its corresponding password are provided in the
+DriverManager.getConnection call,
+
User names are SQL92Identifiers and can be delimited.
None.
Dynamic; the change takes effect immediately. For information about dynamic
+changes to properties, see
+
Turns on user authentication for
+
When user authentication is turned on, a connection request must provide +a valid user name and password.
+For more information about user authentication, see "Working with user
+authentication" in the
False.
+By default, no user authentication is required.
+Static. For system-wide properties, you must reboot
+
The on-disk size of a
+
A
Define the number of user pages the table or index is to be created with. +The purpose of this property is to preallocate a table or index of reasonable +size if the user expects that a large amount of data will be inserted into +the table or index. A table or index that has the pre-allocated pages will +enjoy a small performance improvement over a table or index that has no +pre-allocated pages when the data are loaded.
+The total desired size of the table or index should be the following number +of bytes:
+When you create a table or an index after setting this property,
+
1 page.
+The minimum number of initialPages is 1.
+The maximum number of initialPages is 1000.
+Defines the percentage of space reserved for updates on an on-disk database +page for tables only (not indexes); indicates the percentage of space to keep +free on a page when inserting. Leaving reserved space on a page can minimize +row overflow (and the associated performance hit) during updates. Once a page +has been filled up to the reserved-space threshold, no new rows are allowed +on the page. This reserved space is used only for rows that increase in size +when updated, not for new inserts. Set this property prior to issuing the +CREATE TABLE statement.
+Regardless of the value of derby.storage.pageReservedSpace, an empty +page always accepts at least one row.
+Tables only.
+20%.
+The minimum value is 0% and the maximum is 100%. If you specify a value
+outside this range,
This property is dynamic: if you change it while
+