SAND CDBMS Administration Guide
The Nucleus.ini File


Chapter Index
Next Topic:
Nucleus.ini file Parameters - Database Sections



Every SAND CDBMS installation includes a configuration file, named nucleus.ini, which resides in the same directory as the SAND CDBMS executable files (this is the SUPPORT directory as specified in the NUCLEUS environment variable).

Generally, manual nucleus.ini configuration is required. However, in some cases, certain settings are made automatically by SAND software, and those entries should not be altered by users.

Server-side nucleus.ini files contain information related to SAND database operations and client connections on a particular host computer. Client-side nucleus.ini files contain information about how to connect as a client to a SAND database over a network.

Note that if changes are made to a nucleus.ini file after the SAND server has started, those changes will not be visible to the running server. The server/database would have to be restarted in order for the nucleus.ini file to be reread and the changes recognized.


Nucleus.ini file Sections

Nucleus.ini files can contain DATABASE, CONNECTION, [CLIENT], [DCL], [LICENSE], [NUCLEUS], and other sections.

Other sections related to Octopus functionality may also appear in the nucleus.ini file.

Method of Parameter Resolution

SAND CDBMS searches for required operating information in the following locations, in the following order:

    1. NUCLEUS environment variable; note that if a hyphen ( - ) is specified instead of a value for a parameter in the Nucleus variable, the SAND CDBMS default value will be used.
    2. DATABASE, CONNECTION, or [CLIENT] section of the nucleus.ini file
    3. [NUCLEUS] section of the nucleus.ini file
    4. SAND CDBMS default value.

Commenting Out Lines in the Nucleus.ini File

Any entry in the nucleus.ini file can be commented out, or disabled, by preceding the entry with a pound (#) or semicolon (;) character. When the configuration file is read by the SAND server or other SAND software, everything that follows a comment character on each line will be ignored.

Apart from disabling parameters and sections, the comment characters can also be useful for adding notes or explanatory text to the nucleus.ini file. The presence of such annotations can make it easier for users to "read" a nucleus.ini file.


In the following sample settings, the "Cache=64" entry is commented out using a semicolon (and effectively replaced by "Cache=128" on the next line), while the "MaxDeltaFileSize=0" entry is commented out using a pound symbol. Also, the section is preceded by the commented heading "### test database ###", which gives an indication of the purpose of the database:

### test database ###
[Database ptest]
; Cache=64
# MaxDeltaFileSize=0


Chapter Index
Next Topic:
Nucleus.ini file Parameters - Database Sections