.
contact contact

B.08.30 / Reference Docs / Utilities / eloqdb.cfg

eloqdb.cfg configuration file

 
.
  The eloqdb.cfg configuration file defines eloqdb configuration and the database environment.

The section names are not case sensitive. String values can be enclosed in double quotes to protect leading or trailing spaces. An unquoted hash character (#) starts a comment.

The following configuration sections are supported:

Server configuration [server]
This section configures various server settings.

Remote access [db-access] [http-access]
These sections may be used to enable or reject access to the database or database http status functions.

Database replication [replication]
This section is used to configure the database replication.

Data base configuration [config]
This section configures the database scalability and behaviour.

Store/Restore targets [Devices]
This section defines the "server devices" which can be used with dbstore and dbrestore.

Forward log [ForwardLog]
This section is used to configure the database forward log and auditing functionality.

Volume files [Volumes]
This section holds a list of data base volumes.

Server configuration [server]

Title
If set, a server title is displayed by the ps program in the eloqdb command line instead of the default "eloqdb: active" If you are using multiple eloqdb server processes on a single system this may be used to distinguish between different server instances. The default value is empty.

Service
The service name (as defined in /etc/services) or the port number where the server should listen for requests. The default value is eloqdb.

A suffix /4, /6, or /46 may be used for establishing IPv4 only, IPv6 (with implied IPv4) or separate IPv4 and IPv6 listening sockets. By default, separate IPv4 and IPv6 sockets are used. For example: eloqdb/46

ServiceHttp
The service name (as defined in /etc/services) or the port number where the server should listen for HTTP requests. If neither ServiceHttp nor ServiceHttps are specified, the HTTP/HTTPS status is disabled.
A suffix may specify support of the IPv4 and IPv6 protocol. By default, separate IPv4 and IPv6 sockets are used.

ServiceHttps
The service name (as defined in /etc/services) or the port number where the server should listen for HTTPS (secure HTTP) requests. If neither ServiceHttp nor ServiceHttps are specified, the HTTP/HTTPS status is disabled.
Enabling the secure HTTP protcol requires that TLS is configured (see TLSCertChainFile and TLSCertKeyFile).
A suffix may specify support of the IPv4 and IPv6 protocol. By default, separate IPv4 and IPv6 sockets are used.

ServiceLocal
The name or path of an AF_Unix socket to be used as an additional method to connect the database server. If not specified the local socket connection is disabled.

Panic (HP-UX, Linux)
This configuration item specifies what should happen if a fatal problem is encountered and eloqdb aborts. The following options are valid:
  • restart - Restart the server process. This is the default.
  • exit - Terminate the process.
  • dump - Terminate the process and create a core dump.

panic = dump is a problem tracking option. Unless you know what you need the coredump for you probably want to stay with "panic = exit" or "panic = restart".

UID (HP-UX and Linux)
The name (or numeric id) of the account to run client processes as when started as root. The default is eloqdb.

Please note, that the server will refuse to start as root unless UID and GID are valid.

GID (HP-UX, Linux)
The name (or numeric id) of the system group to run client processes as when started as root. The default is eloqdb.

Please note, that the server will refuse to start as root unless UID and GID are valid.

EnableIPC (HP-UX and Linux)
If set, shared memory may be used to transmit data between the database server and a client running on the same system. This provides better performance than using sockets because data are not passed through the kernel. The default value is 2 (enabled).

The following options are supported:

EnableIPC = 0
Disables use of shared memory communication.

EnableIPC = 1
Enables use of shared memory communication. This mode uses a separate memory segment for each connection.

EnableIPC = 2 (default, recommended)
Enables use of shared memory communication. This mode uses a common memory segment for all connections.

When using shared memory for communication (EnableIPC other than zero) configuration of kernel parameters may be required.

SyncMode
If set, this causes the eloqdb server to operate in sync write mode. In sync mode committing a transaction makes sure the changes are written to disk.

The sync write mode is more resistant against operating system and hardware failures. When sync mode is disabled (set to 0) the eloqdb uses the faster async write strategy which performs fewer disk writes but could lead to a damaged database environment in case of a system failure. The default value is 1 (sync write mode enabled).

The dbctl syncmode command may be used to change this option dynamically.

LogFile
This defines where log messages are written to. This configuration value either specifies a path/file or one of the keywords below:

  • console - log messages are written to the console
  • syslog - log messages will be sent to the syslog daemon (HP-UX, Linux) or the Windows Event Log.

The default value is "syslog".

The dbctl logfile command may be used to change this option dynamically.

SysIdent (HP-UX, Linux)
SysFacility (HP-UX, Linux)
This may be used to specify the syslog identifier and facility. Supported facility values are: USER/DAEMON/LOCAL0..LOCAL7. The default syslog identifier is "eloqdb". The default syslog facility is "USER". Please refer to syslogd(1M) for more information.

For example:

SysIdent = eloqdb
SysFacility = USER

LogFlags
Each log message has an associated origin and severity. The log flags define which messages are be logged. The "*" origin matches all message origins, so it can be used to setup a default which can be overridden for a specific message origin (e.g. "*1N0"). The default LogFlags are "*0".

The following origin are in use:

  • * = All origins
  • A = Configuration subsystem
  • X = Network transport
  • P = Protocol handling
  • T = Thread kernel
  • I = IMAGE subsystem
  • B = BTREE subsystem
  • F = FIXREC subsystem
  • V = Volume handling
  • L = Transaction logging
  • C = Page cache
  • N = Node handling
  • D = The server framework
  • O = System catalog
  • E = Audit information
  • H = HTTP status
  • R = Volume recovery, Forward Log, Replication
  • K = FTS (keyword) indexing subsystem

The following severities are in use:

  • ERROR = 0 - error messages
  • INFO = 1 - information
  • DEBUG = 2 - debug
  • VDEBUG = 3 - verbose debug

When using syslog, the following priorities are mapped:

  • ERROR = LOG_ERR
  • INFO = LOG_NOTICE
  • DEBUG = LOG_DEBUG
  • VDEBUG = LOG_DEBUG

Enabling log messages with DEBUG or VDEBUG severity may result in a huge number of log messages.
To suppress anything but fatal messages, you can set LogFlags to "*0". To enable informational log messages LogFlags should be set to "*1". To log information on application processes LogFlags should be set to "*1E2".

The dbctl logflags command may be used to change this option dynamically.

LogTimeFmt
Defines the format of the timestamp for log messages written to a log file. Follows strftime conventions.
LogTimeFmt = "%Y-%m-%d %H:%M:%S"

HTTPUser
If set, the eloqdb HTTP status display will require a matching user name (HTTP basic authentication) before allowing access to the eloqdb HTTP status. The default value is empty.

HTTPPswd
If set, the eloqdb HTTP status display will require a matching password (HTTP basic authentication) before allowing access to the eloqdb HTTP status. The default value is empty.

HTTPFrame
If set, no link information is output on the HTTP status display. So the status page could be used in a web frame. Default value is 0.

LoginFailCount1
This specifies the number of failed login attempts before imposing a delay on subsequent login attempts. The default is 0 to disable this function.

LoginFailCount2
This specifies the number of failed login attempts before rejecting subsequent login attempts. The default is 0 to disable this function.

LoginFailTimeout
Number of seconds to remember recently failed login attempts. A previous lockout will also be reset after this time if no further login attempts happened during this period. The default value is 60 seconds.

LoginFailDelay
Number of seconds to delay subsequent login attempts after encountering LoginFailCount1 failures. The default value is 5 seconds.

Statfile
This specifies the output filename the server uses to write statistics information (once per minute). An absolute path name must be specified. If existent, the file must be writable for the eloqdb process.

For example:

StatFile = /var/opt/eloquence/8.3/eloqdb.status
StatFile = C:/Data/Status/eloqdb.status
The dbctl statfile command may be used to change this option dynamically.

StatFileFlags
This specifies options for the StatFile format. By default (StatFileFlags not set) the StatFile content is replaced each time it is updated. The content is formatted with multiple lines.

The following options are available (may be combined):

  • s - (single) causes the values to be formatted into a single line.
  • a - (append) causes new values to be appended to the files instead of replacing the previous content.
  • t - (timezone) causes the timestamp value to recognize the offset for the local timezone

The dbctl statfileflags command may be used to change this option dynamically.

SessionStatFile
Specifies a file name for logging session utilization information. If enabled, the file is written to whenever a session ends or (optionally) after an interval.
An absolute path name must be specified. If existent, the file must be writable for the eloqdb process.

For example:

SessionStatFile = /var/opt/eloquence/8.3/eloqdb.session
SessionStatFile = C:/Data/Status/eloqdb.session

The dbctl sessionstatfile command may be used to change this option dynamically.

SessionStatMode
Specifies a numeric value that defines if/when an entry is logged to the SessionStatFile. The following values are supported:
  • 0 - The SessionStatFile is disabled (default)
  • 1 - A log entry is written to the SessionStatFile when a session ends.

Any other value is understood to specify an interval (in seconds) after which an entry is logged to the SessionStatFile in addition. The specified value must be at least 60 seconds.

For example:

SessionStatMode = 600

The dbctl sessionstatmode command may be used to change this option dynamically.

TLSCertChainFile
Absolute path to a file in PEM format containing the server certificate and optionally any additional intermediate certificates which represent the chain up to the root certificate.
The certificates in this file must be sorted in the verification order, starting with the server certificate. The file may in addition contain the private key associated with the server certificate, in which case the TLSCertKeyFile configuration may be omitted.

Note: TLS (Transport Layer Security) configuration is required to enable the HTTPS (secure HTTP) status (see ServiceHttps above).
To enable HTTPS, a server certificate is needed for the eloqdb host name. Web browsers require a certificate which is issued by a known authority. Using a self-signed certificate typically requires to configure the browsers which are used to access the HTTPS status.

TLSCertKeyFile
Absolute path to a file in PEM format containing the private key associated with the server certificate. If this key is contained in the TLSCertChainFile configuring TLSCertKeyFile is not necessary.

Remote access [db-access] [http-access]

The sections [db-access] and [http-access] may be used to enable or reject access to the database or database http status functions.

The following syntax is supported:

{allow|deny} = {All | ip-address [/ [netmask | addrbits]]}
  • ip-address is a IP v4 address, such as 127.0.0.1.
  • netmask is a IP v4 network mask, such as 255.255.255.0.
  • addrbits specifies the number of bits in the IP address.
If neither netmask nor addrbits is specified it defaults to a host address.

The following defaults are used:

  • If the section [db-access] is not present, access is restricted to 127.0.0.1 (localhost).
  • If the section [http-access] is unconfigured, access is not restricted

For example:

[db-access]
allow = 127.0.0.1

Replication [replication]

This section is used to configure the database replication. The Eloquence database replication documentation provides an in-detail description.

Role
Specifies the role of this server environment. The following values are supported:
  • Standalone (default)
  • Master
  • Slave

Role = Standalone

RedirectWrite
Specifies the master server associated with a slave server. If set, opening a database in write mode is redirected transparently to the specified address.

The format is host:service, where host is the host name or IP address (default: localhost) and service is the service name or port number (default: eloqdb). Either host or :service or both must be specified to enable write mode redirection. By default, write mode redirection is disabled.

RedirectWrite = 10.64.33.45:8102

IgnoreWrite
If set, opening a database in write mode on a slave server is accepted but internally converted into a read-only open mode. This way, a program that opens a database in write mode but only performs read operations may run on a slave server.

The default value is 0, opening a database in write mode on the slave server is not allowed.

Please note: If IgnoreWrite is set, RedirectWrite is disabled implicitly.

IgnoreWrite = 1

TmpDir
Specifies a directory that is used by the slave server as a scratch storage for collecting and processing partial transaction information. By default, the /tmp directory is used. On Windows the system-defined temporary file directory is used by default, for example C:\Windows\Temp.

TmpDir = /tmp
TmpDir = C:\Windows\Temp

Data base configuration [config]

Threads
Number of threads in the data base server. A separate thread is required for each concurrent process connecting to the database server. The default number of threads is 40.
Threads = 100
The value for Threads typically needs to be increased on busy systems. Please make sure the operating system is configured sufficiently to support the number of concurrent connections.

LockConflictingItems
If set, locks with conflicting items are considered non-conflicting and granted. However, any write attempt to data where another process owns a conflicting lock will fail with a status error -12. The default value is 0.

LockConflictingItems = 0

AllowSecondaryBlockingLock
If set, secondary blocking locks are allowed. The default value is 1.

In historic Eloquence versions, secondary locks in a blocking mode (odd modes) failed with a database status -135 ("Secondary lock is not allowed in modes 1,3,5,11,13 and 15.") instead of blocking.
Current Eloquence versions return the database status code -35 if a deadlock situation caused by a secondary blocking lock is detected. Therefore, secondary blocking locks are allowed by default. To retain the behavior of historic Eloquence versions it can be set to 0.

AllowSecondaryBlockingLock = 1

SessionLockLimit
Specifies the max. number of simultaneous DBLOCK requests allowed by an application process. If set to zero, an unlimited number is supported. The default limit is 1000.

This configration is intended to catch application mistakes that could lead to a huge number of outstanding database locks, resulting in concurrency and performance issues. The default value is not expected to affect valid applications.

SessionLockLimit = 1000

BufferCache
Size of the database server page cache in megabytes. The page cache is used to reduce the number of disc accesses. Large cache size will speed up random database access, while a too small cache size may cause bad server performance. The default cache size is 64 MB.
BufferCache = 256
The default value for BufferCache should be increased on busy systems. Please keep in mind that 32 bit eloqdb instances may have limited address space available.

CheckPtFreq
CheckPtSize
The database server performs a checkpoint operation at fixed intervals or when the accumulated log space that could be freed by a checkpoint operation reaches a given threshold.
A checkpoint operation flushes all modified buffers (including meta data) to disk and resets the log of committed transactions. A checkpoint is a point where the server knows all data are in a consistent state. Any data modification since the last checkpoint is recorded in the log volume.

The CheckPtFreq config item specifies the interval (in seconds) at which a checkpoint operation is scheduled. The default checkpoint frequency is 60 seconds.

The CheckPtSize config item specifies the disk space based on accumulated log space which would be freed by a checkpoint (in megabytes). The default checkpoint size is 25 megabytes.

The frequency of the checkpoint operations has a great influence on the size of the log volume since the log volume must hold all committed transactions since between checkpoints

CheckPtFreq = 60
CheckPtSize = 50
The default value for CheckPtFreq is typically fine. The value for CheckPtSize should be increased on busy systems to ensure that checkpoints are not happening too often.

SyncerFreq
The syncer thread flushes modified buffer pages to the disk when they are likely to become reused in the near future.

The SyncerFreq configuration item specifies the interval (in seconds) at which the syncer thread is scheduled. The default interval is 5 seconds.

SyncerFreq = 5

SyncerJournalFlushInterval
If SyncMode is enabled this configuration item specifies the interval (in milliseconds) at which the journal of committed transactions is synchronized to disk.

In case of an operating system or hardware failure transactions that were not synchronized to disk are typically lost.
A smaller value reduces the amount of transactions that might be lost in case of a system crash. However, setting this value too low significantly impacts write performance.

Setting this value to 0 reverts to the legacy SyncMode behavior where every transaction is immediately synchronized. The default value is 500 milliseconds.

SyncerJournalFlushInterval = 500

VolumeFileSizeLimit
This configuration item specifies the max. volume size in MB. The value cannot exceed 128 GB (131072 MB).

In addition the following values are supported.

  • -1 = ~ 2GB (backwards compatible)
  • 0 = 128 GB (unlimited)

The default value is -1 to enable full backwards compatibility.

VolumeFileSizeLimit = 8000

TransactionSizeLimit
This configuration item may be used to limit the max. size of a database transaction in MB. If set to zero, the transaction size is not limited. If set to -1 (the default), the size limit is set to a default value which depends on the configured log volume space. The default value is -1.
TransactionSizeLimit = -1

RestructMemLimit
This configuration item specifies the max. amount of memory (in MB) that may be used temporarily during database restructuring to accelerate index rebuilds (btree and/or FTS). If unspecified (or set to zero) an internal default limit is used. Larger values (such as 300 MB) may noticeably improve rebuild performance.
RestructMemLimit = 300
As of B.08.20 the eloqdb server uses a default RestructMemLimit of 100 MB. The max. RestructMemLimit value is 2047 MB.
Please keep in mind that 32 bit eloqdb instances may have limited address space available, depending on the size of the buffer cache.

AIOThreads
Specifies the number of async I/O threads used by eloqdb. When using Posix AIO (HP-UX IA64) only two I/O threads are required. Otherwise the number of AIOthreads defines the number of concurrent async disk read operations. A zero value disables async I/O.
AIOThreads = 4

Store/Restore targets [Devices]

This section defines the "server devices" which can be used with dbstore and dbrestore. More information is available in the Eloquence database backup documentation.

Each entry consists of a symbolic device name and an associated path. This could either refer to a regular file, a directory or a device. When no server devices are configured, dbstore and dbrestore operation is refused by the server.

The example below defines two server devices. The device "Tape" points to a character device file, the device "Backup" points to a directory which is intended to hold the backup files.

Tape = /dev/rmt/c1t0d0BEST
Backup = /data/backup

Forward log [ForwardLog]

This section is used to configure the database forward log and auditing functionality. The Eloquence database Forward-Logging documentation provides an in-detail description.

FwLog
Configures the file, device or pipe to be used for forward- logging. Using the %N token in the file name activates automatic file management (not possible for devices or pipes). By default, forward-logging is inactive.

The examples below configure an automatically managed file:

FwLog = /data/fwlog/fw-%N.log
Note that as of Eloquence version B.08.30 using a device or pipe as a fwlog target (on HP-UX and Linux) has been obsoleted.

FwArchive
FwArchive may be used to specify a list of directories, separated by a colon (or semicolon on Windows) to hold forward log files in addition to the directory specified in the FwLog config item. By default, FwArchive is not set. This configuration may be used to locate archived forward log files.

FwArchive = /data/archive1:/data/archive2

FwCompress
Numeric flag to specify whether the forward log files are compressed. By default compression is not active.

FwCompress = 1

FwCompressExt
specifies the extra file extension to indicate a compressed file. The default is gz.

FwCompressExt = gz

FwOnFailure
Configures the action to be taken if the forward-log cannot be written, e.g. due to insufficient disk space. Possible values are disable or panic.

  • If set to disable, forward-logging will be disabled on failure. As soon as the problem is solved it can be manually enabled using dbctl.

  • If set to panic, the eloqdb server will panic and abort.

The default value is disable.
FwOnFailure = disable

FwMaxSize
Limits the maximum size of automatically managed forward-log files (in megabytes). If set to zero, the fwlog file is limited to 2 gigabytes. The default value is 0 (not set).
FwMaxSize = 0

EnableAudit
If set to a nonzero value, audit information is written to the forward log in addition to recovery data. The default value is 0 (disabled).
EnableAudit = 1

AuditOnly
If set to a nonzero value, audit information is written to the forward log. However no recovery data is written. The default value is 0 (disabled).
AuditOnly = 0

GroupReadAccess (HP-UX, Linux)
If set to a nonzero value, forward-log files are created with a permission that allows read access to the configured group (as specified with the [Server] GID config item).
If set to zero forward log files are created with a permission that restricts access to the configured owner. The default value is 0 to permit owner access only.
GroupReadAccess = 1

Volume files [Volumes]

This section holds a list of data base volumes. Initially empty. This section is usually filled in by the dbvolcreate and dbvolextend utilities.

For example:

Root = /var/opt/eloquence/db/db01.vol
Log02 = /var/opt/eloquence/db/db02.vol
Vol03 = /var/opt/eloquence/db/db03.vol
Entries in this section may be modified as necessary if the volume files were renamed or moved to a different location.

eloqdb.cfg template file

A default configuration file eloqdb.cfg is installed and may be customized. A template eloqdb config file is installed as newconfig/config/eloqdb.cfg.

# @(#) eloqdb.cfg - B.08.30 ($Revision: 28.7 $)
#
# This file defines the eloqdb configuration and the database
# environment. The default location depends on the operating system:
#
#   HP-UX: /etc/opt/eloquence/8.3/eloqdb.cfg
#   Linux: /etc/opt/eloquence/8.3/eloqdb.cfg
#
# This file is read once at eloqdb startup.
#
# Format:
#
# The section names are not case sensitive. String values can be
# enclosed in double quotes to protect leading or trailing spaces.
# Everything after a hash (#) character is considered a comment.


### Server configuration

[Server]

# Title         If set, a server title is displayed by the ps program
#               in the eloqdb command line instead of the default
#               "eloqdb: active" If you are using multiple eloqdb server
#               processes on a single system this can be used to distinguish
#               between different server instances. The default value is empty.

#Title =

# Service       The service name (as defined in /etc/services)
#               or the port number where the server should listen
#               for requests. The default value is eloqdb.
#
#               A suffix /4, /6, or /46 may be used for establishing IPv4
#               only, IPv6 (with implied IPv4) or separate IPv4 and IPv6
#               listening sockets. By default, separate IPv4 and IPv6
#               sockets are used.
#               For example: eloqdb/46
#
# ServiceHttp   The service name (as defined in /etc/services)
#               or the port number where the server should listen
#               for HTTP requests.
#               If neither ServiceHttp nor ServiceHttps are specified,
#               the HTTP/HTTPS status is disabled.
#               A suffix /4, /6, or /46 may be used (see Service above).
#
# ServiceHttps  The service name (as defined in /etc/services)
#               or the port number where the server should listen
#               for HTTPS (secure HTTP) requests.
#               This requires that TLS is configured (see below).
#               If neither ServiceHttp nor ServiceHttps are specified,
#               the HTTP/HTTPS status is disabled.
#               A suffix /4, /6, or /46 may be used (see Service above).
#
# ServiceLocal  The name or path of an AF_Unix socket to be used as an
#               additional method to connect the database server.
#               If not specified the local socket connection is disabled.

#Service = eloqdb
#ServiceHttp =
#ServiceHttps =
#ServiceLocal =

# UseKeepAlive  Numeric flag if the tcp keep alive socket option is used.
#               Valid values are 1 and 0, the default is 1.
#               If set the operating system may verify if the client is
#               still connected after a system defined time of inactivity.

#UseKeepAlive = 1

# panic         This option defines what should happen if a fatal
#               error is encountered.
#
#               The following options are valid:
#               restart Restart the server process. This is the default.
#               exit    Terminate the process.
#               dump    Terminate the process and create a core dump.
#
#               panic = dump is a problem tracking option. Unless you
#               know what you need the coredump for you probably want
#               to stay with panic = exit or panic = restart

#panic = restart

# UID           The name (or numeric id) of the system account to run
#               client processes as when started as root.
# GID           The name (or numeric id) of the system group to run
#               client processes as when started as root.
#
#               Please note, that the server will refuse to start
#               as root unless UID and GID are valid.

UID = eloqdb
GID = eloqdb

# EnableIPC     If set, shared memory can be used to transmit data
#               between the database server and a client running on
#               the same system. This provides better performance
#               than using sockets because data are not passed through
#               the kernel. The default value is 2 (enabled).
#
#               The following options are supported:
#
#               EnableIPC = 0
#                 Disables use of shared memory communication.
#
#               EnableIPC = 1
#                 Enables use of shared memory communication.
#                 This mode uses a separate memory segment for each
#                 connection.
#
#               EnableIPC = 2 (default, recommended)
#                 Enables use of shared memory communication. This mode
#                 uses a common memory segment for all connections.
#
#               When setting EnableIPC configuration of kernel
#               parameters may be required.

#EnableIPC = 2

# SyncMode      If set, this causes the eloqdb server to operate in sync
#               write mode. The sync write mode is more resistant against
#               operating system and hardware failures. When sync mode is
#               disabled (set to 0) the eloqdb uses the faster async
#               write strategy which performs fewer disk writes but could
#               lead to a damaged database environment in case of a system
#               failure. The default value is 1 (sync write mode enabled).

#SyncMode = 1

# LogFile       This defines where log messages are written to.
#               This configuration value either specifies a path/file
#               or one of the keywords below:
#
#               console  - log messages are written to the console
#               syslog   - log messages will be sent to the
#                          syslog daemon
#
#               The default value is "syslog".

#LogFile = syslog

# SysIdent      When logging to the syslog daemon, you can define
#               a syslog identifier. The default is eloqdb.
#               See syslogd(1M) for more information
#
# SysFacility   When logging to the syslog daemon, you can define
#               a syslog facility (USER/DAEMON/LOCAL0..LOCAL7)
#               The default setting is "USER".
#               See syslogd(1M) for more information

#SysIdent = eloqdb
#SysFacility = USER

# LogFlags      Each log message has an associated origin and
#               severity.
#               The log flags define, which messages will be logged.
#               The "*" origin matches all message origins, so it can
#               be used to setup a default which can be overridden
#               for a specific message origin (eg. "*1N0"):
#               Default LogFlags are "*0"
#
#               The following origin are in use:
#                  * = All origins
#                  A = Configuration subsystem
#                  X = Network transport
#                  P = Protocol handling
#                  T = Thread kernel
#                  I = IMAGE subsystem
#                  B = BTREE subsystem
#                  F = FIXREC subsystem
#                  V = Volume handling
#                  L = Transaction logging
#                  C = Page cache
#                  N = Node handling
#                  D = The server framework
#                  O = System catalog
#                  E = Audit information
#                  H = HTTP status
#                  R = Volume recovery, Forward Log, Replication
#                  K = FTS (keyword) indexing subsystem
#
#               The following severities are in use:
#                  L_ERROR  = 0   - error messages
#                  L_INFO   = 1   - information
#                  L_DEBUG  = 2   - debug
#                  L_VDEBUG = 3   - verbose debug
#
#               When using syslog, the following priorities
#               are mapped:
#                  L_ERROR  = LOG_ERR
#                  L_INFO   = LOG_NOTICE
#                  L_DEBUG  = LOG_DEBUG
#                  L_VDEBUG = LOG_DEBUG
#
#               Enabling log messages with L_DEBUG or L_VDEBUG severity
#               may result in a huge number of log messages.
#               To suppress anything but fatal messages, you can set
#               LogFlags to "*0". To enable informational log messages
#               LogFlags should be set to "*1".  To log information on
#               application processes LogFlags should be set to "*1E2".

#LogFlags = *0

# LogTimeFmt    Defines the format of the timestamp for log messages
#               written to a log file. Follows strftime conventions.

#LogTimeFmt = "%Y-%m-%d %H:%M:%S"

# HTTPUser      The eloqdb server is able to display status information by
#               supporting the HTTP protocol (you can use Netscape to monitor
#               the database server process, see ServiceHttp above).
#               If set, the eloqdb HTTP status display will require a
#               matching user name (HTTP basic authentication) before
#               allowing access to the eloqdb HTTP status. The default value
#               is empty.
#
# HTTPPswd      If set, the eloqdb HTTP status display will require a
#               matching password (HTTP basic authentication) before allowing
#               access to the eloqdb HTTP status. The default value is empty.

#HttpUser =
#HttpPswd =

# HTTPFrame     If set, no link information is output on the HTTP status
#               display. So the status page could be used in a web frame.
#               Default value is 0.

#HttpFrame = 0

# LoginFailCount1    This specifies the number of failed login attempts
#               before imposing a delay on subsequent login attempts.
#               The default is 0 to disable this function.
#
# LoginFailCount2    This specifies the number of failed login attempts
#               before rejecting subsequent login attempts.
#               The default is 0 to disable this function.
#
# LoginFailTimeout   Number of seconds to remember recently failed login
#               attempts. A previous lockout will also be reset after this
#               time if no further login attempts happened during this
#               period. The default value is 60 seconds.
#
# LoginFailDelay      Number of seconds to delay subsequent login attempts
#               after encountering LoginFailCount1 failures. The default
#               value is 5 seconds.

#LoginFailCount1 = 0
#LoginFailCount2 = 0
#LoginFailTimeout = 60
#LoginFailDelay = 5

# Statfile      This specifies the output filename the server uses to
#               write statistics information (once per minute).
#               An absolute path name must be specified. If existent,
#               the file must be writable for the eloqdb process.

#StatFile = /var/opt/eloquence/8.3/eloqdb.status

# StatFileFlags      This specifies options for the StatFile format.
#               By default (StatFileFlags not set) the StatFile content
#               is replaced each time it is updated.  The content is
#               formatted into multiple lines.
#
#               The following options are available (may be combined):
#               s  (single) causes the values to be formatted into
#                  a single line.
#               a  (append) causes new values to be appended to the
#                  files instead of replacing the previous content.
#               t  (timezone) causes the timestamp value to recognize
#                  the offset for the local timezone

#StatFileFlags = ""

# SessionStatFile    Specifies a file name for logging session
#               utilization information. If enabled, the file is written
#               to whenever a session ends or (optionally) after
#               an interval.
#               An absolute path name must be specified. If existent,
#               the file must be writable for the eloqdb process.

#SessionStatFile = /var/opt/eloquence/8.3/eloqdb.session

# SessionStatMode    Specifies a numeric value that defines if/when
#               an entry is logged to the SessionStatFile.
#               The following values are supported:
#               0 - The SessionStatFile is disabled (default)
#               1 - A log entry is written to the SessionStatFile when
#               a session ends.
#
#               Any other value is understood to specify an interval
#               (in seconds) after which an entry is logged to the
#               SessionStatFile in addition. The specified value must
#               be at least 60 seconds.

#SessionStatMode = 0

# TLS (Transport Layer Security) configuration is required to enable
# the HTTPS (secure HTTP) status (see ServiceHttps above).
#
# To enable HTTPS, a server certificate is needed for the eloqdb
# host name. Web browsers require a certificate which is issued
# by a known authority. Using a self-signed certificate typically
# requires to configure the browsers which are used to access the
# HTTPS status.
#
# Using TLS requires that OpenSSL version 0.9.8 or newer is installed.

# TLSCertChainFile   Absolute path to a file in PEM format containing
#               the server certificate and optionally any additional
#               intermediate certificates which represent the chain
#               up to the root certificate.
#               The certificates in this file must be sorted in the
#               verification order, starting with the server certificate.
#               The file may in addition contain the private key
#               associated with the server certificate, in which case
#               the TLSCertKeyFile configuration below can be omitted.

#TLSCertChainFile =

# TLSCertKeyFile     Absolute path to a file in PEM format containing
#               the private key associated with the server certificate.
#               If this key is contained in the TLSCertChainFile above,
#               configuring TLSCertKeyFile is not necessary.

#TLSCertKeyFile =


### Remote access

# The sections [db-access] and [http-access] may be used to enable or
# reject access to the database or database http status functions.
#
# The following syntax is supported:
# {allow|deny} = { All | hostname | ip-address [/{addrbits|netmask]} }
#
# Multiple Allow/Deny entries are recognized and combined.
#
# hostname is the name of a host or network that is resolved into
# one or more ip addresses.
#
# ip-address is either an IPv4 or IPv6 address.
#
# * An IPv6 address, enclosed in square brackets, such as [::1].
# The addrbits option may be used to specify the number of relevant
# bits in the IP address.
#
# * An IPv4 address, such as 127.0.0.1. The addrbits option may be
# used to specify the number of relevant bits in the IP address.
# The netmask option allows to specify an IPv4 network mask,
# such as 255.255.255.0.
#
# The following defaults are used:
# If [db-access] is not present, access is restricted to localhost
# (127.0.0.1 and [::1]).
# If [http-access] is unconfigured, access is not restricted

#[db-access]
#allow = localhost
#deny = all

#[http-access]
#allow = all


### Replication

[Replication]

# Role          Specifies the role of this server environment.
#               The following values are supported:
#               Standalone (the default), Master, Slave

#Role = Standalone

# RedirectWrite      Specifies the master server associated with a
#               slave server. If set, opening a database in write mode
#               is redirected to the specified address.
#               The format is host:service, where host is the host
#               name or IP address (default: localhost) and service is
#               the service name or port number (default: eloqdb).
#               Either host or :service or both must be specified to
#               enable write mode redirection.
#               By default, write mode redirection is disabled.

#RedirectWrite =

# IgnoreWrite   If set, opening a database in write mode on a slave
#               server is accepted but internally converted into a
#               read-only open mode. This way, a program that opens
#               a database in write mode but only performs read
#               operations may run on a slave server.
#               Please note: If IgnoreWrite is set, RedirectWrite is
#               implicitly disabled.
#               The default value is 0, opening a database in write
#               mode on the slave server is not allowed.

#IgnoreWrite = 0

# TmpDir        Specifies a directory that is used by the slave server
#               for temporary files. By default, the /tmp directory is
#               used.

#TmpDir = /tmp


### Data base configuration

[Config]

# Threads       Number of threads in the data base server. A separate
#               thread is required for each client.
#               Default number of threads is 40.

#Threads = 40

# LockConflictingItems              If set, predicate locks with conflicting
#               items are granted, however any write attempt to data where
#               another process owns a lock will result in a status error -12.
#               Former Eloquence revisions rejected a predicate lock with
#               a conflicting item, because this could lead to a situation
#               where two processes own a lock on an overlapping subset of
#               data. The default value is 0.

#LockConflictingItems = 0

# AllowSecondaryBlockingLock        If set, secondary blocking locks are
#               allowed. In previous Eloquence versions, secondary locks in
#               a blocking mode (odd modes) failed with database status -135
#               ("Second lock is not allowed in modes 1,3,5,11,13 and 15.")
#               instead of blocking. Current Eloquence versions return the
#               status code -35 in case a deadlock situation caused by a
#               secondary blocking lock is detected. Therefore, this setting
#               is enabled by default. To retain the behavior of previous
#               Eloquence versions it can be set to 0. The default value is 1.

#AllowSecondaryBlockingLock = 1

# SessionLockLimit   This configuration item specifies the max. number of
#               simultaneous DBLOCK requests by an application for a
#               specific database server. If set to zero, an unlimited
#               number is supported. The default limit is 1000.

#SessionLockLimit = 1000

# BufferCache   Size of page cache in megabytes. The page cache is
#               used to reduce the number of disc accesses. Large cache
#               size will speed up random database access, while a too
#               small cache size may cause bad server performance.
#               Default cache size is 64 MB.

#BufferCache = 64

# The server performs a checkpoint operation at fixed intervals. This
# flushes all modified buffers (including metadata) to the disk and
# resets the log of committed transactions. A checkpoint is a point
# where the server knows all data are in a consistent state. Any data
# modification since the last checkpoint is recorded in the log
# volume.
#
# CheckPtFreq   Checkpoint frequency in seconds.
#               Default checkpoint frequency is 60 seconds.
#
# CheckPtSize   Checkpoint frequency based on accumulated log space
#               which would be freed by a checkpoint (in megabytes).
#               Default checkpoint size is 25 megabytes.
#
# The database server performs a checkpoint operation at a fixed
# interval and optionally in addition when the accumulated log space
# which could be freed by a checkpoint operation reaches a given
# threshold.
# The frequency of the checkpoint operations has a great influence
# on the size of the log volume since the log volume must hold all
# committed transactions since between checkpoints

#CheckPtFreq = 60
#CheckPtSize = 25

# The syncer thread flushes modified buffer pages to the disk when
# they are likely to become reused in the near future.
#
# SyncerFreq    Syncer thread invocation frequency (in seconds)
#               Default interval is 5 seconds.

#SyncerFreq = 5

# SyncerJournalFlushInterval        If SyncMode is enabled this
#               configuration item specifies the interval (in
#               milliseconds) at which the journal of committed
#               transactions is synchronized to disk.
#               In case of an operating system or hardware failure
#               transactions that were not synchronized to disk are
#               typically lost.
#               A smaller value reduces the amount of transactions
#               that might be lost in case of a system crash. However,
#               setting this value too low significantly impacts write
#               performance.
#               Setting this value to 0 reverts to the legacy SyncMode
#               behavior where every transaction is immediately
#               synchronized. The default value is 500 milliseconds.

#SyncerJournalFlushInterval = 500

# VolumeFileSizeLimit          This configuration item specifies
#               the max. volume size in MB. The value cannot exceed
#               128 GB (131072 MB).
#               In addition the following values are supported.
#                -1 = ~ 2GB (backwards compatible)
#                 0 = 128 GB (unlimited)
#
#               The default value is -1 to enable full backwards
#               compatibility.

#VolumeFileSizeLimit = -1

# TransactionSizeLimit         This configuration item may be used to
#               limit the max. size of a database transaction in MB.
#               If set to zero, the transaction size is not limited.
#               If set to -1 (the default), the size limit is set to
#               a default value which depends on the configured log
#               volume space. The default value is -1.

#TransactionSizeLimit = -1

#RestructMemLimit             This configuration item specifies the
#               max. amount of memory (in MB) that may be used
#               temporarily during database restructuring to accelerate
#               index rebuilds (btree and/or FTS).
#               If unspecified (or set to zero) an internal default
#               limit is used. Larger values (such as 300 MB) may
#               noticeably improve rebuild performance.

#RestructMemLimit = 0

# AIOThreads    Specifies the number of async I/O threads used by eloqdb.
#               When using Posix AIO (HP-UX IA64) only two I/O threads
#               are required. Otherwise the number of IOthreads defines
#               the number of concurrent async disk read operations.
#               A zero value disables async I/O.

#AIOThreads = 0

# SessionFtsLimit      The FtsLimit config item may be used to limit the
#               memory allocated for a session to hold FTS results.
#               The numeric value specifies the number of internal results
#               supported.  An additional k or m multiplies this value by
#               1000 or 1 million.  A zero value disables the limit.
#               For example: SessionFtsLimit = 100m

#SessionFtsLimit = 0


### Store/Restore Devices

[Devices]

# This section defines the "server devices" which can be used with dbstore
# and dbrestore. Each entry consists of the device name and an associated path.
#
# A "server device" could either be a single file, a directory or a device.
# When no server devices are configured, dbstore and dbrestore operation is
# refused by the server.
#
# The example below defines two server devices. The device "Tape" points to a
# character device file, the device "Backup" points to a directory which is
# intended to hold the backup files.

#Tape = /dev/rmt/c1t0d0BEST
#Backup = /data/backup


### Forward log

[ForwardLog]

# FwLog         Configures the forward log file. The %N token in the file name
#               is replaced by the forward log file generation and sequence.
#               By default, forward-logging is inactive.
#               If the forward log file is compressed then an .gz extension
#               is added to the forward log file name.

#FwLog = /data/fwlog/fw-%N.log

# FwArchive     FwArchive may be used to specify a list of directories,
#               separated by a colon (or semicolon on Windows) to hold
#               forward log files in addition to the directory specified
#               in the FwLog config item.  By default, FwArchive is not set.
#               This configuration may be used to locate archived forward log
#               files.

#FwArchive = /data/archive1:/data/archive2

# FwCompress    Numeric flag to specify whether the forward log files are
#               compressed. By default compression is not active.

#FwCompress = 0

# FwCompressExt        specifies the extra file extension to indicate a
#              compressed file. The default is gz.

#FwCompressExt = gz

# FwOnFailure   Configures the action to be taken in case the forward-log
#               cannot be written, e.g. due to insufficient disk space.
#               Possible values are disable or panic. If set to disable,
#               forward-logging will be disabled on failure. As soon as the
#               problem is solved it can be manually enabled using dbctl.
#               If set to panic, the eloqdb server will issue a panic and
#               abort itself. The default value is disable.

#FwOnFailure = disable

# FwMaxSize     Limits the maximum size of automatically managed forward-log
#               files (in megabytes). If not set or set to zero, the file
#               size limit is 2 gigabytes. The default value is 0 (not set).

#FwMaxSize = 0

# EnableAudit   If set to a nonzero value, audit information is written
#               to the forward log in addition to recovery data.
#               The default value is 0 (disabled).
#
# AuditOnly     If set to a nonzero value, audit information is written
#               to the forward log. However no recovery data is written.
#               The default value is 0 (disabled).

#EnableAudit = 0
#AuditOnly = 0

# GroupReadAccess   If set to a nonzero value, forward-log files are
#               created with a permission that allows read access to
#               the configured group (as specified with the [Server] GID
#               config item).
#               If set to zero forward log files are created with a
#               permission that restricts access to the configured owner.
#               The default value is 0 to permit owner access only.

#GroupReadAccess = 0


### Data base environment

[Volumes]

# List of data base volumes. Initially empty.
# This is usually filled in by dbvolcreate and dbvolextend utilities

See also

eloqdb


 
 
 
  Privacy | Webmaster | Terms of use | Impressum Revision: 2019-08-28  
  Copyright © 1995-2021 Marxmeier Software AG