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 exception messages.

  • Information about 's implementation -of the JDBC interface including support for JDBC 2.0 features.

  • +of the Java Database Connectivity (JDBC) API.

  • Information about the supported attributes to 's JDBC database connection URL.

  • +
  • +

    Information about +properties.

  • Information -about the supported attributes to 's -support for the Java Transaction API.

  • +about 's support for the +Java EE platform, in particular support for the Java Transaction API and the +JDBC API.

  • Notes about proprietary APIs for .

  • +
  • Territories +supported by .

  • +
  • Limitations +of .

  • Added: db/derby/docs/trunk/src/ref/crefproper22250.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper22250.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/crefproper22250.dita (added) +++ db/derby/docs/trunk/src/ref/crefproper22250.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,302 @@ + + + + + +Derby properties +The properties +are used for configuring the system and database, as well as for diagnostics +such as logging statements, and monitoring and tracing locks. + +propertiesoverview, Derby + + + +

    The table + lists +all the core +properties.

    +

    For information on how to set + properties, see +"Ways of setting Derby properties" in +.

    +When +setting properties that have boolean values, be sure to trim extra spaces +around the word true. Extra spaces around the word true cause +the property to be set to false, regardless of its previous setting. +

    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 +).

    +
      +
    1. [*] System-wide properties set programmatically (as a command-line option +to the JVM when starting the application or within application code)
    2. +
    3. Database-wide properties
    4. +
    5. [*] System-wide properties set in the derby.properties file
    6. +

    [*] Not consulted if + is set to true.

    +

    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 +property:

    +Statement s = conn.createStatement(); +s.executeUpdate("CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY(" + + "'derby.database.fullAccessUsers', null)"); +

    If the property is a static one, the null setting does not take effect until +you reboot the database. Moreover, the static property + cannot be +disabled after it has been enabled, even with a reboot.

    +

    summarizes +the general properties. +In this table, S stands for system-wide, D stands for database-wide, and C +indicates the value persists with newly created conglomerates. X means yes. + Derby properties + + + + +Property +Scope +Dynamic + + + + +derby.authentication.ldap.searchAuthDN +S, D +  + + +derby.authentication.ldap.searchAuthPW +S, D +  + + +derby.authentication.ldap.searchBase +S, D +  + + +derby.authentication.ldap.searchFilter +S, D +  + + +derby.authentication.provider +S, D +  + + +derby.authentication.server +S, D +  + + +derby.connection.requireAuthentication +S, D +  + + +derby.database.defaultConnectionMode +S, D +X* + + +derby.database.forceDatabaseLock +S +  + + +derby.database.fullAccessUsers +S, D +X* + + +derby.database.noAutoBoot +D +  + + +derby.database.propertiesOnly +D +X + + +derby.database.readOnlyAccessUsers +S, D +X* + + +derby.database.sqlAuthorization +S, D +  + + +derby.infolog.append +S +  + + +derby.jdbc.xaTransactionTimeout +S, D +X + + +derby.language.logQueryPlan +S +  + + +derby.language.logStatementText +S, D +  + + +derby.locks.deadlockTimeout +S, D +X + + +derby.locks.deadlockTrace +S, D +X + + +derby.locks.escalationThreshold +S, D +X + + +derby.locks.monitor +S, D +X + + +derby.locks.waitTimeout +S, D +X + + +derby.replication.logBufferSize +S +  + + +derby.replication.maxLogShippingInterval +S +  + + +derby.replication.minLogShippingInterval +S +  + + +derby.replication.verbose +S +  + + +derby.storage.initialPages +C +  + + +derby.storage.minimumRecordSize +S, D, C +X + + +derby.storage.pageCacheSize +S +  + + +derby.storage.pageReservedSpace +S, D, C +X + + +derby.storage.pageSize +S, D, C +X + + +derby.storage.rowLocking +S, D +  + + +derby.storage.tempDirectory +S, D +X + + +derby.stream.error.field +S +  + + +derby.stream.error.file +S +  + + +derby.stream.error.method +S +  + + +derby.stream.error.logSeverityLevel +S +  + + +derby.system.bootAll +S +  + + +derby.system.durability +S +  + + +derby.system.home +S +  + + +derby.user.UserName +S, D +X + + + +

    +

    * See the main page for this property for information +about when changes to the property are dynamic.

    +

    There are additional properties associated with the tools. +For more information about tool-specific properties, see the .

    +
    +
    Propchange: db/derby/docs/trunk/src/ref/crefproper22250.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/crefproper51399.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproper51399.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/crefproper51399.dita (added) +++ db/derby/docs/trunk/src/ref/crefproper51399.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,47 @@ + + + + +Scope of Derby properties + + +

    A property in belongs +to one or more of these scopes:

    +

    For more information about scopes, precedence, and persistence, see +"Properties overview" in .

    +
    +
    Propchange: db/derby/docs/trunk/src/ref/crefproper51399.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/crefproperdynstat.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/crefproperdynstat.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/crefproperdynstat.dita (added) +++ db/derby/docs/trunk/src/ref/crefproperdynstat.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,53 @@ + + + + +Dynamic and static properties + + +Static properties +Dynamic properties +Propertiesdynamic versus static + + + + +

    Most properties are dynamic; that means you can set them while + is running, and their +values change without requiring a reboot of +. In some cases, this +change takes place immediately; in some cases, it takes place at the next +connection.

    +

    Some properties are static, which means changes to their values will not +take effect while is +running. You must restart or set them before (or while) starting +.

    +Properties set in the derby.properties file and on the command line +of the application that boots + are always +static, because reads +this file and those parameters only at startup. +

    Only properties set in the following ways have the potential to be +dynamic:

    + +
    Propchange: db/derby/docs/trunk/src/ref/crefproperdynstat.dita ------------------------------------------------------------------------------ svn:eol-style = native Modified: db/derby/docs/trunk/src/ref/refderby.ditamap URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=713746&r1=713745&r2=713746&view=diff ============================================================================== --- db/derby/docs/trunk/src/ref/refderby.ditamap (original) +++ db/derby/docs/trunk/src/ref/refderby.ditamap Thu Nov 13 08:09:44 2008 @@ -610,6 +610,89 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Modified: db/derby/docs/trunk/src/ref/rrefgetuseraccess.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefgetuseraccess.dita?rev=713746&r1=713745&r2=713746&view=diff ============================================================================== --- db/derby/docs/trunk/src/ref/rrefgetuseraccess.dita (original) +++ db/derby/docs/trunk/src/ref/rrefgetuseraccess.dita Thu Nov 13 08:09:44 2008 @@ -25,9 +25,9 @@ returns the current connection access permission for the user specified.

    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 derby.database.defaultConnectionMode property. -See "Derby properties" in for -more information about this property.

    +is set by using the +derby.database.defaultConnectionMode +property.

    Syntax SYSCS_UTIL.SYSCS_GET_USER_ACCESS (USERNAME VARCHAR(128)) RETURNS VARCHAR(128)
    USERNAME
    @@ -35,9 +35,12 @@ conref="../conrefs.dita#prod/productshortname"> database.

    The value that is returned by this function is either fullAccess, readOnlyAccess, or noAccess.

    A return value of noAccess means -that the connection attempt by the user will be denied because neither the derby.database.fullAccessUsers property -or the derby.database.readOnlyAccessUsers property is set -for the user, and the derby.database.defaultConnectionMode property +that the connection attempt by the user will be denied because neither the +derby.database.fullAccessUsers +property nor the +derby.database.readOnlyAccessUsers +property is set +for the user, and the derby.database.defaultConnectionMode property is set to noAccess.

    The names of the connection permissions match the existing names in use by .

    Example VALUES SYSCS_UTIL.SYSCS_GET_USER_ACCESS ('BRUNNER')
    Added: db/derby/docs/trunk/src/ref/rrefproper10607.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper10607.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper10607.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper10607.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,57 @@ + + + + +derby.locks.deadlockTimeout + +derby.locks.deadlockTimeoutDeadlockstimeout property + + + +
    Function +

    Determines the number of seconds after which + checks whether a +transaction waiting to obtain a lock is involved in a deadlock. If a deadlock +has occurred, and +chooses the transaction as a deadlock victim, + aborts the transaction. +The transaction receives an SQLException of SQLState 40001. If the +transaction is not chosen as the victim, it continues to wait for a lock if +derby.locks.waitTimeout +is set to a higher value than the value of derby.locks.deadlockTimeout. +

    +

    If this property is set to a higher value than +derby.locks.waitTimeout, no deadlock checking occurs. See +derby.locks.waitTimeout.

    +

    For more information about deadlock checking, see "Deadlocks" in the +.

    +
    +
    Default +

    20 seconds.

    +
    +Example +derby.locks.deadlockTimeout=30 +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.locks.deadlockTimeout', '30') + +
    Dynamic or static +

    Dynamic; the change takes effect immediately. For information about dynamic +changes to properties, see +.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper10607.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper13217.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper13217.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper13217.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper13217.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,50 @@ + + + + +derby.infolog.append + +derby.infolog.append +Information logoverwriting + + + +
    Function +

    Specifies whether to append to or overwrite (delete and recreate) the +derby.log file when the + engine is started. The +derby.log file is used to record errors and other information. This +information can help you debug problems within a system.

    +

    You can set this property even if the file does not yet exist; + creates the file.

    +
    +
    Default +

    False.

    +

    By default, the file is deleted and then re-created.

    +
    +Example +derby.infolog.append=true + +
    Scope +

    system-wide

    +
    +
    Dynamic or static +

    This property is static; if you change it while + is running, the change +does not take effect until you reboot.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper13217.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper13766.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper13766.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper13766.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper13766.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,84 @@ + + + + + +derby.authentication.provider + +derby.authentication.provider +Authentication providerspecifying + + +
    Function

    Specifies the authentication provider +for user +authentication.

    +

    Legal values include:

    +
      +
    • LDAP

      An external LDAP directory service.

    • +
    • BUILTIN

      's +simple internal user authentication repository.

    • +
    • A complete Java class name

      A user-defined class that provides user +authentication.

    • +
    +

    When using an external authentication service provider (LDAP), you must also +set:

    +
      +
    • derby.authentication.server
    • +
    +

    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 adaptable +to various naming and directory services. For example, the class could allow + to hook up to an +existing user authentication service that uses any of the standard directory and +naming service providers to JNDI.

    +

    To enable any user +authentication, you must set the +derby.connection.requireAuthentication +property to true.

    +

    For more information about user authentication, see the .

    +Syntax +derby.authentication.provider={ LDAP | BUILTIN | classProviderName } + +
    Default

    BUILTIN

    +Example -- system-wide property +derby.authentication.provider=LDAP +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.authentication.provider', + 'BUILTIN') +
    Dynamic or static +

    Static. For system-wide properties, you must reboot + for the change to take +effect. For database-wide properties, you must reboot the database for the +change to take effect.

    +
    +
    +
    + Propchange: db/derby/docs/trunk/src/ref/rrefproper13766.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper18151.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper18151.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper18151.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper18151.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,46 @@ + + + + +derby.stream.error.file + +derby.stream.error.file +Error logspecifying file name + + + +
    Function +

    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.stream.error.method +and +derby.stream.error.field +properties are ignored.

    +
    +
    Default +

    derby.log.

    +
    +Example +derby.stream.error.file=error.txt + +
    Dynamic or static +

    This property is static; if you change it while + is running, the change +does not take effect until you reboot.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper18151.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper23835.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper23835.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper23835.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper23835.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,54 @@ + + + + +derby.locks.deadlockTrace + +derby.locks.deadlockTrace +Deadlockstracing + + + +
    Function +

    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, describes the +cycle of locks which caused the deadlock. For a timeout, + prints the entire lock +list at the time of the timeout. This property is meaningful only if the +derby.locks.monitor +property is set to true.

    +This level of debugging is intrusive: it can alter +the timing of the application, reduce performance severely, and produce a +large error log file. It should be used with care. +
    +
    Default +

    False.

    +
    +Example +-- system property +derby.locks.deadlockTrace=true + +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.locks.deadlockTrace', 'true') + +
    Dynamic or static +

    Dynamic; the change takes effect immediately. For information about dynamic +changes to properties, see +.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper23835.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper24390.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper24390.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper24390.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper24390.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,50 @@ + + + + +derby.database.propertiesOnly + +derby.database.propertiesOnly +Database-wide propertiesprotecting against +overrides + + + +
    Function +

    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.

    +
    +
    Default +

    False.

    +
    +Example +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.database.propertiesOnly','true') + +
    Dynamic or static +

    This property is dynamic; if you change it while + is running, the change +takes effect immediately. For information about dynamic changes to properties, +see .

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper24390.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper24846.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper24846.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper24846.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper24846.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,68 @@ + + + + +derby.database.defaultConnectionMode + +derby.database. defaultConnectionMode +User authorizationconfiguring + + + +
    Function +

    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:

    +
      +
    • noAccess +

      Disallows connections.

    • +
    • readOnlyAccess +

      Grants read-only connections.

    • +
    • fullAccess +

      Grants full access.

    • +
    +

    If the property is set to an invalid value, an exception is raised.

    +It is possible to configure a database so that it cannot be changed +(or even accessed) using this property. If you set this property to +noAccess or readOnlyAccess, be sure to allow at least one user +full access. See and +. +

    For more information about user authorization, see "User Authorization" +in the .

    +
    +Syntax +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.database.defaultConnectionMode', + '{ noAccess | readOnlyAccess | fullAccess}') + +Example +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.database.defaultConnectionMode', 'noAccess') +-- system-wide property +derby.database.defaultConnectionMode=noAccess + +
    Default +

    fullAccess

    +
    +
    Dynamic or static +

    Dynamic. Current connections are not affected, but all future connections +are affected. For information about dynamic changes to properties, see +.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper24846.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper25025.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper25025.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper25025.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper25025.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,60 @@ + + + + +derby.database.fullAccessUsers + +derby.database.fullAccessUsers +User authorizationconfiguring + + + +
    Function +

    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.

    +User names, called authorization identifiers, +follow the rules of SQL92Identifiers and can be delimited. +Specifying a user name that does not follow these rules raises an +exception. +

    For more information about user authorization, see "User Authorization" +in the .

    +
    +Syntax +-- database-level property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.database.fullAccessUsers', + 'commaSeparatedlistOfUsers') + +Example +-- database-level property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.database.fullAccessUsers', 'dba,fred,peter') +--system-level property +derby.database.fullAccessUsers=dba,fred,peter + +
    Dynamic or static +

    Dynamic. Current connections are not affected, but all future connections +are affected. For information about dynamic changes to properties, see +.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper25025.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper25581.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper25581.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper25581.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper25581.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,72 @@ + + + + + +derby.authentication.server + +derby.authentication.server +LDAPconfiguring + + + +
    Function +

    Specifies the location of the external directory service that provides user +authentication for the +system as defined with +. For LDAP, specify +the host name and port number.

    +

    The server must be known on the network.

    +

    For more information about external user authentication, see "External +directory service" in the .

    +
    +
    Default +

    Not applicable. Note that if the protocol type is unspecified, it defaults to +LDAP.

    +Syntax +derby.authentication.server= +[{ ldap: | ldaps: | nisplus: }] +[//] + +{ + hostname [ :portnumber ] | + nisServerName/nisDomain +} +Example +-- system-wide property +##LDAP example +derby.authentication.server=godfrey:9090 +##LDAP example +derby.authentication.server=ldap://godfrey:9090 +##LDAP example +derby.authentication.server=//godfrey:9090 +##LDAP over SSL example +derby.authentication.server=ldaps://godfrey:636/ +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.authentication.server', + 'godfrey:9090') +
    Dynamic or static +

    Static. For system-wide properties, you must reboot + for the change to take +effect. For database-wide properties, you must reboot the database for the +change to take effect.

    +
    +
    + Propchange: db/derby/docs/trunk/src/ref/rrefproper25581.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper26978.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper26978.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper26978.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper26978.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,50 @@ + + + + +derby.authentication.ldap.searchBase + +derby.authentication.ldap.searchbase +LDAPconfiguring + + + +
    Function +

    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:

    +ou=people,o=ExampleSite.com +

    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 +.

    +
    +Example +-- system-wide property +derby.authentication.ldap.searchBase= + ou=people,o=ExampleSite.com +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.authentication.ldap.searchBase', + 'ou=people,o=ExampleSite.com') + +
    Dynamic or static +

    Static. For system-wide properties, you must reboot + for the change to take +effect. For database-wide properties, you must reboot the database for the +change to take effect.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper26978.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper26985.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper26985.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper26985.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper26985.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,65 @@ + + + + +derby.stream.error.logSeverityLevel + +derby.stream.error.logSeverityLevel +Error logconfiguring severity of errors +that appear in + + + +
    Function +

    Specifies which errors are logged to the + error log (typically +the derby.log file). In test environments, use the setting +derby.stream.error.logSeverityLevel=0 so that all problems are +reported.

    +

    Any error raised in a + system is given a level +of severity. This property indicates the minimum severity necessary for an error +to appear in the error log. The severities are defined in the class +org.apache.derby.types.ExceptionSeverity. The higher the number, the more +severe the error.

    +
      +
    • 20000 +

      Errors that cause the statement to be rolled back, for example syntax errors +and constraint violations.

    • +
    • 30000 +

      Errors that cause the transaction to be rolled back, for example +deadlocks.

    • +
    • 40000 +

      Errors that cause the connection to be closed.

    • +
    • 50000 +

      Errors that shut down the + system.

    • +
    +
    +
    Default +

    40000.

    +
    +Example +// send errors of level 30000 and higher to the log +derby.stream.error.logSeverityLevel=30000 + +
    Dynamic or static +

    This property is static; if you change it while + is running, the change +does not take effect until you reboot.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper26985.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper27355.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27355.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper27355.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper27355.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,93 @@ + + + + + +derby.user.UserName + +derby.user +Userscreating + + + +
    Function +

    Has two uses:

    +
      +
    • Creates users and passwords when +derby.authentication.provider +is set to BUILTIN.
    • +
    • Caches user DNs locally when derby.authentication.provider is set to +LDAP and +derby.authentication.ldap.searchFilter +is set to derby.user.
    • +
    +
    Users and Passwords +

    This property creates valid clear-text users and passwords within + when the +derby.authentication.provider property is set to BUILTIN. For +information about users, see "Working with user authentication" in the +.

    +
      +
    • Database-Level Properties

      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.

    • +
    • System-Level Properties

      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, + validates them against +the properties defined for the current system.

    +

    User names are SQL92Identifiers and can be delimited.

    +Syntax +derby.user.{UserName=Password} | UserName=userDN } +-- database-level property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.user.UserName', + 'Password | userDN') +
    Default +

    None.

    +Example +-- system-level property +derby.user.guest=java5w +derby.user.sa=3x9 + +derby.user."!Amber"=java5w +-- database-level property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.user.sa', + '3x9') +-- cache a userDN locally, database-level property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.user.richard', + 'uid=richard, ou=People, o=ExampleSite.com') + +
    Dynamic or static +

    Dynamic; the change takes effect immediately. For information about dynamic +changes to properties, see +.

    +
    +
    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper27355.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper27467.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27467.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper27467.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper27467.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,57 @@ + + + + +derby.connection.requireAuthentication + +derby.connection. requireAuthentication +Authenticationturning on +User authenticationturning on + + + +
    Function +

    Turns on user authentication for +.

    +

    When user authentication is turned on, a connection request must provide +a valid user name and password.

    +

    uses the type of +user authentication specified with the +derby.authentication.provider +property.

    +

    For more information about user authentication, see "Working with user +authentication" in the .

    +
    +
    Default +

    False.

    +

    By default, no user authentication is required.

    +
    +Example +-- system-wide property +derby.connection.requireAuthentication=true +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.connection.requireAuthentication', + 'true') + +
    Dynamic or static +

    Static. For system-wide properties, you must reboot + for the change to take +effect. For database-wide properties, you must reboot the database for the +change to take effect.

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper27467.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper27529.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper27529.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper27529.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper27529.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,67 @@ + + + + +derby.storage.initialPages + +derby.storage.initialPages +Database pagespreallocating + + + +
    Function +

    The on-disk size of a + table grows by one page +at a time until eight pages of user data (or nine pages of total disk use; one +is used for overhead) have been allocated. Then it will grow by eight pages at a +time if possible.

    +

    A table or index can +be created with a number of pages already pre-allocated. To do so, specify the +property prior to the CREATE TABLE or CREATE INDEX statement.

    +

    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:

    +(1 + derby.storage.initialPages) * derby.storage.pageSize +

    When you create a table or an index after setting this property, + attempts to preallocate +the requested number of user pages. However, the operations do not fail even if +they are unable to preallocate the requested number of pages, as long as they +allocate at least one page.

    +
    +
    Default +

    1 page.

    +
    +
    Minimum value +

    The minimum number of initialPages is 1.

    +
    +
    Maximum value +

    The maximum number of initialPages is 1000.

    +
    +Example +-- system-wide property +derby.storage.initialPages=30 + +-- database-wide property +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( +'derby.storage.initialPages', '30') +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper27529.dita ------------------------------------------------------------------------------ svn:eol-style = native Added: db/derby/docs/trunk/src/ref/rrefproper28026.dita URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefproper28026.dita?rev=713746&view=auto ============================================================================== --- db/derby/docs/trunk/src/ref/rrefproper28026.dita (added) +++ db/derby/docs/trunk/src/ref/rrefproper28026.dita Thu Nov 13 08:09:44 2008 @@ -0,0 +1,64 @@ + + + + +derby.storage.pageReservedSpace + +derby.storage.pageReservedSpace +Reserving space on a page + + + +
    Function +

    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.

    +
    +
    Valid conglomerates +

    Tables only.

    +
    +
    Default +

    20%.

    +
    +
    Minimum value +

    The minimum value is 0% and the maximum is 100%. If you specify a value +outside this range, +uses the default value of 20%.

    +
    +Example +-- modifying the default for the system +derby.storage.pageReservedSpace=40 +-- modifying the default for the database +CALL SYSCS_UTIL.SYSCS_SET_DATABASE_PROPERTY( + 'derby.storage.pageReservedSpace', + '40') + + +
    Dynamic or static +

    This property is dynamic: if you change it while + is running, the change +takes effect immediately. For information about dynamic changes to properties, +see .

    +
    Propchange: db/derby/docs/trunk/src/ref/rrefproper28026.dita ------------------------------------------------------------------------------ svn:eol-style = native