The CData Sync App provides a straightforward way to continuously pipeline your Teradata data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Teradata connector can be used from the CData Sync application to pull data from Teradata and move it to any of the supported destinations.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
The Sync App wraps the official Teradata Database driver; you can connect to the CData Sync App using the same connection properties and access the same functionality as the underlying Teradata driver.
To connect to Teradata, provide the following authentication information and specify the database server name.
This section details a selection of advanced features of the Teradata Sync App.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies. You can also set up tunnel connections.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
Set the following properties:
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| DataSource | The Teradata server name or, equivalently, the DBC Name or TDPID. |
| AuthScheme | Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities. |
| User | The Teradata user account used to authenticate. |
| Password | The password used to authenticate the user. |
| Database | The database selected as the default database when a Teradata connection is opened. |
| Port | Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025. |
| Account | Specifies an account string to override the default account string defined for the Teradata Database user. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| LogModules | Core modules to be included in the log file. |
| 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. |
| Property | Description |
| DisableAutoCommitInBatch | Specifies whether or not disable the autocommit when executing the batch operation. |
| HttpsPort | Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections. |
| 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. |
| QueryPassthrough | This option passes the query to the Teradata server as is. |
| SslCa | Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
| SslCaPath | Specifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
| SslMode | Specifies the mode for connections to the database. |
| SslProtocol | Specifies the TLS protocol for HTTPS/TLS connections. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UpperCaseIdentifiers | This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. |
| UseXViews | Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| DataSource | The Teradata server name or, equivalently, the DBC Name or TDPID. |
| AuthScheme | Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities. |
| User | The Teradata user account used to authenticate. |
| Password | The password used to authenticate the user. |
| Database | The database selected as the default database when a Teradata connection is opened. |
| Port | Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025. |
| Account | Specifies an account string to override the default account string defined for the Teradata Database user. |
The Teradata server name or, equivalently, the DBC Name or TDPID.
The Teradata server name or, equivalently, the DBC Name or TDPID.
Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities.
Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities
The Teradata user account used to authenticate.
Together with Password, this field is used to authenticate against the Teradata server.
The password used to authenticate the user.
The User and Password are together used to authenticate with the server.
The database selected as the default database when a Teradata connection is opened.
The database selected as the default database when a Teradata connection is opened.
Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025.
Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025.
Specifies an account string to override the default account string defined for the Teradata Database user.
Specifies an account string to override the default account string defined for the Teradata Database user. Accounts are used by the Teradata Database for workload management and resource usage monitoring.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Sync App opens a connection to Teradata and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Sync App 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 Sync App 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. |
The name or IP address of a proxy-based firewall.
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.
The TCP port for a proxy-based firewall.
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.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| 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. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.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\\Teradata Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
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.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
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.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| DisableAutoCommitInBatch | Specifies whether or not disable the autocommit when executing the batch operation. |
| HttpsPort | Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections. |
| 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. |
| QueryPassthrough | This option passes the query to the Teradata server as is. |
| SslCa | Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
| SslCaPath | Specifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. |
| SslMode | Specifies the mode for connections to the database. |
| SslProtocol | Specifies the TLS protocol for HTTPS/TLS connections. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UpperCaseIdentifiers | This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. |
| UseXViews | Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. |
Specifies whether or not disable the autocommit when executing the batch operation.
Specifies whether or not disable the autocommit when executing the batch operation.
Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections.
The default port is 443 for HTTPS/TLS connections to the database. HTTPS/TLS connections are available with Teradata JDBC Driver 17.10.00.07 and later, with Teradata Advanced SQL Engine 17.10 and later, or Teradata Advanced SQL Engine 16.20.53.30 and later.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
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.
| 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. |
This option passes the query to the Teradata server as is.
When this is set, queries are passed through directly to Teradata.
Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
Specifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. HTTPS/TLS connections are available with Teradata JDBC Driver 17.10.00.07 and later, with Teradata Advanced SQL Engine 17.10 and later, or Teradata Advanced SQL Engine 16.20.53.30 and later.
Specifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
Specifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL. Only files with an extension of .pem are used. Other files in the specified directory are not used. HTTPS/TLS connections are available with Teradata JDBC Driver 17.10.00.07 and later, with Teradata Advanced SQL Engine 17.10 and later, or Teradata Advanced SQL Engine 16.20.53.30 and later.
Specifies the mode for connections to the database.
Specifies the mode for connections to the database. HTTPS/TLS connections are available with Teradata JDBC Driver 17.10.00.07 and later, with Teradata Advanced SQL Engine 17.10 and later, or Teradata Advanced SQL Engine 16.20.53.30 and later.
Specifies the TLS protocol for HTTPS/TLS connections.
Specifies the TLS protocol for HTTPS/TLS connections. HTTPS/TLS connections are available with Teradata JDBC Driver 17.10.00.07 and later, with Teradata Advanced SQL Engine 17.10 and later, or Teradata Advanced SQL Engine 16.20.53.30 and later.
The value in seconds until the timeout error is thrown, canceling the operation.
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 Sync App throws an exception.
This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
Set this property to report all identifiers, including table and column names, in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. For example, you can use this property to avoid quoting identifiers.
Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods.
Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. When the user does not specify the property, the driver creates the connection. The official driver uses the default value.