solidDB Help : solidDB reference : Server-side configuration parameters : General section
  
General section
The following table describes the parameters that can be used in the [General] section of the server-side solid.ini file.
For a description of the access modes, see Access mode and persistence of parameter modifications.
 
[General]
Description
Factory value
Access mode
BackupBlockSize
Block size (in bytes) for backup file writing.
Follow the value with G (to specify a value in GB), K (to specify a value in KB), or M (to specify a value in MB).
For example: BackupBlockSize=64M
A larger blocksize increases performance.
The value of BackupBlockSize must be a multiple of the database block size of the server (defined with the IndexFile.BlockSize parameter), see IndexFile section.
The minimum value is the database block size of the server.
The maximum value is 64M (64MB). If the parameter value exceeds the maximum value, the default value is used.
BackupBlockSize affects both local backup and Hotstandby netcopy performance.
32M
RW/
Startup
BackupCopyIniFile
If set to yes, the solid.ini file is copied to the backup directory.
yes
RW/
Startup
BackupCopyLog
If set to yes, the backup operation copies log files to the backup directory.
yes
RW/
Startup
BackupCopySolmsgOut
If set to yes, the solmsg.out file is copied to the backup directory.
yes
RW/
Startup
BackupDeleteLog
If set to yes on a HotStandby primary server, the primary server keeps all transaction logs since the time that the secondary server became unavailable or since the most recent backup, whichever occurred earlier. Otherwise, if set to yes, old log files are deleted after a backup operation.
If set to no, old log files are kept indefinitely.
yes
RW/
Startup
BackupDirectory
Directory where the backup of the database, log files, and solid.ini file is made.
The backup directory must exist and it must have enough disk space for the backup files. It can be set to any existing directory, except the solidDB database file directory, the log file directory, or the working directory.
All directory definitions are relative to the solidDB working directory unless the full path is provided.
For example:
BackupDirectory=abc (All platforms: backups are created in abc directory under solidDB working directory)
BackupDirectory=C:\backups\abc (Windows only: backups are created in absolute path)
The path must use the conventions of your operating system. For example, in Windows environments, if the path contains white space characters, the path must be enclosed in double quotation marks. If the server runs on a UNIX operating system, path separators must be slashes instead of backslashes.
backup
RW/
Startup
BackupFlushInterval
Maximum number of blocks (pages) that can be stored in memory before they are flushed to disk during backup operation.
100
RW
BackupMemoryUsage
Netcopy buffer size (in bytes) that controls how much data is buffered before writing it to the network.
Follow the value with G (to specify a value in GB), K (to specify a value in KB), or M (to specify a value in MB). For example: BackupMemoryUsage=256M
Maximum value is 1280M.
128M
RW/
Startup
CheckpointDeleteLog
If set to yes, the server deletes the transaction log files after each successful checkpoint. This saves disk space, but makes it impossible to recover data by rolling forward the logs.
You should only set CheckpointDeleteLog to yes if your database has data that you are prepared to lose (for example, test data created during development). See also, BackupDeleteLog.
If you are using HotStandby and CheckpointDeleteLog is set to yes on the primary server, the server deletes only the logs that are already acknowledged by secondary server. For example, if the secondary server is not available and the primary server is in PRIMARY ALONE state, the primary server keeps the logs even after the data has been checkpointed on the primary server.
If LogReader.LogReaderEnabled is set to yes, the CheckpointDeleteLog parameter is not effective: the log files are not deleted after a checkpoint. Instead, the log entries are removed only after the log size defined by LogReader.MaxLogSize is reached.
no
RW/
Startup
CheckpointInterval
Number of log file writes before there is an automatic checkpoint creation.
A large setting can delay checkpoints and make them larger. A small setting guarantees a small checkpoint size.
See also, MinCheckpointTime.
Note CheckpointInterval and MinCheckpointTime use different units of measurement. CheckpointInterval is based on the number of log writes, while MinCheckpointTime specifies the minimum time between consecutive checkpoints.
50000
RW
CompressAllTables
If set to yes, all tables are compressed and compression cannot be disabled by using ALTER TABLE statements.
If set to no, compression can be enabled or disabled for individual tables by using the properties, COMPRESSED and NONCOMPRESSED, with the CREATE TABLE and ALTER TABLE statements, see CREATE TABLE and ALTER TABLE.
no
RW/
Startup
CryptoLibPath
Path and file name of the OpenSSL libcrypto library.
For example: CryptoLibPath=/usr/local/lib/libcrypto.so.1.1.1g.so
The solidDB distribution does not include OpenSSL libraries; you can download the libraries from the following OpenSSL site: wiki.openssl.org/index.php/Binaries.
This parameter is required only if the environment is not set up to locate the OpenSSL libraries in $LD_LIBRARY_PATH (on Linux/UNIX), $LIBPATH on AIX, or %PATH% (on Windows).
If this parameter must be set, then Com.OpenSSLLibPath must also be set, see OpenSSLLibPath.
The path can be an absolute path or relative to the solidDB working directory and must use the conventions of your operating system. For example, in Windows environments, if the path contains white space characters, the path must be enclosed in double quotation marks. If the server runs on a UNIX operating system, path separators must be slashes instead of backslashes.
 
RO
CryptoLoginRequired
If set to yes, passwords are encrypted with OpenSSL when they are sent over a network connection.
You must also set General.UseCryptoLib to yes, and your environment must be configured to locate the OpenSSL libcrypto library, see General.CryptoLibPath.
no
RO
DataDictionaryErrorMaxWait
Time (in seconds) after which the server attempts to reprepare the SQL statement if a “data dictionary operation active” error occurs.
If the SQL statement is still valid, the operation continues without reporting errors to the user.
This parameter should only be enabled when the thread/client mode is used (Srv.ReadThreadMode=2), because the wait time blocks the waiting thread.
0 (disabled)
RW
DDLLockWaitTimeOut
Lock wait timeout (in seconds).
By default, DDL does not use lock wait timeouts and fails immediately if there is a lock conflict.
0
RW/
Startup
DefaultDomainName
(Windows systems only)
Domain name that solidDB uses to resolve two-part user IDs of externally authenticated users. Two-part user IDs are composed of a domain and user name (domain_name\user_name).
If the domain name is specified with the DefaultDomainName parameter, solidDB stores only the user name in SYS_USERS table. Users can also log on to solidDB by using the user name only.
None
RO
DefaultStoreIsMemory
If set to yes, new tables are created as in-memory tables by default.
If set to no, new tables are stored on disk by default. You can override the parameter value for a specific table by using the STORE MEMORY or STORE DISK clause in the CREATE TABLE statement, see CREATE TABLE.
System tables are stored on disk, even if this parameter is set to yes.
yes
RW
DisableIdleMerge
If set to yes, database is set to disable idle merge.
no
RW/
Startup
FileWriteFlushMode
If set to 0 no flushing occurs after write or read operations.
If set to 1 flushing occurs before reading from the file.
If set to 2 flushing occurs after write operations.
platform-specific
(usually 0)
RW/
Startup
HugePageSize
Size of page to use with huge pages allocator on Linux or large pages allocator on Windows.
Huge (or large) pages are used only if a valid value is specified.
On Linux, the value can be 2M (2Mb) or 1G (1Gb) and the MemoryAllocator parameter must be set to mmap.
On Windows, the value must be 2M (2Mb) and the MemoryAllocator parameter must be set to VirtualAlloc.
For more information about using huge or large pages, see Switching memory allocation models.
None
RW/
Startup
InternalCharEncoding
Internal representation for character types.
Possible values are raw or UTF8.
If set to raw, the internal representation for character data types uses no particular encoding; instead, the data is stored in byte strings with the assumption that user applications will handle the conversion as necessary. Wide-character data types are converted between the solidDB server and the application.
If set to UTF8, the internal representation for character data types is UTF-8. Both character data types and wide-character data types are converted between the solidDB server and the application.
raw
RW/
Create
IOThreads
Number of I/O-threads per device.
See also, WriterIOThreads.
8
RW/
Startup
LockHashSize
Number of elements in the hash table.
The server uses a hash table (array) to store lock information. If the size of the array is remarkably underestimated the performance degrades. Too large a hash table does not affect performance directly although it causes memory overhead.
This information is needed when the server is using pessimistic concurrency control (locking). The server uses separate arrays for in-memory tables and disk-based tables. This parameter applies to disk-based tables.
In general, the more locks you need, the larger this array needs to be. However, it can be difficult to calculate the number of locks that you need, so you might need to experiment to find the best value for your applications.
The value that you enter is the number of hash table entries. Each table entry has a size of one pointer (4 bytes in 32-bit architectures). Thus, for example, if you choose a hash table size of 1,000,000, then the amount of memory required is 4,000,000 bytes (assuming 32-bit pointers).
1000000
RW/
Startup
LockWaitTimeout
Time (in seconds) that solidDB waits for a lock to be released.
30
RW
LongSequentialSearchLimit
Boundary (number of matched sequential rows) where a search is considered sequential.
This has an effect on prefetch and space usage.
500
RW/
Startup
MaxOpenFiles
Maximum number of files kept concurrently open.
300000
RW/
Startup
MaxWriteConcurrency
Maximum number of concurrent write operations (update/deletes/insert) performed at a time.
The optimal value depends on the number of available cores (CPUs) and the scattering of updates among different tables. The more cores available and the more scattered the writes are, the higher the optimal value. The value cannot be higher than the number of available cores (CPUs).
A value of 0 means that there is no limit on the number of concurrent writes.
0
RW/
Startup
MemoryAllocator
Memory allocation model for solidDB.
The following values are valid:
malloc (Linux, Windows)
mmap (Linux)
VirtualAlloc (Windows)
For more information about memory allocation models, see Switching memory allocation models.
malloc
RW/
Startup
MemorySegmentSize
(Windows only). The large pages allocator (see MemoryAllocator), requires the value to be a multiple of 2M (2Mb).
When Long MME rows are used, the value must be larger than the length of the longest expected row.
Large pages are used only if a valid value is specified.
None
RW/
Startup
MergeInterval
Number of index inserts made in the database before the merge process starts.
Depends on cache size
RW
MinCheckpointTime
Minimum time (in seconds) between two checkpoint operations.
See also, CheckpointInterval.
Note CheckpointInterval and MinCheckpointTime use different units of measurement: CheckpointInterval is based on the number of log writes, while MinCheckpointTime specifies the minimum time between consecutive checkpoints.
300
RW
MinMergeTime
Minimum time (in seconds) between two merge operations.
For more information about merge operations, see Tuning disk I/O.
0
RW
MultiprocessingLevel
Number of processing units (processors, cores) available in the computer system.
Typically, the concurrency of write operations in the database can be improved if the value matches the number of physical processors (cores) in your system.
The default value is read from the system as the number of logical processing units. The auto-detected value is output to solmsg.out at server startup. With some processor architectures, the number of logical processing units might not be the same as the number of physical cores. In such cases, the optimal value for this parameter typically varies between the number of the physical cores and the number of logical processing units.
The value of the MME.RestoreThreads parameter defaults to the value of this parameter, unless you explicitly set it to a different value.
Read from system
RW/
Startup
NetBackupConnect
Connect string for the NetBackup server.
None
RW/
Startup
NetBackupConnectTimeout
Maximum time (in milliseconds) that a NetBackup operation waits for a connection to a NetBackup server.
For example, to set the timeout to 60 seconds use value 60000.
Specify 0 for no timeout.
30000
RW/
Startup
NetBackupCopyIniFile
If set to yes, the solid.ini configuration file is copied to the remote backup directory.
yes
RW/
Startup
NetBackupCopyLog
If set to yes, the log files are copied to the remote backup directory.
yes
RW/
Startup
NetBackupCopySolmsgOut
If set to yes, the solmsg.out message file is copied to the remote backup directory.
yes
RW/
Startup
NetBackupDeleteLog
If set to yes, the log files that are backed up are deleted from the source server after the NetBackup process is complete.
yes
RW/
Startup
NetBackupDirectory
Path to remote backup directory.
The path expression must be relative to the NetBackup server root backup directory (set by Srv.NetBackupRootDir, see Srv section).
For example, with the following settings:
Srv.NetBackupRootDir=abc\backups
General.NetBackupDirectory=server1
backups for this database are created in the abc\backups\server1 directory.
The path must use the conventions of your operating system. For example, in Windows environments, if the path contains white space characters, the path must be enclosed in double quotation marks. If the server runs on a UNIX operating system, path separators must be slashes instead of backslashes.
None
RW/
Startup
NetBackupReadTimeout
Maximum time (in milliseconds) that any operation waits for the response from the NetBackup server.
For example, to set the timeout to 60 seconds use value 60000 (milliseconds).
30000
RW/
Startup
PAMServiceName
solidDB program name that is used in the pluggable authentication modules (PAM) configuration to define how solidDB users are authenticated, see Operating-system-based external authentication.
This parameter applies to Linux and UNIX systems only.
solid
RO
Pessimistic
If set to yes, the server uses pessimistic concurrency control for D-tables. D-tables use optimistic concurrency control by default.
With pessimistic concurrency control, the server places locks on table rows to control the level of consistency and concurrency when users are submitting queries or updates to rows. For more information, see Pessimistic and optimistic concurrency controls.
You can override this parameter value for a specific table by using the following ALTER TABLE statement:
ALTER TABLE base_table_name SET {OPTIMISTIC | PESSIMISTIC}
no
RW/
Startup
ReadLevelMaxTime
Time (in seconds) that an SQL execute can hold the transaction read level in the READ COMMITTED isolation level until it is released.
10
RW/
Startup
Readonly
If set to yes, the database is set to read-only mode.
You can query the read-only mode of the database by using the ADMIN COMMAND 'getreadonlyflag' command.
no
RW/
Startup
ReportLockManager
If set to yes, lock manager state reporting is included in report output, see REPORT.
no
RW
RunIntegrityTestOnBackup
If set to yes, automated backup integrity verification is enabled.
no
RW/
Startup
RunIntegrityTestOnCheckpoint
If set to yes, automated checkpoint integrity verification is enabled.
no
RW/
Startup
RSAKeySize
Crypto library RSA key size (in bits)
You can set the value to 1024, 2048, or 4096.
1024
RO
SearchBufferLimit
Maximum percentage of search buffers from the total buffered memory reserved for open cursors.
The search buffer contains a local copy of the last B-tree page. Because of this, active searches do not need to go through the index and cache manager to get to the next row in the search. Instead, the searches read the local copy residing in the cache manager. Other searches can also access the page for read-only purposes unless it has been modified by a transaction.
When calculating the buffer limit value, take the approximate number of active searches in the database and multiply it by two. The result is the need for search buffers. After this, you can calculate the suitable percentage from the cache size.
50
RW/
Startup
StartupForceMerge
If set to yes, a merge operation runs when the server is started.
The server accepts no user commands until the merge operation has been completed.
no
RW/
Startup
TableLockWaitTimeout
Time (in seconds) that a transaction waits to get a lock.
When messages are executed in the replica, it is possible to run them in pessimistic or mixed concurrency mode, which means table-level locks are used.
If a transaction acquires an exclusive lock to a table and there is a conflict, the TableLockWaitTimeout setting controls the period that the transaction waits for the exclusive or shared lock to be released. This parameter is used for synchronized databases only.
Table-level locks are used when the PESSIMISTIC keyword is explicitly provided in the following solidDB commands:
IMPORT SUBSCRIPTION
MESSAGE message_name EXECUTE (only with NO EXECUTE option)
MESSAGE message_name FORWARD
MESSAGE message_name GET REPLY
DROP SUBSCRIPTION
See also, LockWaitTimeOut.
30
RW
TransactionEarlyValidate
If set to no, early validation of transactions is not used and each transaction is validated at commit time and not as each statement is written.
Early validation is applicable with optimistic locking only, see Pessimistic and optimistic concurrency controls.
yes
RW/
Startup
TransactionHashSize
Size of the table (number of slots) for open transactions.
The hash table contains slots that are occupied by incomplete (open) transactions. When the number of occupied slots increases, the operations with this table become slower.
The database offers higher performance when the average number of transactions per slot is lower. For example, 5 is a good initial limit for the transaction per slot average.
You can monitor the status of this hash table by using ADMIN COMMAND 'report'. For example:
ADMIN COMMAND 'report myfile.txt'
The output contains the following related information:
tablesize = setting
nused = slots taken from hash table
list length = sum of all transactions in the table
Minimum value is 1000.
1046527
RW/
Startup
UseCryptoLib
If set to yes, OpenSSL encryption is used in the following situations:
to use AES-256 algorithm instead of DES algorithm for database encryption, see Encrypting database and log files,
to enable strong password encryption for internal users (General.CryptoLoginRequired must be set to yes), see Encrypting passwords for solidDB users by using OpenSSL.
to enable external authentication (General.CryptoLoginRequired must be set to yes), see Operating-system-based external authentication.
Your environment must be configured to locate the OpenSSL libcrypto library, see CryptoLibPath.
no
RO
VersionedPessimisticReadCommitted
If set to yes, pessimistic D-tables with READ COMMITTED isolation use versioned reads.
Reads with SELECT FOR UPDATE work as before. In other words, pessimistic D-tables work like M-tables.
yes
RW/
Startup
VersionedPessimisticRepeatableRead
If set to yes, pessimistic D-tables with REPEATABLE READ isolation use versioned reads.
yes
RW/
Startup
WriterIOThreads
Number of helper threads that are dedicated to writing tasks (per IO device).
Note IOThreads must be greater than WriterIOThreads. If this rule is violated, the factory value is used.
If IOThreads=1, then the setting WriterIOThrreads=0 is enforced.
If WriterIOThreads=0, IOThreads handles writing instead.
1
RW/
Startup
Go up to
Server-side configuration parameters