Database Options

Number of parallel archive write threads. Increasing the value is recommended when using high latency storage, which is typical with Cloud storage or a Storage Area Network (SAN).

Amount of time that an Asynchronous SM may delay record version garbage collection to prevent discarding the last consistent state. If this time is exceeded, the Asynchronous SM will log a message and shutdown.

Specifies accepted encryption protocols available for all connections to Transaction Engines (TEs), Administration Processes (APs), and SQL clients. Protocol preference, is defined by the order in which they are listed as comma-separated values. For more information on encryption protocols, see Network Encryption.

Specifies a configuration file to be passed to the TE, SM process. The configuration file can contain any of the options in this table, represented as key/value pairs, where each key is separated from its value with whitespace, and each key/value pair resides on its own line in the file. This configuration file will be passed to all processes (TEs, SMs) in the database. If the configuration file contains any options that might refer to a local directory path, this path must exist on all database hosts.

Specifies a directory in which to place crash reports for NuoDB processes (TEs, SMs). This option is for Linux only. $NUODB_LOGDIR for package installations is /var/log/nuodb and for Tar/Local installations is $NUODB_HOME/var/log.

Disables Stats v3 automatic updates. Statistics will only be updated when an ANALYZE is issued.

For more information, see ANALYZE.

Allows the use of Embedded Java. For more information, see Using the Embedded Java API.

Allows TEs to terminate user queries in order to relieve memory pressure. For more information, see SQL Query Termination.

A list of acceptable ciphers for clients to connect to the database with. The first cipher is the most preferred. Cipher names are case-sensitive and must be entered exactly as shown. The client will supply a list if ciphers it accepts: if no overlap is found the connection will be refused. The full list of available ciphers are: AES-256-CTR, RC4, and None.

Number of threads used when copying atoms during a hot copy operation. For more information on performing hot copy operations, see Backing Up and Restoring Databases.

A message is logged when a disk I/O operation takes longer than the value specified for this option. These log message are prepended with "Slow I/O:…​".

A message is logged, and the process is killed, when a disk I/O operation takes longer than the value specified for this option. This avoids a scenario where the entire database hangs because one disk is not responding.

The maximum number of bytes considered to be a single I/O operation by the underlying storage facility.

Enable journal hot copy on the current SM.
For more information, see Journal Hot Copy.

Sets the maximum number of journal files in a journal sub-directory. A new journal sub-directory is created when the specified limit has been reached.

Specifies the maximum size in bytes of a journal file. However, the journal may write a file larger than the maximum file size if a single compressed journal message is larger than the specified maximum. The journal messages will be appended to the same journal file until the maximum file size is reached.

Specifies the file system synchronization mechanism when the journal needs to ensure the durability of a commit. The synchronization mechanism has been specifically tuned for each supported OS.

If a value is set for jvm-lib, that location is searched first. If jvm-lib is not set, or a JVM is not found in that location, then JAVA_HOME is searched. If JAVA_HOME is not set or a JVM is not found, then:

On Linux: standard paths are searched.

On Windows: the Windows registry is checked and then common paths are checked.

Required for LDAP authentication. Starting point for the LDAP search instead of the default

Example:

ldap-dn 'ou=people,dc=example,dc=com'

Optional. LDAP certificate authority certificate to validate server certificate for ldaps. (Linux only)

Optional. LDAP path to ldap.conf file too use (see man ldap.conf) (Linux only)

Required for LDAP authentication. This, in conjunction with ldap-pass, allows proxy level authentication and the specified account must have search privileges on the ldap-base. It is used to search for the full Distinguished Name (DN) of the user that connects.

Example:

ldap-dn 'cn=manager, ou=people, dc=example, dc=com

Optional. LDAP openldap library name (Linux only)

Required for LDAP authentication. This, in conjunction with ldap-dn, allows proxy level authentication and the specified account must have search privileges on the ldap-base. It is used to search for the full Distinguished Name (DN) of the user that connects.

Required for LDAP authentication. LDAP server type. Only unix or windows is allowed.

Required for LDAP authentication. Specify URI referring to

Example:

'ldap://localhost:389'

the LDAP server(s).

The number of threads the loader will use to load atoms from disk.

Maximum allowed wasted space in one LSA-file before it becomes a candidate for compaction, as a percentage.

Target size of an LSA-file, in bytes.

Maximum allowed wasted space in a catalog’s LSA-map-files before they become candidates for compaction, as a percentage.

Percentage of wasted disk space in Log-Structured Archive (LSA) to trigger the compaction process.

Percentage of wasted disk space in LSA to stop the compaction process.

The number of concurrent client connections a TE will accept.

When starting a TE, use this property to set a specific number of client connections. For more information, see Setting Client Connection Limits for Transaction Engines.

The default (0) allows the TE to accept as many connections as are allowed by the operating system (that is, the same number of sockets that the process can open), minus some reserved for database operations. If the TE cannot accept the number of connections requested (because the operating system does not allow that many open sockets), the TE does not start.

Setting a non-zero value for this startup parameter results in the TE refusing new client connections if the number of current open connections is equal to the value.

Specifies the number of normal garbage collection cycles to every full garbage collection cycle (which is every 1000 seconds). By default, there are 100 normal garbage collection cycles to every full garbage collection cycle. For information on generating index statistics, see ANALYZE.

The number of leader candidates that may be permanently lost (crash and become non-restartable) at a time before durability is compromised. For a database to be available to commit update transactions, max-lost-archives + 1 leader candidates must be running in the system. The default is 0, meaning that the system is resilient to any number of ordinary failures and available for updates as long as at least one leader candidate is running; but, if 1 or more leader candidates is permanently lost then durability may be compromised.

When max-lost-archives > 0, the transaction can fail to commit, and then roll back. But if the whole database fails before the transaction completes roll back, the partially rolled back transaction can be dredged as pre-committed and promoted to committed, thus creating a torn transaction.

Maximum amount of memory (in bytes), that can be used before spill-to-disk, during Stats v3 histogram generation.

The maximum number of unique normalized statement entries stored in the LOCALQUERYPERFORMANCEMETRICS system table.

Sets the maximum amount of memory to be utilized by a database process (in bytes). To specify the amount in kilo-, mega-, giga-, kibi-, mebi-, or gibibytes, suffix the amount with K, M, G, Ki, Mi, or Gi (respectively).

Maximum messages received per second (for testing only)

Port to use for this host, or optionally, a range of port values. By default NuoDB determines the port to be used.

Maximum number of threads to consider for execution on each node, the optimizer may choose to use less threads than this. If set to 1, parallel query execution will be disabled.

Determines the minimum number of rows estimated to be scanned, in both partitioned and non-partitioned tables, before considering parallel execution.

A list of acceptable ciphers for peers to connect to the database with. This includes other SMs or TEs as well as connections to the admin services. The first cipher is the most preferred. Cipher names are case-sensitive and must be entered exactly as shown. The client will supply a list if ciphers it accepts: if no overlap is found the connection is refused. The full list of available ciphers are: AES-256-CTR, RC4, and None.

Normally, processes in the database (TEs, SMs) ping other processes at regular intervals and wait for a response. When network communication with a process times out, the process is evicted from the database by its peers.
Failure detection can be enabled by setting the ping-timeout option, specified in seconds. NuoDB recommends an interval timeout of 60 seconds or greater.
A setting of 0 means wait forever. That is, there is no time out.

Equivalent to the syslog option but for use with the remote-syslog-server option.

Send all logging information to the server at the specified remote host and port number. If not specified, the port number defaults to 514.

Specifies a directory that NuoDB can use for temporary files to facilitate the processing of memory intensive operations.

For SMs, the default value for --scratch-dir is {archive_dir}/nuodbtemp. For TEs, there is no default value.

Sets the maximum size of the scratch-dir (in bytes). To specify the amount in kilo-, mega-, giga-, kibi-, mebi-, or gibibytes, suffix the amount with K, M, G, Ki, Mi, or Gi (respectively).

0 (the default) means that no maximum size of the scratch-dir is enforced by NuoDB.

If any table reaches this cardinality (number of rows), index statistics will cease to be collected automatically for it. Statistics may still be collected manually by issuing the ANALYZE command on the table or any of its indexes. If ANALYZE is issued on the table itself while it is below this cardinality, automatic collection will resume. For more information, see Running ANALYZE to Obtain Index Statistics.

Enable or disable automatic v2 statistics updates.

The query optimizer statistics version.

Enable and configure TCP keepalive on incoming SQL client connections. Format tcpKeepalive TCP_KEEPIDLE:TCP_KEEPCNT:TCP_KEEPINTVL. Example: '60:6:10'.

The number of longest-running statements for which performance metrics are logged during each logging cycle.

The frequency at which performance metrics for the longest-running statements are logged.

A comma-separated list of storage group names that the Asynchronous SM observes, but does not lead. This is controlled by the --passive and --observes options of the nuocmd archive subcommands.

Send logging information to the system log (only if TE or SM is running on a Unix host).

Report logging and other information. This information is captured in the nuoadmin.conf log file.