System Properties

You are looking at an older version of the documentation. The latest version is found here.

Some parts of Data Virtuality Server behaviour can be configured via system properties. System properties may be set in the dvserver/bin/standalone.conf.props(.bat) file and have the format -Dproperty=value.

To view the full table, click the expand button in its top right corner

System Property	Description	Default Value
com.datavirtuality.jdbcCursorBufferSizeOfConnections	For usage with the Data Virtuality REST API pagination. Specifies the maximum number of buffered connections (one connection corresponds to one cursor or `requestId`)	`10`
com.datavirtuality.jdbcCursorBufferConnectionLifeTime	For usage with the Data Virtuality REST API pagination. Specifies the duration a `requestId` created once will stay valid. After that time `requestId` will be expired. Time is measured from the last usage of the `requestId` and will be reset with each usage. The actual lifetime may differ depending on buffer usage for pagination queries. Value is specified in minutes	`20`
dv.enablemetadatacache	Enables caching of the metadata to the configuration database on adding or refreshing the data source	`FALSE`
dv.maintenance	If set to `TRUE`, the Server will start in the maintenance mode	`FALSE`
dv.proxy (possible values: NONE, HTTP, SOCKS4, SOCKS5) dv.proxy.host dv.proxy.port dv.proxy.user dv.proxy.pwd	Used by the following: SFTP and FTP connector if there is no proxy configured via connector specific connection properties; SSHTunnel module if there is no proxy configured via createSSHTunnel respective importSSHTunnel procedures; Amazon S3 connector; Redshift with upload configured via Amazon S3; Snowflake with upload configured via Amazon S3	`-`
dv.refreshmetadataonstart	If set to `FALSE`, disables the metadata refresh on bootstrapping for all the data sources having a cached copy of their metadata in the configuration database. Such a copy is created automatically for each data source added or refreshed after the `dv.enablemetadatacache` property is set to `TRUE`	`TRUE`
dv.skipinitmetadataonstartup	If set to `TRUE`, prevents initialization of modular connectors metadata on server startup	`FALSE`
org.teiid.compactBufferFiles	If set to `TRUE`, makes the Data Virtuality Server keep the buffer files more compact (minimizing sparse regions)	`FALSE`
org.teiid.comparableLobs	If set to `TRUE`, enables blob and clob column values to be comparable in the Data Virtuality Server. Source type metadata will determine if the comparison can be pushed down	`TRUE`
org.teiid.subqueryUnnestDefault	Controls whether the optimizer will by default unnest subqueries	`FALSE`
org.jboss.as.controller.client.timeout-ms	Specifies the timeout for JBoss CLI in milliseconds	`20000`
org.jboss.as.cli.timeout-ms	Specifies the default CLI timeout for JBoss CLI in milliseconds	`20000`
org.teiid.maxStringLength	Specifies the default `STRING` data type length in the Data Virtuality views	`Integer.MAX_VALUE`
org.teiid.estimatedStringLength	Used for internal cache size calculation	`4000`
rest.timeout	REST API timeout in milliseconds	`600000`
snowflake.application.identifier	Specifies a Unique Connection String Identifier for Snowflake data sources	`DataVirtuality_DV`

org.jboss.as.cli.timeout-ms is available since v2.4.3

org.teiid.estimatedStringLength is available since v2.4.7

org.teiid.comparableLobs is set to TRUE since v2.4.18

snowflake.application.identifier property available since v2.4.32

Examples

1. Example for setting system property via standalone.conf.props.bat (Windows):

SQL

SET "JAVA_OPTS=%JAVA_OPTS% -D<system property>=<system property value>"

2. Example for setting system property via standalone.conf.props (Linux):

SQL

JAVA_OPTS="$JAVA_OPTS -D<system property>=<system property value>"

3. Example for setting the dv.maintenance system property via standalone.conf.props.bat (Windows):

SQL

SET "JAVA_OPTS=%JAVA_OPTS% -Ddv.maintenance=true"

4. Example for setting the dv.maintenance system property via standalone.conf.props (Linux):

SQL

JAVA_OPTS="$JAVA_OPTS -Ddv.maintenance=true"