Teradata Connector and Link Properties | QueryGrid - Teradata Connector and Link Properties - Teradata QueryGrid

QueryGrid™ Installation and User Guide - 3.06

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata QueryGrid
Release Number
3.06
Published
December 2024
ft:locale
en-US
ft:lastEdition
2024-12-07
dita:mapPath
ndp1726122159943.ditamap
dita:ditavalPath
ft:empty
dita:id
lxg1591800469257
lifecycle
latest
Product Category
Analytical Ecosystem
When you create links and associated properties in the QueryGrid portlet, you are creating Configuration Name Value Pairs (NVP). NVP does the following:
  • Specifies the behavior of the target connector component
  • Configures how data is transformed
  • Configures the underlying link data transportation layer
  • Affects how the initiator connector performs

Links are named configurations that include an initiating connector and a target connector. If the same property is set for a link and a connector, the link setting overrides the connector setting.

Properties may be available for initiating connectors only, target connectors only, or both.

Basic Tab

Teradata Connector
Name Default Description Overridable?

Property Name

Connector Type
Server None Used to connect to the target database as part of the JDBC connection string. This is the IP address or DNS name of the target host.   Target
Port 1025 Default value for a Teradata connector is 1025.

Valid values are 1025–65535. The default value can be overridden.

  Target
Analytics Database JDBC JAR Path /usr/tdbms/bin/terajdbc4.jar Specifies the absolute path (jdbcJar) to the Analytics Database JDBC JAR file (terajdbc4.jar) to use for the JDBC connection of a target connector.   Target
Analytics Database GSS JAR Path /usr/tdbms/bin/tdgssconfig.jar Specifies the absolute path (gssJar) to the Analytics Database GSS JAR file (tdgssconfig.jar) to use for the JDBC connection of a target connector.   Target

Security Tab

Teradata Connector
Name Default Description Overridable?

Property Name

Connector Type
Authentication Mechanism Trusted Indicates the authentication mechanism used on the target data source.

Values are Trusted, TD2, Kerberos, Kerberos SSO, JWT SSO, TDNEGO, and LDAP.

This is a required setting.

  Target
Username DBC

Name of the user.

Maximum length is 255 characters. A username added for a connector or target connector link must be included in Allowed OS users.

This NVP is saved in the QueryGrid Manager configuration and is required when the initiator does not support a mechanism to provide user credentials. The username is also used for connectivity diagnostic checks.

  Target
Use Trusted False Use trusted sessions to impersonate the end user.   Target
Password None User password.

Maximum length is 255 characters.

  Target
Realm None Kerberos realm.   Target
Role Support False Enable user role support for the target system. When set to true, the user role from the initiator or target based on role mapping is applied to the target system and any errors are returned back to the user. When set to false, roles are not applied to the target system.

roleSupport

Target
JDBC Communication over TLS False When set to true, this enables JDBC communication over the HTTPS/TLS port.   Target
TLS Port 443 Port number for HTTPS/TLS   Target
IdP URL None IdP URL to perform the token exchange.   Target
IdP Client ID None Client ID for the target user configured in IdP.   Target
IdP Client Secret None Client secret for the target user configured in IdP.   Target
IdP Grant Type On Behalf Of Grant type for token exchange.   Target
IdP Scope None Specifies the scope of the access token to request.   Target
IdP Audience None Specifies the resource name to access using the exchanged token.   Target

Query Engine Tab

Teradata Connector
Name Default Description Overridable?

Property Name

Connector Type
Validate Unsupported Unicode Characters False Validate unsupported Unicode character when importing data by a Teradata connector.
If you are using Unicode Pass Through characters, do not set this property to true.

See Replace Unsupported Unicode Character.

validateUnsupportedUC

Initiator, Target
Replace Unsupported Unicode Character False Replaces unsupported Unicode characters with U+FFFD, when importing data by a Teradata connector.
If you are using Unicode Pass Through characters, do not set this property to true.

See Validate Unsupported Unicode Characters.

replaceUnsupportedUC

Initiator, Target
Enable Async Abort False Indicates if PDE asynchronous abort should be enabled.   Initiator, Target

Advanced Tab

Teradata Connector
Name Default Description Overridable?

Property Name

Connector Type
Temporary Database Name None Specified database name for creating temporary tables/views.

If you do not provide a database name in this property, QueryGrid creates the temporary view in the default database assigned to the user.

tempDbName

Target
Enable Logging Info Logging level for the connector or link properties. User level log settings can be explicitly set through the add or edit link page in the QueryGrid portlet.

This setting applies to both the initiating and target connector; however, the logging level for the initiating connector in the link takes precedence if they are set differently.

Valid values are NONE, WARN, INFO, and DEBUG.

  Initiator, Target
Enable Query Logging True

When set to true, QueryGrid logs query text in your local drive. When set to false, query text is not logged. Selecting false prevents sensitive customer data from potentially being saved outside the database for compliant environments, such as Teradata VantageCloud Lake.

  Target
Disable Pushdown False When set to true, disables the pushdown of all query conditions to the target system.

Certain system-level, session-level, and column-level query attributes, such as CASESPECIFIC, can affect character string comparison results. These attributes can cause some queries to return incorrect results due to incorrect row filtering on the target system.

To avoid incorrect results caused by condition pushdown in situations where the settings on the initiating system do not match the settings on the target system, you can disable the pushdown of all conditions to the target system.

If set to Overridable, this property can only be overridden at the session level from false to true (indicating you are disabling pushdown), but cannot be changed from true to false.

disablePushdown

Initiator
Byte Count Report Frequency 640K Frequency with which byte count is updated in DBQL. You can adjust this to a larger value if the update frequency is too resource intensive.

byteCountReportFrequency

Initiator, Target
Default Push Profile None Teradata, Presto, or Hive default push profile used with the Remote Table Optimization (RTO) feature

This push profile is used if there is no custom push profile.

defaultPushProfile

Initiator
Custom Push Profile None Teradata, Presto, or Hive custom push profile used with the Remote Table Optimization (RTO) feature

This custom push profile overrides a default push profile.

customPushProfile

Initiator
Link Buffer Count 4 Maximum number of write buffers available on a single channel at one time.
Link Buffer Count overrides the default internal fabric property shmDefaultNumMemoryBuffers.

Valid values are 2–16.

linkBufferCount

Initiator, Target
Link Buffer Size 1048576 Maximum size of the write buffers to allocate for row handling and message exchange.

Valid values are 73728– 10485760 bytes.

linkBufferSize

Initiator
Response Timeout 86400000 The number of milliseconds to wait for the target query to complete before timing out and stopping the operation. The fabric stops and releases all resources associated with queries whose duration exceeds the value set on the target link properties or the target connector properties. Connectors timeout when responses from the fabric exceed their response timeout value.

Valid values are 300000–172800000.

responseTimeout

Initiator, Target
Connection Max Idle Time 86400 seconds The maximum idle time for the connection cache object, after which the object is closed and removed from the cache. Use this property when there are multiple concurrent users and queries running on the system that might lead to starvation of connection objects.

Valid values are 1–86400 seconds.

  Target
Connection Pool Size 100 Maximum number of connection objects that can be stored in a connection pool. When acquiring a new connection, the connector checks for an available space in the pool. If no space is available in the connection pool, the connection fails after 5 minutes. Only one connection pool and username per connector configuration is allowed.

Valid values are 1–10000.

  Target
Connection Evict Frequency 30 minutes Frequency of eviction checks. Connection objects from the pool are checked, closed, and removed if the idle time (current time - last time of use) of a connection object is greater than the Connection Max Idle Time setting.

Reduce the time between checks if there are multiple concurrent users running queries to clear the connections more frequently.

Valid values are 1–1440 minutes.

  Target