Connection String Parameters for Redis
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.
| Name | Description |
| AuthScheme | The authentication mechanism that the provider will use to authenticate with Redis. |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| DefineTables | Define the tables exposed by the provider using table names and Redis key patterns. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| IgnoreTypeErrors | Removes support for the specified data types and ignores casting exceptions for those types. |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| Logfile | A path to the log file. |
| LogicalDatabase | The index of the Redis Logical Database. |
| MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
| MaxRows | Limits 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. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| ParallelMode | This option sets whether the provider should use multiple connections when connecting to Redis. |
| Password | The password used to authenticate with Redis. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| Port | The port for the Redis database. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to Redis from the provider. |
| RowScanDepth | The maximum number of rows to scan to look for columns available in the table. Set this property to gain more control over how the provider applies data types to collections. |
| RTK | The runtime key used for licensing. |
| Server | The host name or IP address of the server hosting the Redis instance. |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| SSLStartMode | This property determines how the provider starts the SSL negotiation. |
| SupportEnhancedSQL | This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing. |
| TablePattern | Define the tables exposed by the provider using Redis key patterns. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| TableScanDepth | The maximum number of keys to scan when looking for tables available in your Redis database. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseConnectionPooling | This property enables connection pooling. |
| UseSSL | This field sets whether SSL is enabled. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |