Configuration Parameters

OmniSci has minimal configuration requirements with a number of additional configuration options. This topic describes the required and optional configuration changes you can use in your OmniSci instance.

In release 4.5.0 and higher, OmniSci requires that all configuration flags used at startup match a flag on the OmniSci server. If any flag is misspelled or invalid, the server does not start. This helps ensure that all settings are intentional and will not have unexpected impact on performance or data integrity.

Data Directory

Before starting the OmniSci server, you must initialize the persistent data directory. To do so, create an empty directory at the desired path, such as /var/lib/omnisci. Create the environment variable $OMNISCI_STORAGE.

export OMNISCI_STORAGE=/var/lib/omnisci

Change the owner of the directory to the user that the server will run as ($OMNISCI_USER):

sudo mkdir -p $OMNISCI_STORAGE
sudo chown -R $OMNISCI_USER $OMNISCI_STORAGE

Where $OMNISCI_USER is the system user account that the server runs as, such as omnisci, and $OMNISCI_STORAGE is the path to the parent of the OmniSci server data directory.

Finally, run $OMNISCI_PATH/bin/initdb with the data directory path as the argument:

$OMNISCI_PATH/bin/initdb $OMNISCI_STORAGE

Configuring a Custom Immerse Subdirectory

Immerse serves the application from the root path (/) by default. To serve the application from a sub-path, you must modify the $OMNISCI_PATH/frontend/app-config.js file to change the IMMERSE_PATH_PREFIX value. The Immerse path must start with a forward slash (/).

Configuration File

The configuration file stores runtime options for your OmniSci servers. You can use the file to change default behavior.

The omnisci.conf file is stored in the $OMNISCI_STORAGE directory. The configuration settings are picked up automatically by the sudo systemctl start omnisci_server and sudo systemctl start omnisci_web_server commands.

Set the flags in the configuration file using the format <flag> = <value>. Strings must be enclosed in quotes.

The following is a sample configuration file. The entry for data path is a string and must be in quotes. The last entry in the first section, for null-div-by-zero, is the Boolean value true and does not require quotes.

port = 6274
http-port = 6278
data = "/var/lib/omnisci/data"
null-div-by-zero = true
[web]
port = 6273
frontend = "/opt/omnisci/frontend"
servers-json = "/var/lib/omnisci/servers.json"
enable-https = true

To comment out a line in omnisci.conf, prepend the line with the pound sign (#) character.

For encrypted backend connections, if you do not use a configuration file to start the database, Calcite expects passwords to be supplied through the command line, and calcite passwords will be visible in the processes table. If a configuration file is supplied, then passwords must be supplied in the file. If they are not, Calcite will fail.

Configuration Parameters for OmniSciDB

Following are the parameters for runtime settings on OmniSciDB. The parameter syntax provides both the implied value and the default value as appropriate. Optional arguments are in square brackets, while implied and default values are in parentheses.

For example, consider allow-loop-joins [=arg(=1)] (=0).

  • If you do not use this flag, loop joins are not allowed by default.

  • If you provide no arguments, the implied value is 1 (true) (allow-loop-joins).

  • If you provide the argument 0, that is the same as the default (allow-loop-joins=0).

  • If you provide the argument 1, that is the same as the implied value (allow-loop-joins=1).

Flag

Description

Default Value

allow-cpu-retry [=arg]

Allow the queries that failed on GPU to retry on CPU, even when watchdog is enabled. When watchdog is enabled, most queries that run on GPU and throw a watchdog exception fail. Turn this on to allow queries that fail the watchdog on GPU to retry on CPU. The default behavior is for queries that run out of memory on GPU to throw an error if watchdog is enabled. Watchdog is enabled by default.

TRUE[1]

allow-local-auth-fallback [=arg(=1)] (=0)

If SAML or LDAP logins are enabled, and the logins fail, this setting enables authentication based on internally stored login credentials. Command-line tools or other tools that do not support SAML might reject those users from logging in unless this feature is enabled. This allows a user to log in using credentials on the local database.

FALSE[0]

allow-loop-joins [=arg(=1)] (=0)

Enables all join queries to fall back to the loop join implementation. During a loop join, queries loop over all rows from all tables involved in the join, and evaluate the join condition. By default, loop joins are only allowed if the number of rows in the inner table is fewer than the trivial-loop-join-threshold, since loop joins are computationally expensive and run for an extended period. Modifying the trivial-loop-join-threshold is a safer alternative to globally enabling loop joins. You might choose to globally enable loop joins when you have many small tables for which loop join performance has been determined to be acceptable but modifying the trivial join loop threshold would be tedious.

FALSE[0]

allowed-export-paths = [path1, path2, ...]

Specify a list of allowed root paths that can be used in the COPY TO command; for example:

allowed-export-paths = ["root_path_1", "root_path_2"] The list of paths has to be on the same line as the configuration parameter.

If a user attempts to use a non-whitelisted path in a COPY TO command, an error response is returned.

N/A

allowed-import-paths = [path1, path2, ...]

Specify a list of allowed root paths that can be used in the COPY FROM command; for example:

allowed-import-paths = ["root_path_1", "root_path_2"] The list of paths must be on the same line as the configuration parameter.

If a user attempts to use a non-whitelisted path in a COPY FROM command, an error response is returned.

N/A

bigint-count [=arg]

Use 64-bit count. Disabled by default because 64-bit integer atomics are slow on GPUs. Enable this setting if you see negative values for a count, indicating overflow. In addition, if your data set has more than 4 billion records, you likely need to enable this setting.

FALSE[0]

calcite-max-mem arg

Max memory available to calcite JVM. Change if Calcite reports out-of-memory errors.

1024

calcite-port arg

Calcite port number. Change to avoid collisions with ports already in use.

6279

calcite-service-timeout

Service timeout value, in milliseconds, for communications with Calcite. On databases with large numbers of tables, large numbers of concurrent queries, or many parallel updates and deletes, Calcite might return less quickly. Increasing the timeout value can prevent THRIFT_EAGAIN timeout errors.

5000

config arg

Path to omnisci.conf. Change for testing and debugging.

$OMNISCI_STORAGE/ omnisci.conf

cpu-only

Run in CPU-only mode. Set this flag to force OmniSciDB to run in CPU mode, even when GPUs are available. Useful for debugging and on shared-tenancy systems where the current OmniSciDB instance does not need to run on GPUs.

FALSE

cpu-buffer- mem-bytes arg

Size of memory reserved for CPU buffers [bytes]. Change to restrict the amount of CPU/system memory OmniSciDB can consume. A default value of 0 indicates no limit on CPU memory use. (OmniSci Server uses all available CPU memory on the system.)

0

cuda-block-size arg

Size of block to use on GPU. GPU performance tuning: Number of threads per block. Default of 0 means use all threads per block.

0

cuda-grid-size arg

Size of grid to use on GPU. GPU performance tuning: Number of blocks per device. Default of 0 means use all available blocks per device.

0

data arg

Directory path to OmniSci catalogs. Change for testing and debugging.

$OMNISCI_STORAGE

db-query-list arg

Path to file containing OmniSci queries. Use a query list to autoload data to GPU memory on startup to speed performance. See Preloading Data.

N/A

dynamic-watchdog-time-limit [=arg]

Dynamic watchdog time limit, in milliseconds. Change if dynamic watchdog is stopping queries expected to take longer than this limit.

100000

enable-auto-clear-render-mem [=arg]

Enable/disable clear render gpu memory on out-of-memory errors during rendering. If an out-of-gpu-memory exception is thrown while rendering, many users respond by running \clear_gpu via the omnisql command-line interface to refresh/defrag the memory heap. This process can be automated with this flag enabled. At present, only GPU memory in the renderer is cleared automatically.

TRUE[1]

enable-columnar-output [=arg]

Allows OmniSci Core to directly materialize intermediate projections and the final ResultSet in Columnar format where appropriate. Columnar output is an internal performance enhancement that projects the results of an intermediate processing step in columnar format. Consider disabling this feature if you see unexpected performance regressions in your queries.

TRUE[1]

enable-debug-timer [=arg]

Enable fine-grained query execution timers for debug. For debugging, logs verbose timing information for query execution (time to load data, time to compile code, and so on).

FALSE[0]

enable-direct-columnarization [=arg(=1)](=0)

Columnarization organizes intermediate results in a multi-step query in the most efficient way for the next step in the process. If you see an unexpected performance regression, you can try setting this value to false, enabling the earlier OmniSci columnarization behavior.

TRUE[1]

enable-dynamic-watchdog [=arg]

Enable dynamic watchdog.

FALSE[0]

enable-filter-push-down [=arg(=1)] (=0)

Enable filter push-down through joins. Evaluates filters in the query expression for selectivity and pushes down highly selective filters into the join according to selectivity parameters. See also What is Predicate Pushdown?

FALSE[0]

enable-overlaps-hashjoin [=arg(=1)] (=0)

Enable the overlaps hash join framework allowing for range join (for example, spatial overlaps) computation using a hash table.

FALSE[0]

enable-runtime-query-interrupt [=arg(=1)] (=0)

Enable the runtime query interrupt. Enables runtime query interrupt. Setting to TRUE can reduce performance slightly. Use with runtime-query-interrupt-frequency to set the interrupt frequency.

FALSE[0]

enable-runtime-udf

Enable runtime user defined function registration. Enables runtime registration of user defined functions. This functionality is turned off unless you specifically request it, to prevent unintentional inclusion of nonstandard code. This setting is a precursor to more advanced object permissions planned in future releases.

FALSE[0]

enable-spirv

[DEPRECATED] Enable SPIR-V (Standard Portable Intermediate Representation) for renderer shaders. When disabled, OmniSci uses legacy GLSL (OpenGL Shading Language) shaders. Disable to troubleshoot SPIR-V compilation errors.

TRUE[1]

enable-string-dict-hash-cache[=arg(=1)] (=0)

This flag is FALSE by default to avoid some hash re-computation and string comparisons during bulk imports and String Dictionary queries. When importing a large table with low cardinality, set the flag to TRUE and leave it on to assist with bulk queries. If using String Dictionary Server, set the flag to FALSE if the String Dictionary server uses more memory than the physical system can support.

FALSE[0]

enable-thrift-logs [=arg(=1)] (=0)

Enable writing messages directly from Thrift to stdout/stderr. Change to enable verbose Thrift messages on the console.

FALSE[0]

enable-watchdog [arg]

Enable watchdog.

TRUE[1]

filter-push-down-low-frac

Higher threshold for selectivity of filters which are pushed down. Filters with selectivity lower than this threshold are considered for a push down.

filter-push-down-passing-row-ubound

Upper bound on the number of rows that should pass the filter if the selectivity is less than the high fraction threshold.

flush-log [arg]

Immediately flush logs to disk. Set to FALSE if this is a performance bottleneck.

TRUE[1]

from-table-reordering [=arg(=1)] (=1)

Enable automatic table reordering in FROM clause. Reorders the sequence of a join to place large tables on the inside of the join clause and smaller tables on the outside. OmniSci also reorders tables between join clauses to prefer hash joins over loop joins. Change this value only in consultation with an OmniSci engineer.

TRUE[1]

gpu-buffer-mem-bytes [=arg]

Size of memory reserved for GPU buffers in bytes per GPU. Change to restrict the amount of GPU memory OmniSciDB can consume per GPU. A default value of 0 indicates no limit on GPU memory use (OmniSciDB uses all available GPU memory across all active GPUs on the system).

0

gpu-input-mem-limit arg

Force query to CPU when input data memory usage exceeds this percentage of available GPU memory. OmniSciDB loads data to GPU incrementally until data exceeds GPU memory, at which point the system retries on CPU. Loading data to GPU evicts any resident data already loaded or any query results that are cached. Use this limit to avoid attempting to load datasets to GPU when they obviously will not fit, preserving cached data on GPU and increasing query performance. If watchdog is enabled and allow-cpu-retry is not enabled, the query fails instead of re-running on CPU.

0.9

hll-precision-bits [=arg]

Number of bits used from the hash value used to specify the bucket number. Change to increase or decrease approx_count_distinct() precision. Increased precision decreases performance.

11

http-port arg

HTTP port number. Change to avoid collisions with ports already in use.

6278

idle-session-duration arg

Maximum duration of an idle session, in minutes. Change to increase or decrease duration of an idle session before timeout.

60

inner-join-fragment-skipping [=arg(=1)] (=0)

Enable or disable inner join fragment skipping. Enables skipping fragments for improved performance during inner join operations.

FALSE[0]

license arg

Path to the file containing the license key. Change if your license file is in a different location or has a different name.

log-auto-flush

Flush logging buffer to file after each message. Changing to false can improve performance, but log lines might not appear in the log for a very long time. OmniSci does not recommend changing this setting.

TRUE[1]

log-directory arg

Path to the log directory. Can be either a relative path to the $OMNISCI_STORAGE/data directory or an absolute path. Use this flag to control the location of your OmniSci log files. If the directory does not exist, OmniSci creates the top level directory. For example, a/b/c/logdir is created only if the directory path a/b/c already exists.

/var/lib/omnisci/ data/mapd_log

log-file-name

Boilerplate for the name of the OmniSci log files. You can customize the name of your OmniSci log files. {SEVERITY} is the only braced token recognized. It allows you to create separate files for each type of error message greater than or equal to the log-severity configuration option.

omnisci_server.{SEVERITY}. %Y%m%d-%H%M%S.log

log-max-files

Maximum number of log files to keep. When the number of log files exceeds this number, OmniSci automatically deletes the oldest files.

100

log-min-free-space

Minimum number of bytes left on device before oldest log files are deleted. This is a safety feature to be sure the disk drive of the log directory does not fill up, and guarantees that at least this many bytes are free.

20971520

log-rotation-size

Maximum file size in bytes before new log files are started. Change to increase/decrease size of files. If log files fill quickly, you might want to increase this number so that there are fewer log files.

10485760

log-rotate-daily

Start new log files at midnight. Set to false to write to log files until they are full, rather than restarting each day.

TRUE[1]

log-severity

Log to file severity levels:

DEBUG4

DEBUG3

DEBUG2

DEBUG1

INFO

WARNING

ERROR

FATAL

All levels after your chosen base severity level are listed. For example, if you set the severity level to WARNING, OmniSci only logs WARNING, ERROR, and FATAL messages.

INFO

log-severity-clog

Log to console severity level: INFO WARNING ERROR FATAL. Output chosen severity messages to STDERR from running process.

WARNING

log-symlink

Symbolic link to the active log. Creates a symbolic link for every severity greater than or equal to the log-severity configuration option.

omnisci_server. {SEVERITY}.log

max-session-duration arg

Maximum duration of the active session, in minutes. Change to increase or decrease session duration before timeout.

43200 (30 days)

null-div-by-zero [=arg]

Allows processing to complete when when the dataset would cause a divide by zero error. Set to TRUE if you prefer to return null when dividing by zero, and set to FALSE to throw an exception.

FALSE[0]

num-gpus arg

Number of GPUs to use. In a shared environment, you can assign the number of GPUs to a particular application. The default, -1, uses all available GPUs. Use in conjunction with start-gpu.

-1

num-reader-threads arg

Number of reader threads to use. Drop the number of reader threads to prevent imports from using all available CPU power. Default is to use all threads.

0

overlaps-bucket- threshold arg

The minimum size of a bucket corresponding to a given inner table range for the overlaps hash join.

-p | port int

OmniSciDB server port. Change to avoid collisions with other services if 6274 is already in use.

6274

pki-db-client-auth [=arg]

Attempt authentication of users through a PKI certificate. Set to TRUE for the server to attempt PKI authentication.

FALSE[0]

read-only [=arg(=1)]

Enable read-only mode. Prevents changes to the dataset.

FALSE[0]

render-mem-bytes arg

Size of memory reserved for rendering, in bytes. Performed at startup on each configured GPU, is static, and persists while the server is running unless you run \clear_gpu_memory. Increase if rendering a large number of points or symbols and you have get the following out-of-memory exception: Not enough OpenGL memory to render the query results Default is 500 MB.

500000000

render-oom-retry-threshold = arg

A render execution time limit in milliseconds to retry a render request if an out-of-gpu-memory error is thrown. Requires enable-auto-clear-render-mem = true. If enable-auto-clear-render-mem = true, a retry of the render request can be performed after an out-of-gpu-memory exception. A retry only occurs if the first run took less than the threshold set here (in milliseconds). The retry is attempted after the render gpu memory is automatically cleared. If an OOM exception occurs, clearing the memory might get the request to succeed. Providing a reasonable threshold might give more stability to memory-constrained servers w/ rendering enabled. Only a single retry is attempted. A value of 0 disables retries.

render-poly-cache-bytes arg

Size of memory reserved for polygon rendering, in bytes. NOTE: This option is deprecated in Release 5.2 and will be removed in a later release. Limits the maximum size of the polygon render cache. Use to improve polygon rendering performance from frame to frame when rendering the same query. Complex queries are often used with polygon rendering, such as choropleths that use expensive joins and aggregates. Processing time required to build polygon buffers for rendering can be expensive.In contrast to render-mem-bytes, no allocation is performed at startup. If no polygon rendering is performed, no allocations are executed that count toward this limit. Polygon buffer allocations are performed dynamically when requested. If the query results and polygon buffer sizes exceed the limit of the cache, the render can still be executed as long as sufficient GPU memory is available. However, you may see performance degredation from frame to frame; if so, consider increasing this cache size. The INFO log can provide information about the optimal setting. For example, if you see a log message like the following, you can extract the size in bytes to render a specific query and adjust this setting accordingly: Cannot cache <size of all polygon render buffers> bytes (<size of polygon coordinate buffer> for vbo/ibo) for poly query: &lquery str> on gpu <gpu id>. There is currently <current size of poly cache> of <max size of poly cache> total bytes used in the poly cache. Default is 300 MB.

300000000

rendering [=arg]

Enable or disable backend rendering. Disable rendering when not in use, freeing up memory reserved by render-mem-bytes. To reenable rendering, you must restart OmniSci Server.

TRUE[1]

res-gpu-mem =arg

Reserved memory for GPU. Reserves extra memory for your system (for example, if the GPU is also driving your display, such as on a laptop or single-card desktop). OmniSci uses all the memory on the GPU except for render-mem-bytes + res-gpu-mem. All of render-mem-bytes is allocated at startup. Also useful if other processes, such as a machine-learning pipeline, share the GPU with OmniSci. In advanced rendering scenarios or distributed setups, increase to free up additional memory for the renderer, or for aggregating results for the renderer from multiple leaf nodes.

134217728

runtime-query-interrupt-frequency [=arg]

Set the amount of time pending queries are in the queue before they are killed, in milliseconds. Use to set the frequency with which pending queries are removed. By default, pending queries are checked every second (1000 milliseconds). Decreasing the value increases the speed with which pending queries are removed, but also increases resource usage.

1000

seek-kafka-commit = <N>

Set the offset of the last Kafka message to be committed from a Kafka data stream. Set the offset of the last Kafka message to be committed from a Kafka data stream. This way, Kafka does not resend those messages. After the Kafka server commits messages through the number N, it resends messages starting at message N+1. This is particularly useful when you want to create a replica of the OmniSci server from an existing data directory.

N/A

ssl-cert path

Path to the server's public PKI certificate (.crt file). Define the path the the .crt file. Used to establish an encrypted binary connection.

ssl-keystore path

Path to the server keystore. Used for an encrypted binary connection. The path to Java trust store containing the server's public PKI key. Used by OmniSciDB to connect to the encrypted Calcite server port.

ssl-keystore-password password

The password for the SSL keystore. Used to create a binary encrypted connection to the Calcite server.

ssl-private-key path

Path to the server's private PKI key. Define the path to the OmniSci server PKI key. Used to establish an encrypted binary connection.

ssl-trust-ca path

Enable use of CA-signed certificates presented by Calcite. Defines the file that contains trusted CA certificates. This information enables the server to validate the TCP/IP Thrift connections it makes as a client to the Calcite server. The certificate presented by the Calcite server is the same as the certificate used to identify the database server to its clients.

ssl-trust-ca-server path

Path to the file containing trusted CA certificates; for PKI authentication. Used to validate certificates submitted by clients. If the certificate provided by the client (in the password field of the connect command) was not signed by one of the certificates in the trusted file, then the connection fails. PKI authentication works only if the server is configured to encrypt connections via TLS. The common name extracted from the client certificate is used as the name of the user to connect. If this name does not already exist, the connection fails. If LDAP or SAML are also enabled, the servers fall back to these authentication methods if PKI authentication fails. Currently works only with JDBC clients. To allow connection from other clients, set allow-local-auth-fallback or add LDAP/SAML authentication.

ssl-trust-password password

The password for the SSL trust store. Password to the SSL trust store containing the server's public PKI key. Used to establish an encrypted binary connection.

ssl-trust-store path

The path to Java trustStore containing the server's public PKI key. Used by the Calcite server to connect to the encrypted OmniSci server port, to establish an encrypted binary connection.

start-gpu arg

First GPU to use. Used in shared environments in which the first assigned GPU is not GPU 0. Use in conjunction with num-gpus.

FALSE[0]

trivial-loop-join-threshold [=arg]

The maximum number of rows in the inner table of a loop join considered to be trivially small.

1000

Additional Enterprise Edition Parameters

Flag

Description

Default Value

cluster arg

Path to data leaves list JSON file. Indicates that the OmniSci server instance is an aggregator node, and where to find the rest of its cluster. Change for testing and debugging.

$OMNISCI_STORAGE

compression-limit-bytes [=arg(=536870912)] (=536870912)

Compress result sets that are transferred between leaves. Minimum length of payload above which data is compressed.

536870912

compressor arg (=lz4hc)

Compressor algorithm to be used by the server to compress data being transferred between server. See Data Compression for compression algorithm options.

lz4hc

ldap-dn arg

LDAP Distinguished Name.

ldap-role-query-regex arg

RegEx to use to extract role from role query result.

ldap-role-query-url arg

LDAP query role URL.

ldap-superuser-role arg

The role name to identify a superuser.

ldap-uri arg

LDAP server URI.

leaf-conn-timeout [=arg]

Leaf connect timeout, in milliseconds. Increase or decrease to fail Thrift connections between OmniSciDB instances more or less quickly if a connection cannot be established.

20000

leaf-recv-timeout [=arg]

Leaf receive timeout, in milliseconds. Increase or decrease to fail Thrift connections between OmniSciDB instances more or less quickly if data is not received in the time allotted.

300000

leaf-send-timeout [=arg]

Leaf send timeout, in milliseconds. Increase or decrease to fail Thrift connections between OmniSciDB instances more or less quickly if data is not sent in the time allotted.

300000

saml-metadata-file arg

Path to identity provider metadata file.

Required for running SAML. An identity provider (like Okta) supplies a metadata file. From this file, OmniSci uses:

  1. Public key of the identity provider to verify that the SAML response comes from it and not from somewhere else.

  2. URL of the SSO login page used to obtain a SAML token.

saml-sp-target-url arg

URL of the service provider for which SAML assertions should be generated. Required for running SAML. Used to verify that a SAML token was issued for OmniSci and not for some other service.

saml-sync-roles arg (=0)

Enable mapping of SAML groups to OmniSci roles. The SAML Identity provider (for example, Okta) automatically creates users at login and assigns them roles they already have as groups in SAML.

saml-sync-roles [=0]

string-servers arg

Path to string servers list JSON file. Indicates that OmniSciDB is running in distributed mode and is required to designate a leaf server when running in distributed mode.

Configuration Parameters for OmniSci Web Server

Flag

Description

Default

allow-any-origin

Allows for a CORS exception to the same-origin policy. Required to be true if Immerse is hosted on a different domain or subdomain hosting omnisci_web_server and omnisci_server.

Allowing any origin is a less secure mode than what omnisci_web_server requires by default.

--allow-any-origin = false

-b | backend-url string

URL to http-port on omnisci_server. Change to avoid collisions with other services.

http://localhost:6278

cert string

Certificate file for HTTPS. Change for testing and debugging.

cert.pem

-c | config string

Path to OmniSci configuration file. Change for testing and debugging.

-d | data string

Path to OmniSci data directory. Change for testing and debugging.

data

db-query-list <path-to-query-list-file>

Preload data to memory based on SQL queries stored in a list file. Automatically run queries that load the most frequently used data to enhance performance. See Pre-loading Data.

n/a

docs string

Path to documentation directory. Change if you move your documentation files to another directory.

docs

enable-cert-verification

TLS certificate verification is a security measure that can be disabled for the cases of TLS certificates not issued by a trusted certificate authority. If using a locally or unofficially generated TLS certificate to secure the connection between omnisci_server and omnisci_web_server, this parameter must be set to false. omnisci_web_server expects a trusted certificate authority by default.

--enable-cert-verification = true

enable-https

Enable HTTPS support. Change to enable secure HTTP.

enable-https-redirect [=arg]

Enable a new port that omnisci_web_server listens on for incoming HTTP requests. When received, it returns a redirect response to the HTTPS port and protocol, so that browsers are immediately and transparently redirected. Use to provide an OmniSci front end that can run on both the HTTP protocol (http://my-omnisci-frontend.com) on default HTTP port 80, and on the primary HTTPS protocol (https://my-omnisci-frontend.com) on default https port 443, and have requests to the HTTP protocol automatically redirected to HTTPS. Without this, requests to HTTP fail. Assuming omnisci_web_server can attach to ports below 1024, the configuration would be: enable-https-redirect = TRUE http-to-https-redirect-port = 80

FALSE[0]

-f | frontend string

Path to frontend directory. Change if you move the location of your frontend UI files.

frontend

http-to-https-redirect-port = arg

Configures the http (incoming) port used by enable-https-redirect. The port option specifies the redirect port number. Use to provide an OmniSci front end that can run on both the HTTP protocol (http://my-omnisci-frontend.com) on default HTTP port 80, and on the primary HTTPS protocol (https://my-omnisci-frontend.com) on default https port 443, and have requests to the HTTP protocol automatically redirected to HTTPS. Without this, requests to HTTP fail. Assuming omnisci_web_server can attach to ports below 1024, the configuration would be: enable-https-redirect = TRUE http-to-https-redirect-port = 80

6280

jwt-key-file

Path to a key file for client session encryption.

The file is expected to be a PEM-formatted ( .pem ) certificate file containing the unencrypted private key in PKCS #1, PCKS #8, or ASN.1 DER form.

Example PEM file creation using OpenSSL.

Required only if using a high-availability server configuration or another server configuration that requires an instance of Immerse to talk to multiple omnisci_web_server instances.

Each omnisci_web_server instance needs to use the same encryption key to encrypt and decrypt client session information which is used for session persistence ("sessionization") in Immerse.

key string

Key file for HTTPS. Change for testing and debugging.

key.pem

max-tls-version

Refers to the version of TLS encryption used to secure web protocol connections. Specifies a maximum TLS version.

min-tls-version

Refers to the version of TLS encryption used to secure web protocol connections. Specifies a minimum TLS version.

--min-tls-version = VersionTLS12

-p | port int

Frontend server port. Change to avoid collisions with other services.

6273

-r | read-only

Enable read-only mode. Prevent changes to the data.

servers-json string

Path to servers.json. Change for testing and debugging.

timeout duration

Maximum request duration in #h#m#s format. For example 0h30m0s represents a duration of 30 minutes. Controls the maximum duration of individual HTTP requests. Used to manage resource exhaustion caused by improperly closed connections. This also limits the execution time of queries made over the Thrift HTTP transport. Increase the duration if queries are expected to take longer than the default duration of one hour; for example, if you COPY FROM a large file when using omnisql with the HTTP transport.

1h0m0s

tls-cipher-suites

Refers to the combination of algorithms used in TLS encryption to secure web protocol connections.

All available TLS cipher suites compatible with HTTP/2:

  • TLS_RSA_WITH_RC4_128_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA

  • TLS_ECDHE_RSA_WITH_AES_128_ GCM_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_ GCM_SHA256

  • TLS_ECDHE_RSA_WITH_AES_256_ GCM_SHA384

  • TLS_ECDHE_ECDSA_WITH_AES_256_ GCM_SHA384

  • TLS_ECDHE_RSA_WITH_CHACHA20_ POLY1305

  • TLS_ECDHE_ECDSA_WITH_CHACHA20_ POLY1305

  • TLS_AES_128_GCM_SHA256

  • TLS_AES_256_GCM_SHA384

  • TLS_CHACHA20_POLY1305_SHA256

  • TLS_FALLBACK_SCSV

    Limit security vulnerabilities by specifying the allowed TLS ciphers in the encryption used to secure web protocol connections.

The following cipher suites are accepted by default:

  • TLS_ECDHE_RSA_WITH_AES_128_ GCM_SHA256

  • TLS_ECDHE_ECDSA_WITH_AES_128_ GCM_SHA256

  • TLS_ECDHE_RSA_WITH_AES_256_ GCM_SHA384

  • TLS_RSA_WITH_AES_256_GCM_ SHA384

tls-curves

Refers to the types of Elliptic Curve Cryptography (ECC) used in TLS encryption to secure web protocol connections.

All available TLS elliptic Curve IDs:

  • secp256r1 (Curve ID P256)

  • CurveP256 (Curve ID P256)

  • secp384r1 (Curve ID P384)

  • CurveP384 (Curve ID P384)

  • secp521r1 (Curve ID P521)

  • CurveP521 (Curve ID P521)

  • x25519 (Curve ID X25519)

  • X25519 (Curve ID X25519)

    Limit security vulnerabilities by specifying the allowed TLS cipher suites in the encryption used to secure web protocol connections.

The following TLS curves are accepted by default:

  • CurveP521

  • CurveP384

  • CurveP256

tmpdir string

Path for temporary file storage. Used as a staging location for file uploads. Consider locating this directory on the same file system as the OmniSci data directory. If not specified on the command line, omnisci_web_server recognizes the standard TMPDIR environment variable as well as a specific OMNISCI_TMPDIR environment variable, the latter of which takes precedence. If you use neither the command-line argument nor one of the environment variables, the default, /tmp/ is used.

/tmp

-v | verbose

Enable verbose logging. Adds log messages for debugging purposes.

version

Return version.