dirxconfig

Synopsis

dirxconfig configuration_file |
    -d |
    -? |
    -V

Purpose

Performs the initial configuration of the DBAM database after DirX Directory has been installed.

Arguments

configuration_file

  • Filename of the file that contains the configuration data in the following format:

    • Blank lines and lines starting with the # character are ignored.

    • Each line starts with a key string followed by a colon (:), a SPACE character and the value. The keywords are:

      • Directory completely configured:
        Specify the keyword no. dirxconfing overwrites the keyword no with yes after it successfully configures the database.

      • Profile name: profile_name
        Specify the name of the database profile for profile_name.

      • Number of objects: max_number_of_objects
        Specify the maximum number of objects you plan to save in the database for max_number_of_objects.

      • Mean size of objects: mean_size_of_objects
        Specify the mean size of the objects in KB for mean_size_of_objects. Valid values are:

        • 1 KB

        • 4 KB

        • 16 KB

        • 64 KB

      • Number of indexed attributes: max_number_of_indexes
        Specify the maximum number of attribute indexes you plan for the database for max_number_of_indexes.

      • Device type: device_type
        Specify the keyword file for a file-based database and the keyword partitions for a database using raw devices for device_type.

      • Files or Devices: data_device_name1[;data_device_name2;data_device_name3];transactionLog_device_name
        REAL: data_device_name1,size_of_real_object_blocks
        AVIDX: {data_device_name1|data_device_name2},size_of_attribute_value_index_blocks
        Rest: {data_device_name1|data_device_name2|data_device_name3},size_of_rest
        TRANSlog: transactionLog_device_name,size

        Specify up to three data files or data devices and the transaction log file or device in the format above. Specify each size in MB or GB. (See the section titled The DBAM Storage Model in the Administration Guide for details.)

        The minimum size of the translog device is 256MB. For best performance the size of the translog device should increase with the DBAM cache size and the checkpoint size. A good way to calculate the optimum size is to multiply the DBAM cache size by two (2). A translog device size of 4 GB performs well even for very large DBAM cache sizes (greater than 4 GB).

Here are some examples for a configuration file:

  1. Example of a file-based database on Linux:

    # Example with 2 files for Linux
Directory completely configured: no
Profile name: My-Profile1
Number of objects: 100000
Mean size of objects: 1 KB
Number of indexed attributes: 150
Device type: file
Files or Devices: /opt/dirx/DBAMFiles/DATA1;/opt/dirx/DBAMFiles/TRANS1
REAL: /opt/dirx/DBAMFiles/DATA1,1GB
AVIDX: /opt/dirx/DBAMFiles/DATA1,19GB
Rest: /opt/dirx/DBAMFiles/DATA1,1GB
TRANSLog: /opt/dirx/DBAMFiles/TRANS1,1GB

  2. Example for a database using two partitions on Linux:

    # Example with 2 partitions for Linux
Directory completely configured: no
Profile name: My-Profile1
Number of objects: 100000
Mean size of objects: 1 KB
Number of indexed attributes: 150
Device type: partitions
Files or Devices: /dev/rdsk/DbamDATA;/dev/rdsk/DbamTRANS
REAL: /dev/rdsk/DbamDATA,1GB
AVIDX: /dev/rdsk/DbamDATA,19GB
Rest: /dev/rdsk/DbamDATA,1GB
TRANSLog: /dev/rdsk/DbamTRANS,1GB

You can find more examples in your DirX Directory installation in the directory install_path*/server/conf*.

As an alternative to providing configuration values in the configuration file, DirX supports overriding individual parameters through environment variables. If one or more of the following environment variables are set, their values override (or replace) the corresponding values from the configuration file. If none of the environment variables are set, the current file-based behavior remains unchanged.

The following environment variables are supported:

Environment Variable Description

DIRX_DBAM_PROFILE_NAME

Name of the database profile (corresponds to Profile name: in the configuration file).

DIRX_DBAM_OBJECTS

Maximum number of objects (corresponds to Number of objects:).

DIRX_DBAM_BLOCK_SIZE

Mean size of objects, e.g. 1 KB (corresponds to Mean size of objects:). Valid values: 1 KB, 4 KB, 16 KB, 64 KB.

DIRX_DBAM_INDEX_MAX

Maximum number of attribute indexes (corresponds to Number of indexed attributes:).

DIRX_DBAM_DEVICE_TYPE

Device type: file or partitions (corresponds to Device type:).

DIRX_DBAM_REAL_FILE

Path to the REAL data file (corresponds to the REAL device name in Files or Devices:).

DIRX_DBAM_REAL_SIZE

Size of the REAL data area, e.g. 1GB (corresponds to the REAL size).

DIRX_DBAM_INDEX_FILE

Path to the AVIDX (attribute value index) file (corresponds to the AVIDX device name).

DIRX_DBAM_INDEX_SIZE

Size of the AVIDX area, e.g. 1GB (corresponds to the AVIDX size).

DIRX_DBAM_REST_FILE

Path to the REST data file (corresponds to the REST device name).

DIRX_DBAM_REST_SIZE

Size of the REST area, e.g. 1GB (corresponds to the REST size).

DIRX_DBAM_TRANS_FILE

Path to the transaction log file (corresponds to the TRANSlog device name).

DIRX_DBAM_TRANS_SIZE

Size of the transaction log area, e.g. 1GB (corresponds to the TRANSlog size).

If DIRX_DBAM_DEVICE_TYPE is changed (e.g. from partitions to file or vice versa), the file path variables (DIRX_DBAM_REAL_FILE, DIRX_DBAM_INDEX_FILE, DIRX_DBAM_REST_FILE, DIRX_DBAM_TRANS_FILE) must also be updated to match the new device type. For example, when switching from raw partitions to file-based storage, the paths must point to regular files instead of raw device paths.
Example: Setting environment variables on Linux
export DIRX_DBAM_PROFILE_NAME=default
export DIRX_DBAM_OBJECTS=1000000
export DIRX_DBAM_BLOCK_SIZE="1 KB"
export DIRX_DBAM_INDEX_MAX=150
export DIRX_DBAM_DEVICE_TYPE=file
export DIRX_DBAM_REAL_FILE=/opt/dirx/DBAM/real.dbam
export DIRX_DBAM_REAL_SIZE=1GB
export DIRX_DBAM_INDEX_FILE=/opt/dirx/DBAM/index.dbam
export DIRX_DBAM_INDEX_SIZE=1GB
export DIRX_DBAM_REST_FILE=/opt/dirx/DBAM/rest.dbam
export DIRX_DBAM_REST_SIZE=1GB
export DIRX_DBAM_TRANS_FILE=/opt/dirx/DBAM/trans.dbam
export DIRX_DBAM_TRANS_SIZE=1GB

Options

-d

  • Directs dirxconfig to use the values specified in the default configuration file install_path/server/conf/dirxconfig.cfg.

-?

  • Prints a command usage message.

-V

  • Displays the DirX Directory product version, in the format:

product_version build_id date time

For example:

DirX Directory V9.0 9.4.428 2023:03:23 20:10 64-Bit

Description

The dirxconfig command configures and initializes a DBAM database.

Before you can use dirxconfig, you must:

  • Provide disk space for the database(s).

dirxconfig internally performs the dbamconfig and the dbamboot command with the values specified in the file configuration_file. If you direct dirxconfig to configure a file-based database instead of using raw devices it also performs the dbaminit command.

In the event that a database profile profile_name or any file of a file-based database already exists dirxconfig fails.

dirxconfig writes all status and / or error messages to the file inst_path*/server/conf/dirxconfig.err*. It also directs the internally performed commands dbaminit, dbamconfig and dbamboot to write their messages to this file.

Examples

  1. The following sample command configures the DirX Directory database using the values specified in the default configuration file install_path*/server/conf/dirxconfig.cfg*:

    dirxconfig -d

  2. The following sample command configures the DirX Directory database using the values specified in the file my_configuration.cfg:

    dirxconfig my_configuration.cfg

Exit Codes

The dirxconfig command returns an exit code of 0 on success or 1 if it encountered an error. All status and error messages are written to the file inst_path/server/conf/dirxconfig.err.

See Also

dbamboot, dbamconfig, dbaminit, chapter titled Setting up the DirX Directory Service in the Administration Guide