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:

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

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

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

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