TDV Adapter for Redis

Build 21.0.8137

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Basic Tab.


AuthSchemeThe authentication mechanism that the provider will use to authenticate with Redis.
ServerThe host name or IP address of the server hosting the Redis instance.
PortThe port for the Redis database.
LogicalDatabaseThe index of the Redis Logical Database.
PasswordThe password used to authenticate with Redis.
EnableClusterThis field sets whether the Redis Cluster Mode is enabled.
UseSSLThis field sets whether SSL is enabled.


DefineTablesDefine the tables exposed by the provider using table names and Redis key patterns.
PatternSeparatorDefine the table pattern's separator.
TablePatternDefine the tables exposed by the provider using Redis key patterns.


SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLStartModeThis property determines how the provider starts the SSL negotiation.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.


SSHAuthModeThe authentication method to be used to log on to an SFTP server.
SSHClientCertA certificate to be used for authenticating the user.
SSHClientCertPasswordThe password of the SSHClientCert certificate if it has one.
SSHClientCertSubjectThe subject of the SSH client certificate.
SSHClientCertTypeThe type of SSHClientCert certificate.
SSHServerThe SSH server.
SSHPortThe SSH port.
SSHUserThe SSH user.
SSHPasswordThe SSH password.
SSHServerFingerprintThe SSH server fingerprint.
UseSSHWhether to tunnel the Redis connection over SSH. Use SSH.


FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.


LogModulesCore modules to be included in the log file.


LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.


IgnoreTypeErrorsRemoves support for the specified data types and ignores casting exceptions for those types.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
OtherThese hidden properties are used only in specific use cases.
ParallelModeThis option sets whether the provider should use multiple connections when connecting to Redis.
QueryTimeoutThe timeout in seconds for which the provider will wait for the query response. The default value is -1, which indicates the provider should never time out.
ReadonlyYou can use this property to enforce read-only access to Redis from the provider.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
TableScanDepthThe maximum number of keys to scan when looking for tables available in your Redis database.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137