Skip to Content

Redis Connection Details

Introduction

Connector Version

This documentation is based on version 23.0.8895 of the connector.

Get Started

Redis Version Support

The connector models Redis instances as relational databases. The connector leverages the Redis commands to enable bidirectional access to Redis and Redis Enterprise data through SQL. Redis versions 2.8.0 and above are supported.

Establish a Connection

Connect to Redis

Set the Server connection property to the name or address of the server your Redis instance is running on.

If your Redis server is running on a port other than the default (6379), you can specify your port in the Port property.

Authenticate to Redis

The connector supports Password and ACL authentication. Connections to Redis instances that aren't password protected are supported as well.

No Authentication

Set the AuthScheme property to None. This indicates the Redis instance is not password protected (using the requirepass directive in the configuration file).

Password

Set the AuthScheme property to Password and set the Password property to the password used to authenticate with a password protected Redis instance using the Redis AUTH command.

ACL (Access Control List)

Set the following to connect:

  • AuthScheme: Set this to ACL.
  • User: Set this to the username you use to authenticate with Redis ACL.
  • Password: Set this to the password you use to authenticate with Redis ACL.

Secure Redis Connections

You can set UseSSL to negotiate SSL/TLS encryption when you connect.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Data Model

The connector enables you to model Redis key-value pairs as tables.

Tables

The connector enables two major paradigms for modeling Redis key-value pairs as tables.

Modeling Redis Hashes as Tables

Redis key patterns can be modeled as tables. See Freeform Querying of Redis Keys for a breakdown of the different configuration options.

Freeform Querying of Redis Keys

It is also possible to query keys directly as if they are tables.

If you would like to query specific keys as tables, see Modeling Redis Hashes as Tables.

If you would like to query all keys in the Redis keystore from a single table, see the Keys table.

Redis Data Types

See Redis Data Types for a list of the Redis data types supported by the connector.

Stored Procedures

Use the available Stored Procedures to submit commands (in native redis-cli syntax) to the Redis server for direct execution.

Modeling Redis Hashes as Tables

The connector can be configured to shape the discovered metadata.

Use the DefineTables, TablePattern, and PatternSeparator connection properties to customize how tables and columns are inferred from the Redis key store.

Presume the following hashes have been created in the Redis server (either with redis-cli or the RunCommand storec procedure).

> hmset user:1000 name "John Smith" email "john.smith@example.com" password "s3cret"
OK
> hmset user:1001 name "Mary Jones" email "mjones@example.com" password "hidden"
OK
> hmset user:1002 name "Sally Brown" email "sally.b@example.com" password "p4ssw0rd"
OK
> hmset customer:200 name "John Smith" account "123456" balance "543.21"
OK
> hmset customer:201 name "Mary Jones" account "123457" balance "654.32"
OK
> hmset customer:202 name "Sally Brown" account "123458" balance "765.43"
OK

When these properties are used to define the connector's behavior, the Redis keys will be pivoted, so that each Redis key that matches the pattern in the definition is represented as a single row in the table. Each value associated with that Redis key becomes a column for the table.

DefineTables Property

The DefineTables connection property allows you to explicitly define the names of the tables that will appear. To do so, set the property to a comma-separated string of name-value pairs, where the name is the name of the table and the value is the pattern used to assign Redis keys to that table.

The connector aggregates all of the Redis keys that match the specified patterns.

DefineTables=Users=user:*,Customers=customer:*;

With the property set as above, the Users and Customers tables will be exposed. If you were to query the tables, you would see the following results:

SELECT * FROM Users
RedisKey name email password
user:1000 John Smith john.smith@example.com s3cret
user:1001 Mary Jones mjones@example.com hidden
user:1002 Sally Brown sally.b@example p4ssw0rd
SELECT * FROM Customers
RedisKey name account balance
customer:200 John Smith 123456 543.21
customer:201 Mary Jones 123456 654.32
customer:202 Sally Brown 123456 765.43

TablePattern Property

The TablePattern connection property allows you to define the separator(s) that determine how the connector defines tables. For the Redis keys described above, "user" and "customer" would be defined as tables if the separator is set to ":" since the unique piece of each Redis key appears after the ":". If you have a need to structure the tables differently, to drill down further, you can include multiple instances of the separator. Set the property to a pattern that includes the separator(s) needed to define your table structure. (Below is the default value.)

You can also manually specify the pattern separator indepently from the TablePattern using the PatternSeparator property.

TablePattern=*:*;

With the property set as above, the user and customer tables will be exposed. If you were to query the tables, you would see the following results:

SELECT * FROM user
RedisKey name email password
user:1000 John Smith john.smith@example.com s3cret
user:1001 Mary Jones mjones@example.com hidden
user:1002 Sally Brown sally.b@example p4ssw0rd
SELECT * FROM customer
RedisKey name account balance
customer:200 John Smith 123456 543.21
customer:201 Mary Jones 123456 654.32
customer:202 Sally Brown 123456 765.43

Freeform Querying of Redis Keys

The most direct way to work with Redis data with the connector is to use a Redis key as a table name. Below you will find sample data, queries, and results based on Redis data types.

Note

This page contains redis-cli syntax. Use either your own instance of redis-cli or the RunCommand procedure to send queries from the connector to the Redis server for direct execution.

Redis Strings

Create a string in Redis:

> set mykey somevalue
OK

If you perform a SELECT query on mykey the connector will return the following:

SELECT * FROM mykey
RedisKey ValueIndex Value RedisType ValueScore
mykey 1 somevalue String NULL

Redis Lists

Create a list in Redis:

> rpush mylist A B C
(integer) 3

If you perform a SELECT query on mylist the connector will return the following:

SELECT * FROM mylist
RedisKey ValueIndex Value RedisType ValueScore
mylist 1 A List NULL
mylist 2 B List NULL
mylist 3 C List NULL
Deleting Redis Lists

List type records can also be removed using DELETE statements, though they must be performed by specifying the Value column in the WHERE clause:

DELETE FROM Keys WHERE Value = 'myvalue' AND RedisKey = 'mylist'

Note that using ValueIndex in the WHERE clause of the DELETE statement is not supported.

Redis Sets

Create a set in Redis:

> sadd myset 1 2 3
(integer) 3

If you perform a SELECT query on myset the connector will return the following (note that Redis can return the elements of a set in any order):

SELECT * FROM myset
RedisKey ValueIndex Value RedisType ValueScore
myset 1 2 Set NULL
myset 2 1 Set NULL
myset 3 3 Set NULL

Redis Sorted Sets

Create a ZSet (sorted set) in Redis:

> zadd hackers 1940 "Alan Kay" 1957 "Sophie Wilson" 1953 "Richard Stallman" 1949 "Anita Borg"
(integer) 9

If you perform a SELECT query on hackers the connector will return the following:

SELECT * FROM hackers
RedisKey ValueIndex Value RedisType ValueScore
hackers 1 Alan Kay ZSet 1940
hackers 2 Anita Borg ZSet 1949
hackers 3 Richard Stallman ZSet 1953
hackers 4 Sophie Wilson ZSet 1957

Redis Hashes

Create a hash in Redis:

> hmset user:1000 username antirez birthyear 1977 verified 1
OK

If you perform a SELECT query on user:1000 the connector will return the following:

SELECT * FROM user:1000
RedisKey ValueIndex Value RedisType ValueScore
user:1000 username antirez Hash NULL
user:1000 birthyear 1977 Hash NULL
user:1000 verified 1 Hash NULL

Querying Key Patterns as Tables

You can retrieve multiple Redis keys at once by using a pattern (e.g., "user:*") as a table name. For example, start by adding several keys to Redis that match a pattern:

> hmset user:1000 name "John Smith" email "john.smith@example.com" password "s3cret"
OK
> hmset user:1001 name "Mary Jones" password "hidden" email "mjones@example.com"
OK

If you use user:* as the table name, the connector will retrieve all Redis key-value pairs whose keys match the pattern. You can see the expected results below:

SELECT * FROM [user:*]
RedisKey ValueIndex Value RedisType ValueScore
user:1000 name John Smith Hash NULL
user:1000 email john.smith@example.com Hash NULL
user:1000 password s3cret Hash NULL
user:1001 name Mary Jones Hash NULL
user:1001 email mjones@example.com Hash NULL
user:1001 password hidden Hash NULL

Redis Data Types

Redis Data Types Supported by the Connector

  • Binary-safe Strings.
  • Lists: collections of string elements sorted according to the order of insertion. They are basically linked lists.
  • Sets: collections of unique, unsorted string elements.
  • Sorted Sets (ZSets): similar to sets but where every string element is associated to a floating number value, called score. The elements are always taken sorted by their score, so unlike sets it is possible to retrieve a range of elements (for example you may ask: give me the top 10, or the bottom 10).
  • Hashes: maps composed of fields associated with values. Both the field and the value are strings. This is very similar to Ruby or Python hashes.

Tables

The connector models the data in Redis as a list of tables in a relational database that can be queried using standard SQL statements.

Redis Connector Tables

Name Description
Keys Returns keys present in the Redis store.

Keys

Returns keys present in the Redis store.

This table allows you to query all Redis keys in one place. It models Redis key metadata in exactly the same way as described in Freeform Querying of Redis Keys.

Columns
Name Type ReadOnly Description
RedisKey [KEY] String True The name of the Redis key.
ValueIndex String True Varies by type: 1 for strings; the one-based index for sets, lists, and sorted sets; or the associated field name for hashes.
Value String True The value associated with the Redis key.
RedisType String True The type associated with the Redis key.
ValueScore Double True NULL for strings, lists, sets, and hashes. Returns the associated score for sorted sets.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Redis.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Redis, along with an indication of whether the procedure succeeded or failed.

Redis Connector Stored Procedures

Name Description
CreateSchema Creates a custom schema file based on the specified columns.
RunBatchCommand Sequentially executes a batch of Redis commands using either a temporary table or a batch file.
RunCommand Passes a command to the Redis server for direct execution. Use standard redis-cli syntax.

CreateSchema

Creates a custom schema file based on the specified columns.

Define Tables Manually

It is also possible to define the fields and patterns of a table directly using the connector's CreateSchema stored procedure. The table definitions generated by CreateSchema are plain text configuration files that are easy to extend.

To create a schema, you can invoke the CreateSchema procedure using EXECUTE. It accepts these five parameters:

  • TableName is the name of the table to be created.
  • KeyPattern contains a key pattern as described in rpgusingproperties.
  • Columns contains a column separated list of names, not including RedisKey. These will be used as the attributes of any hashes inserted into the table.
  • Description is optional, and contains a free-form note about the table. If not provided, it will be left blank.
  • OutputFolder is optional, and contains the path of the folder the schema file is written to. If not provided, the Location connection property is used.

For example, you can create a basic schema using a query like this:

EXECUTE CreateSchema TableName = 'users', KeyPattern = 'user:*', Columns = 'name,email,password'

Once a schema has been defined, it can be used as a table in SELECT, INSERT, UPDATE or DELETE statements. Any values inserted into the table will be formatted as hashes. For example, the query:

INSERT INTO users (RedisKey, name, email, password) VALUES ('user:1000', 'John Smith', 'john.smith@example.com', 's3cret')

Will generate this Redis command:

hmset user:1000 name "John Smith" email "john.smith@example.com" password "s3cret"
Input
Name Type Required Description
TableName String True The name for the new table.
KeyPattern String True The Redis Key pattern for table.
Columns String True A comma-separated list of columns to include in the schema file.
Description String False An optional description for the table.
WriteToFile String False Whether to write the contents of this stored procedure to a file or not (Default = true) needs to be set to false to output FileStream of FileData
Result Set Columns
Name Type Description
Success String Whether or not the schema was created successfully.
SchemaFile String The generated schema file.
FileData String File data that will be outputted encoded in Base64 if the WriteToFile=False and FileStream inputs are not set.

RunBatchCommand

Sequentially executes a batch of Redis commands using either a temporary table or a batch file.

Batch commands are much more efficient because the connector does not need to send and wait for single commands to complete. Instead, the connector will send several commands and wait for them as a group.

Method 1: Batch File

Create a text document and populate it with one Redis command per line without any delimiters. Empty lines are skipped.

For example:

set key1 value1
set key2 value2
set key3 value3

Then, invoke the procedure with the path to the file supplied in the CommandFile input.

EXECUTE RunBatchCommand CommandFile = "C:\Users\username\Public Documents\batchfile.txt"
TEMP Tables

Populate a temporary table with Redis commands.

INSERT INTO Commands#TEMP (CommandLine) VALUES ("rpush mylist value1")
INSERT INTO Commands#TEMP (CommandLine) VALUES ("rpush mylist value2")
INSERT INTO Commands#TEMP (CommandLine) VALUES ("rpush mylist value3")

Then, invoke the procedure with the name of the temporary table provided in the CommandTable input.

EXECUTE RunBatchCommand CommandTable = "Commands#TEMP"
Input
Name Type Required Description
CommandTable String False Specifies a temporary table to be used in generating a batch of Redis commands for direct execution on the Redis server.
CommandFile String False The path to a file containing a batch of Redis commands. These commands will be sequentially and directly executed on the Redis server.
KeyType String False The format for the Redis server output. 'AUTO' returns the keys in list format (nested lists will each be one compound result). 'HASH' returns the keys as a hash (each group is a row, each property gets its own column). The allowed values are AUTO, HASH. The default value is AUTO.
Result Set Columns
Name Type Description
\* String Output will vary for each collection.

RunCommand

Passes a command to the Redis server for direct execution. Use standard redis-cli syntax.

Running Redis Commands Directly

You can use this procedure to run a command directly that isn't exposed by the usual CRUD operations on tables. For example, the FLUSHDB command removes all keys from the current database:

EXECUTE RunCommand @CommandLine = 'FLUSHDB'

You can also run commands which require parameters by separating them with spaces, the same as in redis-cli. Double-quotes are also available if you need to embed spaces into a parameter value:

EXECUTE RunCommand @CommandLine = 'INFO "CPU"'

The connector will process the results of the command and return them in the appropriate format. For cases like FLUSHDB or INFO where the result is a simple value or a flat array, each element will be returned as a separate row.

'# CPU'
'used_cpu_sys:1272.08'
'used_cpu_user:537.84'
'used_cpu_sys_children:4.81'
'used_cpu_user_children:98.89'

More complex results, like the values returned from the COMMAND command, will be separated by row and then converted to JSON for final output.

'["slowlog","-2",[["admin"]],"0","0","0"]'
'["persist","2",[["write","fast"]],"1","1","1"]'
'["zrevrangebylex","-4",[["readonly"]],"1","1","1"]'
'["sinter","-2",[["readonly","sort_for_script"]],"1","-1","1"]'
'["lrange","4",[["readonly"]],"1","1","1"]'
'["hmset","-4",[["write","denyoom","fast"]],"1","1","1"]'
'["lpush","-3",[["write","denyoom","fast"]],"1","1","1"]'
'["zremrangebyscore","4",[["write"]],"1","1","1"]'
'["FT.DICTDEL","-1",[["readonly"]],"1","1","1"]'
...
Input
Name Type Required Description
CommandLine String False The command to pass directly to the Redis server for execution.
KeyType String False The format for the Redis server output. 'AUTO' returns the keys in list format (nested lists will each be one compound result). 'HASH' returns the keys as a hash (each group is a row, each property gets its own column). The allowed values are AUTO, HASH. The default value is AUTO.
Result Set Columns
Name Type Description
\* String Output will vary for each collection.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Redis:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Customers table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Customers table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:redis:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

Property Description
AuthScheme The authentication mechanism that the provider will use to authenticate with Redis.
Server The host name or IP address of the server hosting the Redis instance.
Port The port for the Redis database.
LogicalDatabase The index of the Redis Logical Database.
User The username provided for authentication with Redis ACL.
Password The password used to authenticate with Redis.
EnableCluster This field sets whether the Redis Cluster Mode is enabled.
UseSSL This field sets whether SSL is enabled.
ReplicaSet This property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

Connection

Property Description
DefineTables Define the tables exposed by the provider using table names and Redis key patterns.
PatternSeparator Define the table pattern's delimiter.
ReaderEndpoints The slave hosts and port array, which indicates the Redis Master/Slave cluster's slave instances, are split by a comma.
TablePattern Define the tables exposed by the provider using Redis key patterns.

SSL

Property Description
SSLClientCert The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword The password for the TLS/SSL client certificate.
SSLClientCertSubject The subject of the TLS/SSL client certificate.
SSLStartMode This property determines how the provider starts the SSL negotiation.
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSH

Property Description
SSHAuthMode The authentication method used when establishing an SSH Tunnel to the service.
SSHClientCert A certificate to be used for authenticating the SSHUser.
SSHClientCertPassword The password of the SSHClientCert key if it has one.
SSHClientCertSubject The subject of the SSH client certificate.
SSHClientCertType The type of SSHClientCert private key.
SSHServer The SSH server.
SSHPort The SSH port.
SSHUser The SSH user.
SSHPassword The SSH password.
SSHServerFingerprint The SSH server fingerprint.
UseSSH Whether to tunnel the Redis connection over SSH. Use SSH.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
IgnoreTypeErrors Removes support for the specified data types and ignores casting exceptions for those types.
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
QueryTimeout The 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.
RowScanDepth The maximum number of rows to scan to look for the columns available in a table.
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.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

Authentication

This section provides a complete list of authentication properties you can configure.

Property Description
AuthScheme The authentication mechanism that the provider will use to authenticate with Redis.
Server The host name or IP address of the server hosting the Redis instance.
Port The port for the Redis database.
LogicalDatabase The index of the Redis Logical Database.
User The username provided for authentication with Redis ACL.
Password The password used to authenticate with Redis.
EnableCluster This field sets whether the Redis Cluster Mode is enabled.
UseSSL This field sets whether SSL is enabled.
ReplicaSet This property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

AuthScheme

The authentication mechanism that the provider will use to authenticate with Redis.

Possible Values

Password, ACL, None

Data Type

string

Default Value

Password

Remarks

Choose one of the following:

  • None: Indicates that the Redis instance is not password protected (using the requirepass directive in the configuration file).
  • Password: The connector attempts to connect using the AUTH Redis command, using Password.
  • ACL: The connector authenticates using ACL credentials.

Server

The host name or IP address of the server hosting the Redis instance.

Data Type

string

Default Value

""

Remarks

The host name or IP address of the server hosting the Redis instance.

Port

The port for the Redis database.

Data Type

string

Default Value

6379

Remarks

The port for the Redis database.

LogicalDatabase

The index of the Redis Logical Database.

Data Type

string

Default Value

0

Remarks

The index of the Redis Logical Database. The default value is 0.

User

The username provided for authentication with Redis ACL.

Data Type

string

Default Value

""

Remarks

The username provided for authentication with Redis ACL.

Password

The password used to authenticate with Redis.

Data Type

string

Default Value

""

Remarks

The password used to authenticate with Redis.

EnableCluster

This field sets whether the Redis Cluster Mode is enabled.

Data Type

bool

Default Value

false

Remarks

This field sets whether the Redis Cluster Mode is enabled.

UseSSL

This field sets whether SSL is enabled.

Data Type

bool

Default Value

false

Remarks

This field sets whether the connector will attempt to negotiate TLS/SSL connections to the server. By default, the connector checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.

ReplicaSet

This property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.

Data Type

string

Default Value

""

Remarks

This property only works when EnableCluster is True. This property allows you to specify the other servers in the replica set in addition to the one configured in Server and Port. You must specify all servers in the replica set using ReplicaSet, Server, and Port.

Specify both a server name and port in ReplicaSet; separate servers with a comma. For example:

Server=localhost;Port=6379;ReplicaSet=localhost:6380,localhost:6381;

To find the primary server, the connector queries the servers in ReplicaSet and the server specified by Server and Port.

Connection

This section provides a complete list of connection properties you can configure.

Property Description
DefineTables Define the tables exposed by the provider using table names and Redis key patterns.
PatternSeparator Define the table pattern's delimiter.
ReaderEndpoints The slave hosts and port array, which indicates the Redis Master/Slave cluster's slave instances, are split by a comma.
TablePattern Define the tables exposed by the provider using Redis key patterns.

DefineTables

Define the tables exposed by the provider using table names and Redis key patterns.

Data Type

string

Default Value

""

Remarks

This property is used to define the key pattern within Redis that will appear as tables. 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.

For example:

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.

If there is any conflict between tables defined with this property and those defined by the TablePattern, these statically defined tables will take precedence.

PatternSeparator

Define the table pattern's delimiter.

Data Type

string

Default Value

:

Remarks

This property is used in tandem with TablePattern to define the delimiter character for the pattern, which determines where the table names derived from the key pattern will end.

This is especially useful when there is more than one delimiter in your TablePattern.

For example, if TablePattern is set to *@*:* and there is a key called "first@second:1", a pattern separator of "@" produces the table name "first" and a PatternSeparator of ":" produces the table name "first@second".

Note that the behavior of the pattern separator is greedy, meaning the last instance of the separator character is used to specify the end of the table name.

For example, if there is a key called "first:second:1", a pattern separator of ":" produces the table name "first:second".

ReaderEndpoints

The slave hosts and port array, which indicates the Redis Master/Slave cluster's slave instances, are split by a comma.

Data Type

string

Default Value

""

Remarks

The slave hosts and port array indicate the Redis Master/Slave cluster's slave instances. For example: 'ReaderEndpoints=app:6381,app:6382;'

TablePattern

Define the tables exposed by the provider using Redis key patterns.

Data Type

string

Default Value

*:*

Remarks

This property is used to define the key patterns within Redis that will appear as tables. 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.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLClientCert The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword The password for the TLS/SSL client certificate.
SSLClientCertSubject The subject of the TLS/SSL client certificate.
SSLStartMode This property determines how the provider starts the SSL negotiation.
SSLServerCert The certificate to be accepted from the server when connecting using TLS/SSL.

SSLClientCert

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

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:

Property Description
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).

SSLClientCertType

The type of key store containing the TLS/SSL client certificate.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

Property Description
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.

SSLClientCertPassword

The password for the TLS/SSL client certificate.

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.

SSLClientCertSubject

The subject of the TLS/SSL client certificate.

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.

SSLStartMode

This property determines how the provider starts the SSL negotiation.

Possible Values

Automatic, Implicit, Explicit, None

Data Type

string

Default Value

None

Remarks

The SSLStartMode property may have one of the following values:

Property Description
Automatic If the remote port is set to the standard plain text port of the protocol (where applicable), the connector 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 connector 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.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

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.

SSH

This section provides a complete list of SSH properties you can configure.

Property Description
SSHAuthMode The authentication method used when establishing an SSH Tunnel to the service.
SSHClientCert A certificate to be used for authenticating the SSHUser.
SSHClientCertPassword The password of the SSHClientCert key if it has one.
SSHClientCertSubject The subject of the SSH client certificate.
SSHClientCertType The type of SSHClientCert private key.
SSHServer The SSH server.
SSHPort The SSH port.
SSHUser The SSH user.
SSHPassword The SSH password.
SSHServerFingerprint The SSH server fingerprint.
UseSSH Whether to tunnel the Redis connection over SSH. Use SSH.

SSHAuthMode

The authentication method used when establishing an SSH Tunnel to the service.

Possible Values

None, Password, Public_Key

Data Type

string

Default Value

Password

Remarks
  • None: No authentication is performed. The current User value is ignored, and the connection is logged in as anonymous.
  • Password: The connector uses the values of User and Password to authenticate the user.
  • Public_Key: The connector uses the values of User and SSHClientCert to authenticate the user. SSHClientCert must have a private key available for this authentication method to succeed.

SSHClientCert

A certificate to be used for authenticating the SSHUser.

Data Type

string

Default Value

""

Remarks

SSHClientCert must contain a valid private key in order to use public key authentication. A public key is optional, if one is not included then the connector generates it from the private key. The connector sends the public key to the server and the connection is allowed if the user has authorized the public key.

The SSHClientCertType field specifies the type of the key store specified by SSHClientCert. If the store is password protected, specify the password in SSHClientCertPassword.

Some types of key stores are containers which may include multiple keys. By default the connector will select the first key in the store, but you can specify a specific key using SSHClientCertSubject.

SSHClientCertPassword

The password of the SSHClientCert key if it has one.

Data Type

string

Default Value

""

Remarks

This property is only used when authenticating to SFTP servers with SSHAuthMode set to PublicKey and SSHClientCert set to a private key.

SSHClientCertSubject

The subject of the SSH client certificate.

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 instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed 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.

SSHClientCertType

The type of SSHClientCert private key.

Possible Values

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PPKFILE, PPKBLOB, XMLFILE, XMLBLOB

Data Type

string

Default Value

PEMKEY_FILE

Remarks

This property can take one of the following values:

Types Description Allowed Blob Values
MACHINE/USER Not available on this platform. Blob values are not supported.
JKSFILE/JKSBLOB A Java keystore file. Must contain both a certificate and a private key. Only available in Java. base64-only
PFXFILE/PFXBLOB A PKCS12-format (.pfx) file. Must contain both a certificate and a private key. base64-only
PEMKEY_FILE/PEMKEY_BLOB A PEM-format file. Must contain an RSA, DSA, or OPENSSH private key. Can optionally contain a certificate matching the private key. base64 or plain text. Newlines may be replaced with spaces when providing the blob as text.
PPKFILE/PPKBLOB A PuTTY-format private key created using the puttygen tool. base64-only
XMLFILE/XMLBLOB An XML key in the format generated by the .NET RSA class: RSA.ToXmlString(true). base64 or plain text.

SSHServer

The SSH server.

Data Type

string

Default Value

""

Remarks

The SSH server.

SSHPort

The SSH port.

Data Type

string

Default Value

22

Remarks

The SSH port.

SSHUser

The SSH user.

Data Type

string

Default Value

""

Remarks

The SSH user.

SSHPassword

The SSH password.

Data Type

string

Default Value

""

Remarks

The SSH password.

SSHServerFingerprint

The SSH server fingerprint.

Data Type

string

Default Value

""

Remarks

The SSH server fingerprint.

UseSSH

Whether to tunnel the Redis connection over SSH. Use SSH.

Data Type

bool

Default Value

false

Remarks

By default the connector will attempt to connect directly to Redis. When this option is enabled, the connector will instead establish an SSH connection with the SSHServer and tunnel the connection to Redis through it.

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

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

Data Type

string

Default Value

%APPDATA%\Redis Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.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%\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

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

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 connector.

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. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

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 connector.

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. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
IgnoreTypeErrors Removes support for the specified data types and ignores casting exceptions for those types.
MaxRows Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
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.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
QueryTimeout The 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.
RowScanDepth The maximum number of rows to scan to look for the columns available in a table.
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.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.

IgnoreTypeErrors

Removes support for the specified data types and ignores casting exceptions for those types.

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.

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Other

These hidden properties are used only in specific use cases.

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.

Integration and Formatting
Property Description
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.

ParallelMode

This option sets whether the provider should use multiple connections when connecting to Redis.

Data Type

bool

Default Value

false

Remarks

The default is that parallel mode is disabled, which means that the connector 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 connector 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 connector by using the hidden MaxPageSize property (see Other). The default value is 5, but you can increase it to make the connector faster or decrease it to make the connector use less memory.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

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, "*=*".

QueryTimeout

The 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.

Data Type

string

Default Value

-1

Remarks

The timeout in seconds for which the connector will wait for the query response. The default value is -1, which indicates the connector should never time out.

RowScanDepth

The maximum number of rows to scan to look for the columns available in a table.

Data Type

int

Default Value

50

Remarks

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

TableScanDepth

The maximum number of keys to scan when looking for tables available in your Redis database.

Data Type

string

Default Value

-1

Remarks

Since Redis is schemaless, the connector 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 positive integer to limit the keys scanned to that amount.

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

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 connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.