|
Matillion Data Model for Redis
|
Connection String OptionsBack To Top
- Auth Scheme
- Auto Cache
- Batch Size
- Cache Connection
- Cache Driver
- Cache Location
- Cache Metadata
- Cache Tolerance
- Connection Life Time
- Connect On Open
- Define Tables
- Firewall Password
- Firewall Port
- Firewall Server
- Firewall Type
- Firewall User
- Ignore Type Errors
- Location
- Logfile
- Logical Database
- Max Log File Count
- Max Log File Size
- Max Rows
- Offline
- Other
- Parallel Mode
- Password
- Pool Idle Timeout
- Pool Max Size
- Pool Min Size
- Pool Wait Time
- Port
- Pseudo Columns
- Readonly
- Row Scan Depth
- RTK
- Server
- SSL Client Cert
- SSL Client Cert Password
- SSL Client Cert Subject
- SSL Client Cert Type
- SSL Server Cert
- SSL Start Mode
- Support Enhanced SQL
- Table Pattern
- Tables
- Table Scan Depth
- Timeout
- Use Connection Pooling
- Use SSL
- Verbosity
- Views
Auth Scheme
Data Type
string
Default Value
"PASSWORD"
Remarks
Accepted values are NONE and PASSWORD. By default, the driver attempts to connect using the AUTH Redis command, using Password. If the Redis instance is not password protected (using the requirepass directive in the configuration file), set AuthScheme to "NONE".
Auto Cache
Data Type
bool
Default Value
false
Remarks
When AutoCache = true, the driver automatically maintains a cache of your table's data in the database of your choice.
Setting the Caching Database
When AutoCache = true, the driver caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
- CacheLocation: Specifies the path to the file store.
- CacheDriver and CacheConnection: Specifies a driver to a database and the connection string.
See Also
- CacheMetadata: This property reduces the amount of metadata that crosses the network by persisting table schemas retrieved from the Redis metadata. Metadata then needs to be retrieved only once instead of every connection.
- Explicitly Caching Data: This section provides more examples of using AutoCache in Offline mode.
- CACHE Statements: You can use the CACHE statement to persist any SELECT query, as well as manage the cache; for example, refreshing schemas.
Batch Size
Data Type
int
Default Value
0
Remarks
When BatchSize is set to a value greater than 0, the batch operation will split the entire batch into separate batches of size BatchSize. The split batches will then be submitted to the server individually. This is useful when the server has limitations on the size of the request that can be submitted.
Setting BatchSize to 0 will submit the entire batch as specified.
Cache Connection
Data Type
string
Default Value
""
Remarks
The cache database is determined based on the CacheDriver and CacheConnection properties. Both properties are required to use the cache database. Examples of common cache database settings can be found below. For more information on setting the caching database's driver, refer to CacheDriver.
The connection string specified in the CacheConnection property is passed directly to the underlying CacheDriver. Consult the documentation for the specific JDBC driver for more information on the available properties. Make sure to include the JDBC driver in your application's classpath.
Derby and Java DB
The driver simplifies caching to Derby, only requiring you to set the CacheLocation property to make a basic connection.
Alternatively, you can configure the connection to Derby manually using CacheDriver and CacheConnection. The following is the Derby JDBC URL syntax:
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
For example, to cache to an in-memory database, use the following:
jdbc:derby:memory
SQLite
To cache to SQLite, you can use the SQLite JDBC driver. The following is the syntax of the JDBC URL:
jdbc:sqlite:dataSource
- Data Source: The path to an SQLite database file. Or, use a value of :memory to cache in memory.
MySQL
The installation includes the CData JDBC Driver for MySQL. The following is an example JDBC URL:
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
The following are typical connection properties:
- Server: The IP address or domain name of the server you want to connect to.
- Port: The port that the server is running on.
- User: The user name provided for authentication to the database.
- Password: The password provided for authentication to the database.
- Database: The name of the database.
SQL Server
The JDBC URL for the Microsoft JDBC Driver for SQL Server has the following syntax:
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
For example:
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
The following are typical SQL Server connection properties:
- Server: The name or network address of the computer running SQL Server. To connect to a named instance instead of the default instance, this property can be used to specify the host name and the instance, separated by a backslash.
- Port: The port SQL Server is running on.
- Database: The name of the SQL Server database.
- Integrated Security: Set this option to true to use the current Windows account for authentication. Set this option to false if you are setting the User and Password in the connection.
To use integrated security, you will also need to add sqljdbc_auth.dll to a folder on the Windows system path. This file is located in the auth subfolder of the Microsoft JDBC Driver for SQL Server installation. The bitness of the assembly must match the bitness of your JVM.
- User ID: The user name provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
- Password: The password provided for authentication with SQL Server. This property is only needed if you are not using integrated security.
Oracle
The following is the conventional JDBC URL syntax for the Oracle JDBC Thin driver:
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
For example:
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
The following are typical connection properties:
-
Data Source: The connect descriptor that identifies the Oracle database. This can be a TNS connect descriptor, an Oracle Net Services name that resolves to a connect descriptor, or, after version 11g, an Easy Connect naming (the host name of the Oracle server with an optional port and service name).
- Password: The password provided for authentication with the Oracle database.
- User Id: The user Id provided for authentication with the Oracle database.
PostgreSQL
The following is the JDBC URL syntax for the official PostgreSQL JDBC driver:
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
For example, the following connection string connects to a database on the default host (localhost) and port (5432):
jdbc:postgresql:postgres
The following are typical connection properties:
- Host: The address of the server hosting the PostgreSQL database.
- Port: The port used to connect to the server hosting the PostgreSQL database.
- Database: The name of the database.
- User name: The user Id provided for authentication with the PostgreSQL database. You can specify this in the JDBC URL with the "user" parameter.
- Password: The password provided for authentication with the PostgreSQL database.
Cache Driver
Data Type
string
Default Value
""
Remarks
You can cache to any database for which you have a JDBC driver, including CData JDBC drivers.
The cache database is determined based on the CacheDriver and CacheConnection properties. The CacheDriver is the name of the JDBC driver class that you want to use to cache data.
Note that you must also add the CacheDriver JAR file to the classpath.
The following examples show how to cache to several major databases. Refer to CacheConnection for more information on the JDBC URL syntax and typical connection properties.
Derby and Java DB
The driver simplifies Derby configuration. Java DB is the Oracle distribution of Derby. The JAR file is shipped in the JDK. You can find the JAR file, derby.jar, in the db subfolder of the JDK installation. In most caching scenarios, you need to specify only the following, after adding derby.jar to the classpath:
jdbc:redis:CacheLocation='c:/Temp/cachedir';Server=127.0.0.1;Password=myPassword;To customize the Derby JDBC URL, use CacheDriver and CacheConnection. For example, to cache to an in-memory database, use a JDBC URL like the following:
jdbc:redis:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';Server=127.0.0.1;Password=myPassword;
SQLite
The following is a JDBC URL for the SQLite JDBC driver:
jdbc:redis:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';Server=127.0.0.1;Password=myPassword;
MySQL
The following is a JDBC URL for the included CData JDBC Driver for MySQL:
jdbc:redis:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';Server=127.0.0.1;Password=myPassword;
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for Redis 2019 installation directory.
SQL Server
The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:
jdbc:redis:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';Server=127.0.0.1;Password=myPassword;
Oracle
The following is a JDBC URL for the Oracle Thin Client:
jdbc:redis:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';Server=127.0.0.1;Password=myPassword;
NOTE: If using a version of Oracle older than 9i, the cache driver will instead be oracle.jdbc.driver.OracleDriver .
PostgreSQL
The following JDBC URL uses the official PostgreSQL JDBC driver:
jdbc:redis:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';Server=127.0.0.1;Password=myPassword;
Cache Location
Data Type
string
Default Value
"%APPDATA%\\CData\\Redis Data Provider"
Remarks
The CacheLocation is a simple, file-based cache. The driver uses Java DB, Oracle's distribution of the Derby database. To cache to Java DB, you will need to add the Java DB JAR file to the classpath. The JAR file, derby.jar, is shipped in the JDK and located in the db subfolder of the JDK installation.
If left unspecified, the default location is "%APPDATA%\\CData\\Redis Data Provider" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Mac | ~/Library/Application Support |
| Linux | ~/.config |
See Also
- AutoCache: Set to implicitly create and maintain a cache for later offline use.
- CacheMetadata: Set to persist the Redis catalog in CacheLocation.
Cache Metadata
Data Type
bool
Default Value
false
Remarks
As you execute queries with this property set, table metadata in the Redis catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
When to Use CacheMetadata
The driver automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
When Not to Use CacheMetadata
- When you are working with volatile metadata: Metadata for a table is only retrieved the first time the connection to the table is made. To pick up new, changed, or deleted columns, you would need to delete and rebuild the metadata cache. Therefore, it is best to rely on the in-memory caching for cases where metadata changes often.
- When you are caching to a database: CacheMetadata can only be used with CacheLocation. If you are caching to another database with the CacheDriver and CacheConnection properties, use AutoCache to cache implicitly. Or, use CACHE Statements to cache explicitly.
Cache Tolerance
Data Type
string
Default Value
"600"
Remarks
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The driver checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
Connection Life Time
Data Type
string
Default Value
"0"
Remarks
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. The default is 0 which indicates there is no limit to the connection lifetime.
Connect On Open
Data Type
bool
Default Value
false
Remarks
When set to true, a connection will be made to Redis when the connection is opened. This property enables the Test Connection feature available in various database tools.
This feature acts as a NOOP command as it is used to verify a connection can be made to Redis and nothing from this initial connection is maintained.
Setting this property to false may provide performance improvements (depending upon the number of times a connection is opened).
Define Tables
Data Type
string
Default Value
""
Remarks
This property is used to define the key pattern within Redis that will appear as tables, when using the REST API. The value is a comma-separated list of name-value pairs in the form [Table Name]=[Redis key pattern]. Table Name is the name of the table you want to use for the data and will be used when issuing queries. The Redis key pattern is the pattern to be used to group and pivot corresponding keys into the named table.
Here is an example DefineTables value:
DefineTables="DefinedTable1=table1:*,DefinedTable2=table2:*"
Given this value, all of the keys that begin with "table1:" will be found in DefinedTable1, while all keys that begin with "table2:" will be found in DefinedTable2.
Firewall Password
Data Type
string
Default Value
""
Remarks
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
Firewall Port
Data Type
string
Default Value
""
Remarks
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
Firewall Server
Data Type
string
Default Value
""
Remarks
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling.
Firewall Type
Data Type
string
Default Value
"NONE"
Remarks
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the driver opens a connection to Redis and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the driver sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the driver sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
Firewall User
Data Type
string
Default Value
""
Remarks
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
Ignore Type Errors
Data Type
string
Default Value
""
Remarks
A comma-separated list of data types for which to ignore casting exceptions and treat as strings. For example, IgnoreTypeErrors=Date,Time.
If the value can be parsed as the specified type, it is returned as a string; otherwise, the value is returned as NULL instead.
Location
Data Type
string
Default Value
"%APPDATA%\\CData\\Redis Data Provider\\Schema"
Remarks
The path to a directory which contains the schema files for the driver (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Redis Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Mac | ~/Library/Application Support |
| Linux | ~/.config |
Logfile
Data Type
string
Default Value
""
Remarks
For more control over what is written to the log file, you can adjust its Verbosity.
Logical Database
Data Type
string
Default Value
"0"
Remarks
The index of the Redis Logical Database. The default value is 0.
Max Log File Count
Data Type
string
Default Value
""
Remarks
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. The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Max Log File Size
Data Type
string
Default Value
"100MB"
Remarks
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. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Max Rows
Data Type
string
Default Value
"-1"
Remarks
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
Data Type
bool
Default Value
false
Remarks
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
Other
Data Type
string
Default Value
""
Remarks
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Caching Configuration
| CachePartial=True | Caches only a subset of columns, which you can specify in your query. |
| QueryPassthrough=True | Passes the specified query to the cache database instead of using the SQL parser of the driver. |
Integration and Formatting
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Parallel Mode
Data Type
bool
Default Value
false
Remarks
The default is that parallel mode is disabled, which means that the driver will use only one connection when communicating with Redis. This works well for smaller databases, but can cause performance and memory usage issues on larger databases.
If parallel mode is enabled, the driver will open different connections to Redis for discovering keys and reading data. This makes interacting with larger databases more efficient but can add overhead for smaller databases.
If parallel mode is enabled, you can tune how much memory is used by the driver by using the hidden MaxPageSize property (see Other). The default value is 5, but you can increase it to make the driver faster or decrease it to make the driver use less memory.
Password
Data Type
string
Default Value
""
Remarks
The password used to authenticate with Redis.
Pool Idle Timeout
Data Type
string
Default Value
""
Remarks
The allowed idle time a connection can remain in the pool until the connection is closed. The default is 60 seconds.
Pool Max Size
Data Type
string
Default Value
"100"
Remarks
The maximum connections in the pool. The default is 100. To disable this property, set the property value to 0 or less.
Pool Min Size
Data Type
string
Default Value
"1"
Remarks
The minimum number of connections in the pool. The default is 1.
Pool Wait Time
Data Type
string
Default Value
""
Remarks
The max seconds to wait for a connection to become available. If a new connection request is waiting for an available connection and exceeds this time, an error is thrown. By default, new requests wait forever for an available connection.
Port
Data Type
string
Default Value
"6379"
Remarks
The port for the Redis database.
Pseudo Columns
Data Type
string
Default Value
""
Remarks
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Readonly
Data Type
bool
Default Value
false
Remarks
If this property is set to true, the driver will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
Row Scan Depth
Data Type
string
Default Value
"50"
Remarks
Since Redis is schemaless, the columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.
RTK
Data Type
string
Default Value
""
Remarks
The RTK property may be used to license a build. See the included licensing file to see how to set this property. The runtime key is only available if you purchased an OEM license.
Server
Data Type
string
Default Value
""
Remarks
The host name or IP address of the server hosting the Redis instance.
SSL Client Cert
Data Type
string
Default Value
""
Remarks
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
| SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
SSL Client Cert Password
Data Type
string
Default Value
""
Remarks
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSL Client Cert Subject
Data Type
string
Default Value
"*"
Remarks
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
SSL Client Cert Type
Data Type
string
Default Value
""
Remarks
This property can take one of the following values:
| USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
| MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
| PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
| JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
| JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
| PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
| PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
| SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
| P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
| PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
| XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
| XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSL Server Cert
Data Type
string
Default Value
""
Remarks
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
SSL Start Mode
Data Type
string
Default Value
"None"
Remarks
The SSLStartMode property may have one of the following values:
| Automatic | If the remote port is set to the standard plain text port of the protocol (where applicable), the driver will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit. |
| Implicit | The SSL negotiation will start immediately after the connection is established. |
| Explicit | The driver will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS. |
| None | No SSL negotiation, no SSL security. All communication will be in plain text mode. |
Support Enhanced SQL
Data Type
bool
Default Value
true
Remarks
When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to Redis and then processes the rest of the query in memory. In this way, the driver can execute unsupported predicates, joins, and aggregation.
When SupportEnhancedSQL = false, the driver limits SQL execution to what is supported by the Redis API.
Execution of Predicates
The driver determines which of the clauses are supported by the data source and then pushes them to the source to get the smallest superset of rows that would satisfy the query. It then filters the rest of the rows locally. The filter operation is streamed, which enables the driver to filter effectively for even very large datasets.
Execution of Joins
The driver uses various techniques to join in memory. The driver trades off memory utilization against the requirement of reading the same table more than once.
Execution of Aggregates
The driver retrieves all rows necessary to process the aggregation in memory.
Table Pattern
Data Type
string
Default Value
"*:*"
Remarks
This property is used to define the key patterns within Redis that will appear as tables, when using the REST API. The value is a Redis key pattern. The Redis key pattern is a string pattern containing a separator to determine a hierarchical structure for the key-values stored in the Redis data store. Any other string patterns in the value will limit which keys will be pivoted and returned as tables.
For example, TablePattern="*:*" causes the ":" character to be used as the separator. Given the following keys,
user:1001, user:1002, user:1003, admin:001, admin:002, admin:003
two tables would be exposed, user and admin, with the related keys corresponding to individual rows in each table.
Tables
Data Type
string
Default Value
""
Remarks
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. For example, Tables=TableA,TableB,TableC.
Table Scan Depth
Data Type
string
Default Value
"-1"
Remarks
Since Redis is schemaless, the driver determines tables by finding keys that match the TablePattern. This value determines the maximum number of keys that will be scanned for each entry in TablePattern.
To disable this limit and always scan all keys, set the value of this property to "-1". Otherwise, set this property to a postitive integer to limit the keys scanned to that amount.
Timeout
Data Type
string
Default Value
"60"
Remarks
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the driver throws an exception.
Use Connection Pooling
Data Type
bool
Default Value
false
Remarks
This property enables connection pooling. The default is false. See Connection Pooling for information on using connection pools.
Use SSL
Data Type
bool
Default Value
false
Remarks
This field sets whether the driver will attempt to negotiate TLS/SSL connections to the server. By default, the driver checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.
Verbosity
Data Type
string
Default Value
"1"
Remarks
The verbosity level determines the amount of detail that the driver reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described in the following list:
| 1 | Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors. |
| 2 | Setting Verbosity to 2 will log everything included in Verbosity 1, cache queries, and additional information about the request, if applicable. |
| 3 | Setting Verbosity to 3 will additionally log the body of the request and the response. |
| 4 | Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation. |
| 5 | Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands. |
The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.
Views
Data Type
string
Default Value
""
Remarks
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the driver.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. For example, Views=ViewA,ViewB,ViewC.