SETCONFIGPROPERTY properties

Last updated: Mar 17, 2025
SETCONFIGPROPERTY properties

Refer to this index to learn more about the SETCONFIGPROPERTY properties.

The following table is an index of all the SETCONFIGPROPERTY properties that are currently published for Data Virtualization.

Property name Explanation
COLLECT_FETCHPHASE_WARNINGS Use this parameter to enable or disable fetch phase warnings.

For more information, see Enabling and disabling fetch phase warnings and errors in Data Virtualization.

CONNECTION_DETAILS_CACHE_SIZE Cache credentials to improve the performance of response times. Use this property to define the number of credential requests retained in the cache. This cache enables shared precomputed credentials for multiple threads that are requesting the same data source details.

The default value is 100. Setting this value to zero or lower disables caching.

CONNECTION_DETAILS_REFRESH_SEC Keep credentials up to date by using this property to set the refresh interval (in seconds) for retrieving connection details that are maintained by external components such as Platform connections. This property also controls how often requests are sent to retrieve credentials, in the case they have been updated.

The default value is 600 (10 minutes). Setting this value to a low number, such as five, might cause the Platform connections service to become unresponsive.

CONNECTION_DETAILS_REQUEST_TIMEOUT_MS When you add or use a data source on a remote agent that is configured with credentials that are stored in a vault, you might see a Failed to update connection details error. To workaround this issue, you can increase the timeout value by using this property.
DATASOURCE_MAX_BINARY_SIZE and <SRCTYPE> _MAX_BINARY_SIZE and <CID>_MAX_BINARY_SIZE Use the DATASOURCE_MAX_BINARY_SIZE property to enhance SQL performance by setting the maximum column size (in bytes) for unbounded binary types in remote source tables during list, preview, or virtualization operations at the agent level.

You can override DATASOURCE_MAX_BINARY_SIZE to limit it for all data source connections of a given type by using the property <SRCTYPE>_MAX_STRING_SIZE.
  • Replace <SRCTYPE> with the source name. For example, Hive data sources is HIVE_MAX_BINARY_SIZE.
You can override <SRCTYPE>_MAX_BINARY_SIZE at the individual connection level by using the property <CID>_MAX_BINARY_SIZE.
  • Replace <CID> with the unique identifier of the data source connection.

The default size for these properties is 32672, ensuring efficient pushdown of predicates in queries against virtual tables that contain them. Reduce the default size to further improve performance and efficiency.

DATASOURCE_MAX_STRING_SIZE and <SRCTYPE> _MAX_STRING_SIZE and <CID>_MAX_STRING_SIZE Use the DATASOURCE_MAX_STRING_SIZE property to enhance SQL performance by setting the maximum column size (in bytes) for unbounded string types in remote source tables during list, preview, or virtualization operations.

You can override DATASOURCE_MAX_STRING_SIZE to limit it for all data source connections of a given type by using the property <SRCTYPE>_MAX_STRING_SIZE.
  • Replace <SRCTYPE> with the source name. For example, Hive data sources is HIVE_MAX_STRING_SIZE.
You can override <SRCTYPE>_MAX_STRING_SIZE at the individual connection level by using the property <CID>_MAX_STRING_SIZE.
  • Replace <CID> with the unique identifier of the data source connection.

The default size for these properties is 32672, ensuring efficient pushdown of predicates in queries against virtual tables that contain them. Reduce the default size to further improve performance and efficiency.

FETCH_BUFFER_SIZE Improve query performance by minimizing network wait times during data transfer. Use this property to specify the number of batches of rows that are buffered at a Data Virtualization agent when you are fetching query results.

The default value is 100. The minimum value is 20.

Note: You can reduce this property to 20 to prevent a memory overuse error during high-concurrency scenarios (such as 4 Kb), without negatively affecting performance.
GAIAN_CONNECTIONS_CHECKER_HEARTBEAT_MS When you configure a data source connection to Data Virtualization and the connection fails, use this property to increase the timeout parameter value.

For more information, see Cannot connect to a data source in Data Virtualization.

LISTSCHEMAS_MODE This property lets you improve the performance of schema listings. You can choose to list the total number of schemas in the Explore view using a custom query or the getSchemas API at the source type or the Connection Identifier (CID) level.
  • List schemas at the source type by replacing the parameters and running this stored procedure:
    call dvsys.SETCONFIGPROPERTY('LISTSCHEMAS_MODE_<source_type>', '<mode>,'<qpendpoint>', ?, ?) 
    • Replace <source_type> with the source (that is, DB2, ORACLE, HIVE and so on).
    • Replace <mode> with QUERY to use a custom query, or API to use the getSchemas API.
    • Replace <qpendpoint> with the queryplex endpoint. For example: qpendpoint_1:6415.

  • List schemas at the CID level by replacing the parameters and running this stored procedure:
    call dvsys.SETCONFIGPROPERTY('LISTSCHEMAS_MODE_<CID>', '<mode>,'<qpendpoint>', ?, ?)
    • Replace <CID> with the connection identifier. The CID can be found in the Data sources page, in Data > Data virtualization.
    • Replace <mode> with QUERY to use a custom query, or API to use the getSchemas API.
    • Replace <qpendpoint> with the queryplex endpoint. For example: qpendpoint_1:6415.
LOGFILE_MAX_SIZE_MB Manage log file sizes to ensure efficient use of disk space. Use this property to define the maximum size (in megabytes) of each rotating log file that is maintained and stored by each Data Virtualization agent.

The default value is 100. The minimum value required is 1.

LOGLEVEL

Set the log level for all the nodes.

The log level settings include the following options:
  • NONE
  • LESS (default setting)
  • MORE (debug level logging)
  • ALL (debug level logging)
MAX_DS_JDBC_CONNECTION_TIMEOUT_MS Reduce the downtime of slow connections to data sources by using this property to set the timeout (in milliseconds) for establishing connections to data sources that you already have active connections to.

The default value is 120000 (2 minutes). The minimum value should be set according to how long it takes to connect to the slowest data source. Setting the value to zero might cause the connection to fail.

MAX_DS_POOLSIZES

This property is a global setting that specifies the maximum connection pool size for defined gateways and data sources.

The engine allows for the creation of the specified number of connections.

The default value for the maximum connection pool size is 10.

Use this property to resolve Concurrent queries are slow or fail in Data Virtualization.

MAX_INBOUND_CONNECTION_THREADS Ensure stable performance when under heavy usage by using this property to specify the maximum number of incoming connections allowed by the underlying Derby database.

The default value is 1000. Setting this value lower might reduce memory consumption but negatively impact performance.

MAX_JDBC_CONNECTION_QUEUE_TIMEOUT_MS

This property is a global setting that specifies the timeout interval (in milliseconds) a query waits in the queue to obtain a connection.

If the connection pool for the target data source reaches its maximum capacity, queries queue and wait for a connection to return to the pool before it fails.

The default maximum value for the time interval is 600,000 milliseconds (or 10 minutes).

MAX_POOLSIZES

This property is a global setting that specifies the maximum intranode connection pool size.

The engine allows for the creation of the specified number of connections between any two agents, including AdminNode, FMP, QPEndpoints, and remote agents. Remote agents that are added by using DEFINEGATEWAYS are not included.

The default value for the maximum number of intranode connections is 20.

Use this property to resolve Concurrent queries are slow or fail in Data Virtualization.

MAX_QUERY_STATS_MAP_QUEUE_SIZE Track recent query performance to enhance query optimization by using this property to control the maximum number of calls retained for each SQL statement instance. When the specified limit is reached, the least recently used entry is removed to add the new statement.

The default value is 100. Setting this value to zero disables statistics collection.

MIN_DS_JDBC_CONNECTION_TIMEOUT_MS Reduce prolonged delays in accessing data for the first time during a session. Use this property to define the timeout interval (in milliseconds) for establishing the first connection to a data source.

The default value is 60000 (one minute).

MIN_DS_POOLSIZES

This property is a global setting that specifies the minimum connection pool size for defined gateways and data sources.

The engine pre-populates and maintains the specified number of connections while the data source is active.

The default value for the minimum connection pool size is two.

MIN_POOLSIZES

This property is a global setting that specifies the minimum intranode connection pool size.

The engine pre-populates and maintains the specified number of connections between any two agents, including AdminNode, FMP, QPEndpoints, and remote agents. Remote agents that are added by using DEFINEGATEWAYS are not included.

The default value for the minimum intranode connection pool size is five.

NUMTABSREMOTE_MODE This property can improve the performance of resolving the number of tables in a remote data source. You can choose to list the total number of tables in the Data sources page by using a custom query or the getTables API at the source type or the Connection Identifier (CID) level.
  • List tables at the source type by replacing the parameters and running this stored procedure:
    call dvsys.SETCONFIGPROPERTY('NUMTABSREMOTE_MODE_<source type>', '<mode>,'<qpendpoint>', ?, ?)
    • Replace <source_type> with the source (i.e. DB2, ORACLE, HIVE and so on).
    • Replace <mode> with QUERY to use a custom query, or API to use the getTables API.
    • Replace <qpendpoint> with the queryplex endpoint. For example: qpendpoint_1:6415.

  • List tables at the CID level by replacing the parameters and running this stored procedure:
    call dvsys.SETCONFIGPROPERTY('NUMTABSREMOTE_MODE_<CID>', '<mode>,'<qpendpoint>', ?, ?)
    • Replace <CID> with the connection identifier. The CID can be found in the Data sources page, in Data > Data virtualization.
    • Replace <mode> with QUERY to use a custom query, or API to use the getTables API.
    • Replace <qpendpoint> with the queryplex endpoint. For example: qpendpoint_1:6415.
QUERY_STATS_MAP_NUM_QUEUES Identify query patterns by using this property to determine the number of distinct SQL statements for which query statistics are retained.

Setting this property to zero disables statistics collection.

RDB_CONNECTION_IDLE_DEACTIVATE_TIMEOUT_SEC

This property is a global setting that specifies the time interval (in seconds) after which an idle data source is deactivated.

Deactivating an idle data source closes all the remaining connections, and changes the data source status to Idle on the Data Sources page.

The default time interval is 120 seconds (two minutes).

RDB_CONNECTION_IDLE_SHRINK_TIMEOUT_SEC

This property is a global setting that specifies the time interval (in seconds) after which an Idle connection is closed and dropped from the pool. The connection remains dropped until the pool size is greater than the value specified in the MIN_DS_POOLSIZES property. After that, the connection closes when the deactivate timeout is reached.

The default value for the time interval is 20 seconds.

RELOADTABLES_ALLCOLS_<CID>
Use this property to specify filters on the retrieval of column names for a specific source.
  • Replace <CID> with the unique identifier of the data source connection.

Use this property to resolve the issue Speed up loading of tables when you virtualize in Data Virtualization.

RELOADTABLES_ALLTABS_<CID>
Use this property to specify filters on the retrieval of table names for a specific source.
  • Replace <CID> with the unique identifier of the data source connection.

Use this property to resolve the issue Speed up loading of tables when you virtualize in Data Virtualization.

RELOADTABLES_SCHEMAS_REVEALED_<CID>
Use this property to specify the list of schemas to reveal that is otherwise excluded by default.
  • Replace <CID> with the unique identifier of the data source connection.

For more information, see Reveal hidden tables when you virtualize in Data Virtualization.

SETRDBC_NON_RDBMS_CONNECTION_TIMEOUT_MS Avoid prolonged delays when you connect to schema maps. Use this property to specify the timeout interval (in milliseconds) for establishing connections to schema maps.

The default value is one.

SOURCE_CATALOG_API_CACHED_FOREGROUND_TIMEOUT_MS Automatically use cached values during catalog queries to improve response times for slow data sources. Use this property to define the timeout interval (in milliseconds) before Data Virtualization defaults to a cached value for the NUMTABSREMOTE API.

The default value is 5000 ms (five seconds).

SOURCE_CATALOG_API_FOREGROUND_TIMEOUT_MS Avoid prolonged wait times from unresponsive data sources. Use this property to define the timeout interval (in milliseconds) before Data Virtualization returns an empty result for source catalog API calls including LISTSCHEMAS and LISTTABLES.

The default value is 30,000 ms (30 seconds).

SOURCE_CATALOG_API_MAX_CONCURRENCY Balance system performance with resource constraints during high load scenarios. Use this property to define the maximum number of concurrent connection threads that are allowed for running system APIs including LISTSCHEMAS and LISTTABLES on a data source.

The default value is four.

TRANSACTION_ISOLATION_LEVEL Choose the appropriate isolation level based on the needs of an application. Use this property to define the transaction isolation level used for queries that run on data sources.

The default value is UR (uncommitted read). For more information, see Isolation levels.