|
Matillion Data Model for JDBC
|
Connection String OptionsBack To Top
- Access Key
- Auth Scheme
- Auto Cache
- Backwards Compatibility Mode
- Batch Size
- Cache Connection
- Cache Driver
- Cache Location
- Cache Metadata
- Cache Tolerance
- Callback URL
- Connection Life Time
- Connect On Open
- Custom Headers
- Custom Url Params
- Data Model
- Data Source
- Firewall Password
- Firewall Port
- Firewall Server
- Firewall Type
- Firewall User
- Flatten Arrays
- Flatten Objects
- Format
- Generate Schema Files
- Initiate OAuth
- JSON Format
- Kerberos KDC
- Kerberos Keytab File
- Kerberos Realm
- Kerberos SPN
- Location
- Logfile
- Max Log File Count
- Max Log File Size
- Max Rows
- OAuth Access Token
- OAuth Access Token Secret
- OAuth Access Token URL
- OAuth Authorization URL
- OAuth Client Id
- OAuth Client Secret
- OAuth Grant Type
- OAuth Params
- OAuth Refresh Token
- OAuth Refresh Token URL
- OAuth Request Token URL
- OAuth Settings Location
- OAuth Verifier
- OAuth Version
- Offline
- Other
- Password
- Pool Idle Timeout
- Pool Max Size
- Pool Min Size
- Pool Wait Time
- Proxy Auth Scheme
- Proxy Auto Detect
- Proxy Exceptions
- Proxy Password
- Proxy Port
- Proxy Server
- Proxy SSL Type
- Proxy User
- Pseudo Columns
- Readonly
- Region
- Row Scan Depth
- RTK
- Secret Key
- SSL Client Cert
- SSL Client Cert Password
- SSL Client Cert Subject
- SSL Client Cert Type
- SSL Server Cert
- Support Enhanced SQL
- Tables
- Timeout
- URI
- Use Connection Pooling
- Use EC2 Roles
- User
- Verbosity
- Views
- XPath
Access Key
Your AWS account access key. This value is accessible from your AWS security credentials page.Data Type
string
Default Value
""
Remarks
Your AWS account access key. This value is accessible from your AWS security credentials page:
- Sign into the AWS Management console with the credentials for your root account.
- Select your account name or number and select My Security Credentials in the menu that is displayed.
- Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.
Auth Scheme
The scheme used for HTTP authentication. Accepted entries are NTLM, BASIC, DIGEST, NEGOTIATE, or NONE.Data Type
string
Default Value
"NONE"
Remarks
Together with Password and User, this field is used to authenticate against the server. NONE is the default option. Use the following options to select your authentication scheme:
- NTLM: Set this to use your Windows credentials for authentication.
- BASIC: Set this to use HTTP Basic authentication.
- DIGEST: Set this to use HTTP Digest authentication.
- NEGOTIATE: If AuthScheme is set to NEGOTIATE, the driver will negotiate an authentication mechanism with the server. Set AuthScheme to NEGOTIATE if you want to use Kerberos authentication.
Auto Cache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .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 REST 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.
Backwards Compatibility Mode
Set BackwardsCompatibilityMode to true to use the JSON or XML functionality and features available in the 2017 version.Data Type
bool
Default Value
false
Remarks
When set to true, the driver will function the same as the 2017 version and will continue to be supported/improved.
When set to false (default), the new flattening features will be available. This includes DataModel, FlattenArrays, FlattenObjects, as well as the dynamic flattening of tables and columns via a SQL query.
Batch Size
The maximum size of each batch operation to submit.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
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.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 CacheProvider 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
The database driver to be used to cache data.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:rest:CacheLocation='c:/Temp/cachedir';DataModel=Relational;URI=C:\people.xml;Format=XMLTo 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:rest:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';DataModel=Relational;URI=C:\people.xml;Format=XML
SQLite
The following is a JDBC URL for the SQLite JDBC driver:
jdbc:rest:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';DataModel=Relational;URI=C:\people.xml;Format=XML
MySQL
The following is a JDBC URL for the included CData JDBC Driver for MySQL:
jdbc:rest:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';DataModel=Relational;URI=C:\people.xml;Format=XML
The CData JDBC Driver for MySQL is located in the lib subfolder of the CData JDBC Driver for REST 2019 installation directory.
SQL Server
The following JDBC URL uses the Microsoft JDBC Driver for SQL Server:
jdbc:rest:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';DataModel=Relational;URI=C:\people.xml;Format=XML
Oracle
The following is a JDBC URL for the Oracle Thin Client:
jdbc:rest:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';DataModel=Relational;URI=C:\people.xml;Format=XML
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:rest:CacheDriver=org.postgresql.Driver;CacheConnection='jdbc:postgresql://localhost:5433/postgres?user=postgres&password=admin';DataModel=Relational;URI=C:\people.xml;Format=XML
Cache Location
Specifies the path to the cache when caching to a file.Data Type
string
Default Value
"%APPDATA%\\CData\\REST 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\\REST 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 REST catalog in CacheLocation.
Cache Metadata
This property determines whether or not to cache the table metadata to a file store.Data Type
bool
Default Value
false
Remarks
As you execute queries with this property set, table metadata in the REST 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
The tolerance for stale data in the cache specified in seconds when using AutoCache .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.
Callback URL
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.Data Type
string
Default Value
""
Remarks
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
Connection Life Time
The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.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
This property species whether to connect to the REST when the connection is opened.Data Type
bool
Default Value
false
Remarks
When set to true, a connection will be made to REST 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 REST 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).
Custom Headers
Other headers as determined by the user (optional).Data Type
string
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties, like ContentType, From, and so on.
The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by the carriage return and line feed (CRLF) characters.
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for fine-tuning the functionality of the driver to integrate with specialized or nonstandard APIs.
Custom Url Params
The custom query string to be included in the request.Data Type
string
Default Value
""
Remarks
The CustomUrlParams allow you to specify custom query string parameters that are included with the HTTP request. The parameters must be encoded as a query string in the form field1=value1&field2=value2&field3=value3. The values in the query string must be URL encoded.
Data Model
Specifies the data model to use when parsing JSON or XML documents and generating the metadata.Data Type
string
Default Value
"Document"
Remarks
Available values are:
- Document: A single table representing a row per document will be returned. In this data model, any nested documents (object arrays) will not be flattened and will be returned as aggregates. Unless a XPath value is explicitly specified, the driver will identify and use the top-most document (object array) found as the XPath.
- FlattenedDocuments: A single table representing a JOIN of the available documents in the JSON or XML file will be returned. In this data model, nested XPath values will act in the same manner as a SQL JOIN. Additionally nested sibling XPath values (child paths at the same height), will be treated as a SQL CROSS JOIN. Unless explicitly specified, the driver will identify the XPath values available by parsing the JSON or XML file and identifying the available documents (including nested documents).
- Relational: Multiple tables will be returned, one for each XPath value specified. In this data model, any nested documents (object arrays) will be returned as relational tables with primary and foreign keys. Unless explicitly specified, the driver will identify the XPath values available by parsing the JSON or XML file and identifying the available documents (including nested documents).
The XPath property can be used to customize these data models by explicitly specifying the paths to the documents you want to include.
It is possible to horizontally flatten the data via the FlattenArrays and FlattenObjects properties. This enables customization of the columns that will be identified for each of these data models.
Data Source
This property specifies a URI for the REST resource location.Data Type
string
Default Value
""
Remarks
This property specifies a URI for the REST resource location.
This property is an alias to the URI property. Below are examples of the URI formats for different data sources:
| Service provider | URI formats | |
| Local | localPath/file.json
file://localPath/file.json | |
| HTTP or HTTPS | http://remoteStream
https://remoteStream | |
| Amazon S3 | s3://remotePath/file.json | |
| Google Drive | gdrive://remotePath/file.json | |
| Box | box://remotePath/file.json | |
| FTP or FTPS | ftp://server:port/remotePath/file.json
ftps://server:port/remotepath/file.json |
Example Connection Strings
Below are example connection strings to REST files or streams. See Establishing a Connection for more information about connecting to the available data sources.
| Service provider | Connection example | Query example (if folder1 contains file1.json or streamname1 is a JSON stream) |
| Local | URI=C:\folder1\file.json; | SELECT * FROM file1 |
| HTTP or HTTPS | URI=http://www.host1.com/streamname1; | SELECT * FROM streamedtable |
| Amazon S3 | URI=s3://bucket1/folder1/file.json; AccessKey=token1; SecretKey=secret1; Region=OHIO; | SELECT * FROM file1 |
| Google Drive | URI=gdrive://folder1/file.json;InitiateOAuth=GETANDREFRESH; | |
| Box | URI=box://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345; | SELECT * FROM file1 |
| FTP or FTPS | URI=ftps://localhost:990/folder1/file.json; User=user1; Password=password1; | SELECT * FROM file1 |
Firewall Password
A password used to authenticate to a proxy-based firewall.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
The TCP port for a proxy-based firewall.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
The name or IP address of a proxy-based firewall.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. Use ProxyServer to connect to an HTTP proxy.
Note that the driver uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
Firewall Type
The protocol used by a proxy-based firewall.Data Type
string
Default Value
"NONE"
Remarks
This property specifies the protocol that the driver will use to tunnel traffic through the FirewallServer proxy. Note that by default, the driver connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the driver opens a connection to REST 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. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Firewall User
The user name to use to authenticate with a proxy-based firewall.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.
Flatten Arrays
By default, nested arrays are returned as strings of JSON or XML. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.Data Type
string
Default Value
""
Remarks
By default, nested arrays are returned as strings of JSON or XML. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. This is only recommended for arrays that are expected to be short.
Set FlattenArrays to the number of elements you want to return from nested arrays. The specified elements are returned as columns. The zero-based index is concatenated to the column name. Other elements are ignored.
For example, you can return an arbitrary number of elements from an array of strings:
["FLOW-MATIC","LISP","COBOL"]When FlattenArrays is set to 1, the preceding array is flattened into the following table:
| Column Name | Column Value |
| languages.0 | FLOW-MATIC |
Setting FlattenArrays to -1 will flatten all the elements of nested arrays.
Flatten Objects
Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON or XML.Data Type
bool
Default Value
true
Remarks
Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON or XML. To generate the column name, the driver concatenates the property name onto the object name with a dot.
For example, you can flatten the nested objects below at connection time:
[
{ "grade": "A", "score": 2 },
{ "grade": "A", "score": 6 },
{ "grade": "A", "score": 10 },
{ "grade": "A", "score": 9 },
{ "grade": "B", "score": 14 }
]
When FlattenObjects is set to true and FlattenArrays is set to 1, the preceding array is flattened into the following table:
| Column Name | Column Value |
| grades.0.grade | A |
| grades.0.score | 2 |
Format
The Format property specifies whether the data from the REST data source is in XML or JSON format.Data Type
string
Default Value
"JSON"
Remarks
This property is required when using the CreateSchema stored procedure or use the Generate Schema File feature (Set GenerateSchemFiles to OnStart or OnUse)
Generate Schema Files
Specifies whether to generate a schema file (RSD) from the parsed document.Data Type
string
Default Value
"Never"
Remarks
Available values are:
- Never: A schema file (RSD) will never be generated.
- OnUse: A schema file (RSD) will be generated the first time a table is referenced, provided the schema file (RSD) for the table does not already exist.
- OnStart: A schema file (RSD) will be generated at connect time for any tables that do not currently have a schema file (RSD).
This property is used in conjuction with Format, URI, XPath, and Location. URI is used to specify the location of the document to parse and XPath is used to define the location in the XML/JSON document that will make up the rows in the table (in which the columns are determined). Location is used to specify the folder location where the schema file (RSD) will be written.
The CreateSchema stored procedure can be called directly to generate a schema file (RSD) as well.
Initiate OAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.Data Type
string
Default Value
"OFF"
Remarks
The following options are available:
- OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
- GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the driver. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
- REFRESH: Indicates that the driver will only handle refreshing the OAuthAccessToken. The user will never be prompted by the driver to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
JSON Format
Specifies the format of the JSON document.Data Type
string
Default Value
"JSON"
Remarks
This option allows you to specify the format of the JSON document which enables parsing specifically for the selected format.
JSON Formats
The following JSONFormat configurations are available.
-
JSON
This is the default format and should be used in the majority of cases.
-
JSONRows
This is a specific format in which data is returned in a relational format consisting of rows of data contained within primitive arrays. Column information is returned as well in a separate array.
Note: DataModel does not apply when using this JSONFormat.
Example:
{ "dataset": { "column_names": [ "Name", "Age", "Gender" ], "data": [ [ "John Doe", 37, "M" ], [ "David Thomas", 25, "M" ] ] } }The XPath property requires special syntax to identify the column and row paths. The syntax consists of specifying a path for each using a "column:" and "row:" prefix. Using the example above, the XPath would be set to: column:$.dataset.column_names;row:$.dataset.data
In the case that columns are returned in an object with additional data, an additional "columnname:" prefix can be specified to identify the path to the value containing the column name.
Example:
{ "columns": [ { "name":"first_name", "type":"text" }, { "name":"last_name", "type":"text" } ], "rows": [ [ "John", "Doe" ], [ "David", "Thomas" ] ] }In the above example, XPath would be set to: column:$.columns;columnname:$.columns.name;row:$.rows
Kerberos KDC
The Kerberos Key Distribution Center (KDC) service used to authenticate the user.Data Type
string
Default Value
""
Remarks
The Kerberos properties are used when using Windows Authentication. The driver will request session tickets and temporary session keys from the Kerberos KDC service. The Kerberos KDC service is conventionally colocated with the domain controller. If Kerberos KDC is not specified, the driver will attempt to detect these properties automatically from the following locations:
- Java System Properties: Kerberos settings can be configured in Java using the configuration file krb5.conf, or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The driver will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
- Domain Name and Host: The driver will infer the Kerberos Realm and Kerberos KDC from the configured domain name and host as a last resort.
Kerberos Keytab File
The Keytab file containing your pairs of Kerberos principals and encrypted keys.Data Type
string
Default Value
""
Remarks
The Keytab file containing your pairs of Kerberos principals and encrypted keys.
Kerberos Realm
The Kerberos Realm used to authenticate the user with.Data Type
string
Default Value
""
Remarks
The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is based on the domain name. If Kerberos Realm is not specified the driver will attempt to detect these properties automatically from the following locations:
- Java System Properties: Kerberos settings can be configured in Java using a configuration file (krb5.conf) or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The driver will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.
- Domain Name and Host: The driver will infer the Kerberos Realm and Kerberos KDC from the user-configured domain name and host as a last resort. This might work in some Windows environments.
Kerberos SPN
The service principal name (SPN) for the Kerberos Domain Controller.Data Type
string
Default Value
""
Remarks
If the SPN on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, use this property to set the SPN.
Location
A path to the directory that contains the schema files defining tables, views, and stored procedures.Data Type
string
Default Value
""
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\\REST 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
A path to the log file.Data Type
string
Default Value
""
Remarks
For more control over what is written to the log file, you can adjust its Verbosity.
Max Log File Count
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.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
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.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
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.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.
OAuth Access Token
The access token for connecting using OAuth.Data Type
string
Default Value
""
Remarks
The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuth Access Token Secret
The OAuth access token secret for connecting using OAuth.Data Type
string
Default Value
""
Remarks
The OAuthAccessTokenSecret property is used to connect and authenticate using OAuth. The OAuthAccessTokenSecret is retrieved from the OAuth server as part of the authentication process. It is used with the OAuthAccessToken and can be used for multiple requests until it times out.
OAuth Access Token URL
The URL to retrieve the OAuth access token from.Data Type
string
Default Value
""
Remarks
The URL to retrieve the OAuth access token from. In OAuth 1.0, the authorized request token is exchanged for the access token at this URL.
OAuth Authorization URL
The authorization URL for the OAuth service.Data Type
string
Default Value
""
Remarks
The authorization URL for the OAuth service. At this URL, the user logs into the server and grants permissions to the application. In OAuth 1.0, if permissions are granted, the request token is authorized.
OAuth Client Id
The client ID assigned when you register your application with an OAuth authorization server.Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuth Client Secret
The client secret assigned when you register your application with an OAuth authorization server.Data Type
string
Default Value
""
Remarks
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
OAuth Grant Type
The grant type for the OAuth flow.Data Type
string
Default Value
"CODE"
Remarks
The grant type for the OAuth flow. The following options are available: CODE,CLIENT,PASSWORD
OAuth Params
A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.Data Type
string
Default Value
""
Remarks
A comma-separated list of other parameters to submit in the request for the OAuth access token in the format paramname=value.
OAuth Refresh Token
The OAuth refresh token for the corresponding OAuth access token.Data Type
string
Default Value
""
Remarks
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuth Refresh Token URL
The URL to refresh the OAuth token from.Data Type
string
Default Value
""
Remarks
The URL to refresh the OAuth token from. In OAuth 2.0, this URL is where the refresh token is exchanged for a new access token when the old access token expires.
OAuth Request Token URL
The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0.Data Type
string
Default Value
""
Remarks
The URL the service provides to retrieve request tokens from. This is required in OAuth 1.0. In OAuth 1.0, this is the URL where the app makes a request for the request token.
OAuth Settings Location
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.Data Type
string
Default Value
"%APPDATA%\\CData\\REST Data Provider\\OAuthSettings.txt"
Remarks
When InitiateOAuth is set to GETANDREFRESH or REFRESH, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.
Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.
If left unspecified, the default location is "%APPDATA%\\CData\\REST Data Provider\\OAUthSesttings.txt" 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 |
OAuth Verifier
The verifier code returned from the OAuth authorization URL.Data Type
string
Default Value
""
Remarks
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines
See Getting Started to obtain the OAuthVerifier value.
Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the driver exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuth Version
The version of OAuth being used.Data Type
string
Default Value
"Disabled"
Remarks
The version of OAuth being used. The following options are available: Disabled,1.0,2.0
Offline
Use offline mode to get the data from the cache instead of the live source.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
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.
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. |
Password
The password used to connect to a remote data source using HTTP.Data Type
string
Default Value
""
Remarks
Specifies a password for authentication when accessing remote feeds or servers.
Pool Idle Timeout
The allowed idle time for a connection before it is closed.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
The maximum connections in the pool.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
The minimum number of connections in the pool.Data Type
string
Default Value
"1"
Remarks
The minimum number of connections in the pool. The default is 1.
Pool Wait Time
The max seconds to wait for an available connection.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.
Proxy Auth Scheme
The authentication type to use to authenticate to the ProxyServer proxy.Data Type
string
Default Value
"BASIC"
Remarks
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the driver will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
- BASIC: The driver performs HTTP BASIC authentication.
- DIGEST: The driver performs HTTP DIGEST authentication.
- NEGOTIATE: The driver retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
- PROPRIETARY: The driver does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Proxy Auto Detect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.Data Type
bool
Default Value
false
Remarks
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
NOTE: When this property is set to True, the proxy used is determined as follows:
- A search from the JVM properties (http.proxy, https.proxy, socksProxy, etc.) is performed.
- In the case that the JVM properties don't exist, a search from java.home/lib/net.properties is performed.
- In the case that java.net.useSystemProxies is set to True, a search from the SystemProxy is performed.
- In Windows only, an attempt is made to retrieve these properties from the Internet Options in the registry.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Proxy Exceptions
A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .Data Type
string
Default Value
""
Remarks
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the driver uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
Proxy Password
A password to be used to authenticate to the ProxyServer proxy.Data Type
string
Default Value
""
Remarks
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the driver uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
Proxy Port
The TCP port the ProxyServer proxy is running on.Data Type
string
Default Value
"80"
Remarks
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
Proxy Server
The hostname or IP address of a proxy to route HTTP traffic through.Data Type
string
Default Value
""
Remarks
The hostname or IP address of a proxy to route HTTP traffic through. The driver can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the driver uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
Proxy SSL Type
The SSL type to use when connecting to the ProxyServer proxy.Data Type
string
Default Value
"AUTO"
Remarks
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the driver will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Proxy User
A user name to be used to authenticate to the ProxyServer proxy.Data Type
string
Default Value
""
Remarks
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
Pseudo Columns
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, "*=*".
Readonly
You can use this property to enforce read-only access to REST from the provider.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.
Region
The hosting region for your Amazon Web Services.Data Type
string
Default Value
"NORTHERNVIRGINIA"
Remarks
The hosting region for your Amazon Web Services. Available values are NORTHERNVIRGINIA, OHIO, NORTHERNCALIFORNIA, OREGON, CENTRAL, IRELAND, FRANKFURT, LONDON, SINGAPORE, SYDNEY, SEOUL, TOKYO, MUMBAI, SAOPAULO, and BEIJING.
Row Scan Depth
The number of rows to scan when dynamically determining columns for the table.Data Type
string
Default Value
"100"
Remarks
The number of rows to scan when dynamically determining columns for the table. Columns are dynamically determined when a schema (RSD) file is not available for the table, such as when using GenerateSchemaFiles.
Higher values will result in a longer request, but will be more accurate.
Setting this value to 0 (zero) will parse the entire document.
RTK
The runtime key used for licensing.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.
Secret Key
Your AWS account secret key. This value is accessible from your AWS security credentials page.Data Type
string
Default Value
""
Remarks
Your AWS account secret key. This value is accessible from your AWS security credentials page:
- Sign into the AWS Management console with the credentials for your root account.
- Select your account name or number and select My Security Credentials in the menu that is displayed.
- Click Continue to Security Credentials and expand the Access Keys section to manage or create root account access keys.
SSL Client Cert
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:
| 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
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.
SSL Client Cert Subject
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.
SSL Client Cert Type
The type of key store containing the TLS/SSL client certificate.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
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.
Support Enhanced SQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.Data Type
bool
Default Value
true
Remarks
When SupportEnhancedSQL = true, the driver offloads as much of the SELECT statement processing as possible to REST 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 REST 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.
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 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.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.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.
URI
This property specifies a URI for the JSON or XML resource location.Data Type
string
Default Value
""
Remarks
This property specifies a URI for the JSON or XML resource location. Set the URI property to specify one of the following sources:
- An empty value automatically assigns the URI to a reference to the current directory, "./". The explicit path to the JSON or XML folders depends on the environment of the running application.
- A path to a folder.
- A path to a file or stream - in this case you can query the file by executing SELECT * FROM streamedtable.
This property is an alias to the DataSource property. Below are examples of the URI formats for different data sources:
Example Connection Strings and Queries
Below are example connection strings to JSON or XML files or streams. See Connecting to REST Data Sources for more information on connecting.
| Service provider | URI formats | Connection example | Query example (if folder1 contains file1.JSON or streamname1 is a JSON stream) |
| Local | localPath
file://localPath/file.json | URI=C:\folder1\file.json; | SELECT * FROM file1 |
| HTTP or HTTPS | http://remoteStream
https://remoteStream | URI=http://www.host1.com/streamname1; | SELECT * FROM streamedtable |
| Amazon S3 | s3://bucket1/folder1/file.json | URI=s3://bucket1/folder1/file.json; AccessKey=token1; SecretKey=secret1; Region=OHIO; | SELECT * FROM file1 |
| Google Drive | gdrive://remotePath/file.json | URI=gdrive://folder1/file.json;InitiateOAuth=GETANDREFRESH; | SELECT * FROM file1 |
| Box | box://remotePath/file.json | URI=box://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345; | SELECT * FROM file1 |
| FTP or FTPS | ftp://server:port/remotePath/file.json
ftps://server:port/remotepath/file.json | URI=ftps://localhost:990/folder1/file.json; User=user1; Password=password1; | SELECT * FROM file1 |
Use Connection Pooling
This property enables 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 EC2 Roles
A boolean indicating if you would like to use EC2 credentials when reading files from Amazon S3.Data Type
bool
Default Value
false
Remarks
This property takes advantage of using EC2 roles. If the CData JDBC Driver for REST 2019 is running on an EC2 instance and the instance has an IAM Role assigned to it, the role can be used without any other credentials specified. When UseEC2Roles is set to true, other authentication credentials will be ignored. This connection property should not be used when connecting from outside of an EC2 instance.
To obtain the EC2 Role credentials, the driver will query the EC2 Instance Metadata to obtain the current EC2 Role and obtain temporary security credentials for the role. The driver will internally set the AccessKey and SecretKey properties, along with the 'x-amz-security-token' header to authenticate to S3. Note: the driver will renew the credentials once they expire.
To use temporary credentials obtained using external means, the access key, secret key, and token must first be obtained. These values can then be set to the following connection properties:
- Access Key - AccessKey
- Secret Key - SecretKey
- Token - SecurityToken set via Other (Other='SecurityToken=mytoken')
User
The username that will be used to connect to a remote data source using HTTP.Data Type
string
Default Value
""
Remarks
Specifies a username for authentication when accessing remote feeds or servers.
Verbosity
The verbosity level that determines the amount of detail included in the log file.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, such as HTTP headers. |
| 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
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 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.
XPath
The XPath of an element that repeats at the same height within the XML/JSON document (used to split the document into multiple rows).Data Type
string
Default Value
""
Remarks
This parameter specifies the XPath (or JSONPath syntax) of an element that has the same name as other elements at the same height.
Multiple paths can be specified using a semi-colon separated list. DataModel allows you to configure how the XPath values will be used to create tables and display data.
If left empty, the CData JDBC Driver for REST 2019 will determine the XPaths by parsing the REST document and identifying the object arrays.
This property will be used to generate the schema definition when a schema file (RSD) file is not present.