- Specifies the behavior of the target connector component
- Configures how data is transformed
- Configures the underlying link data transportation layer
Links are named configurations that include the target connector. If the same property is set for a link and a connector, the link setting overrides the connector setting.
- CLIENT. Teradata Fabric connects outbound to a remote Arrow Flight SQL server.
- SERVER. Teradata Fabric exposes the Teradata database as an Arrow Flight SQL server for remote clients.
Basic Tab
| Arrow Flight Connector | |||
|---|---|---|---|
| Name | Default | Description | Overridable? Property Name |
| Flight Server | None | The IP address or DNS name of the Arrow Flight SQL server for the target database. This is a required property and supports only a single entry. |
|
| Flight Server Port | None | The port number of the Arrow Flight SQL server for the target database. | |
| Execution Type | CLIENT | Supports only the CLIENT run type. Meaning, the Arrow Flight SQL connector can initiate communication with the target Arrow Flight SQL server for the database, but cannot receive calls from a remote Arrow Flight SQL database.
|
|
| Authentication Mechanism | Username/Password | Lists the security method used on the target system. Valid values are username/password, OAuth 2.0, PAT, and OIDC SSO. |
|
Query Engine Tab
| Arrow Flight Connector | |||
|---|---|---|---|
| Name | Default | Description | Overridable? Property Name |
| 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 |
| 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 Teradata Fabric portlet. Valid values are NONE, WARN, INFO, and DEBUG. |
|
| Number of Transfer Threads | 5 | Number of threads used for uploading or downloading data in a single request on a node. Valid values are 1-100. More threads mean a higher CPU load. |
● numberOfTransferThread |
| 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 |
| 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 |
| Export Workers Count | 2 | Maximum number of worker threads per driver instance used for data transfer. Valid values are 1–5 |
● exportWorkersCount |
| 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. | |
General Tab
| Arrow Flight Connector | |||
|---|---|---|---|
| Name | Default | Description | Overridable? Property Name |
| Username | None | Name of the user or service account for external Arrow Flight SQL server on the remote database. Required when the selected authentication mechanism is Username/Password. | |
| Password | None | The password of the user or service account to connect to the external Arrow Flight SQL server. Required when the authentication mechanism is Username/Password. | |
| PAT | None | The credential used to authenticate the target Dremio database. Required when the selected authentication mechanism is Personal Access Token | |
| Client Secret | None | Used by confidential clients to request OAuth 2.0 access tokens and perform token exchanges with the IdP. For Dremio, the client secret is optional for the token exchange. |
|
| Token Request URL | None | IdP OAuth 2.0 token endpoint url. | |
| Token Request Additional Payload | None | Additional payload fields include the IdP OAuth 2.0 token request, such as client_id, grant_type, and scope. The required format is: grant_type=password;client_id=client id value;scppe=profile openid If grant_type is password, Username and Password fields are required for the IdP OAuth 2.0 token request. |
|
| Token Exchange URL | None | The HTTPS endpoint at the IdP where the client submits a token exchange request to obtain a new access token with a different audience or scope. For Dremio, use Dremio's OAuth 2.0 token exchange endpoint (not the IdP's endpoint). |
|
| Token Exchange Additional Payload Info | None | Additional payload fields to include in the OAuth 2.0 token request (such as client_id, grant_type, scope, and audience). The required format is: grant_type=urn:ietf:params:oauth:grant-type:token-exchange;client_id=client id value;scppe=scope value;subject_token_type=urn:ietf:params:oauth:token-type:jwt |
|
| CA Certificate (PEM Format) | None | Root certificate in PEM format, required only when Use TLS is enabled. Optional when using a public certificate. |
|
| Project ID | None | The ID of the Dremio Sonar Project. If not specified, the default Sonar project is used. | |
| User TLS | True | Enable or disable TLS communication between the Arrow Flight SQL connector and target database. | |
Flight Server Tab
| Arrow Flight Connector | |||
|---|---|---|---|
| Name | Default | Description | Overridable? Property Name |
| Default Table Location | None | Default table location in "catalog.schema" format. For Dremio, nested folders are supported (for example, "catalog.folder1.folder2.schema" |
|
| Default Delimiter | Double quote | Default delimiter for the target database. Replaces the double quotes from Teradata (for example, "catalog.schema") with the target's supported delimiter (for example, 'catalog'.'schema'). This makes sure that queries can be run across multiple catalogs. The default delimiter applies only to schema paths such as "catalog.schema" and "catalog.folder1.folder2.schema". Double quotes elsewhere in the SQL are not replaced.
|
|
| Enable Table Delimiter | False | Encloses table names with the default delimiter to support special characters or reserved words. | |
| GRPC Timeout (s) | 86400 | Per-call gRPC timeout (seconds). Longer = fewer timeouts. Shorter = faster failure. | |
| Flight Call Retry Max Attempts | 3 | Maximum retry attempts for an Arrow Flight RPC after transient errors (for example, unavailable, time_out, deadline_exceeded). 0 = no retries. Valid values are 0-1000. |
|
| Flight Call Retry Back off (s) | 2 | Base delay (in seconds) between Arrow Flight retry attempts. Used as an exponential backoff, then later retries wait longer. Valid values are 0-100. |
|
Advanced Tab
| Arrow Flight Connector | |||
|---|---|---|---|
| Name | Default | Description | Overridable? Property Name |
| 16.20+ BLOB Support | True | On Teradata systems version 16.20 and later, the BINARY columns on Arrow Flight SQL-compliant databases are mapped to BLOB by default. Disable this option to map the BINARY columns to VARBYTE or if there are a large number of BINARY columns in the Arrow Flight SQL-compliant database table. |
● blobSupport |
| Default Binary Size | 64000 bytes | The VARBINARY truncation size. Applicable when the initiating Teradata system does not support BLOB data types with QueryGrid. Valid values are 1–2097088000 bytes. |
● defaultBinarySize |
| 16.20+ CLOB Support | None | On Teradata systems version 16.20 and later, the UTF8 columns on Arrow Flight SQL-compliant databases are mapped to VARCHAR by default. Enable to map the UTF8 columns to CLOB. Disable this option if there are a large number of UTF8 columns in the Arrow Flight SQL-compliant database table. |
clobSupport |
| Default String Size | 32000 characters | The VARCHAR truncation size. The value represents the maximum number of Unicode characters to import, and defaults to 32000 characters. Teradata Fabric truncates the string columns at the default value set in defaultStringSize if less than the actual column size. Valid values are 1–1048544000 characters. |
● defaultStringSize |
| Queue Size | 2000 | Size (in records) of the in-memory queue that buffers the data pulled from a remote Arrow Flight SQL-compliant database before sending it to Teradata. Valid values are 100–200,000,000. Higher values work well with light-concurrency workloads but may impact performance when many queries are run at once. |
|
| Dry Run Mode | False | Runs the connector in dry run mode, which runs the query against a remote Arrow Flight SQL-compliant database and measures fetch throughput and latency. Does not load the results into the Teradata database. Used for internal production support only. | |
General Tab
| Name | Defaullt | Description | Overridable? |
|---|---|---|---|
| Execution Type | CLIENT |
|
|
| Enable Logging | INFO | Use this setting to specify the logging level for the connector or link. Valid values are:
You can configure user-level log settings on the Add Link or Edit Link page in the Teradata Fabric portlet. |
|
| Enable Query Logging | True |
|
|
| Number of Transfer Threads | 5 | Use this setting to specify the number of threads the connector uses to transfer data for a single request on a node. Valid values are: 1–100 More threads can improve transfer performance but increase CPU usage. |
numberOfTransferThread |
| Link Buffer Count | 4 | Use this setting to specify the maximum number of write buffers available on a single channel at one time. Valid values are: 2–16 This setting overrides the default Fabric property shmDefaultNumMemoryBuffers. |
linkBufferCount |
| Link Buffer Size | 1048576 | Use this setting to specify the maximum size, in bytes, of the write buffers used for row processing and message exchange. Valid values are: 73,728–10,485,760 bytes. |
linkBufferSize |
| Query Response Timeout | 86400000 | Use this setting to specify how long the connector waits for a target query to complete before timing out. If a query exceeds the configured timeout, the fabric stops the query and releases its resources. Valid values are: 300000–172800000 milliseconds. |
responseTimeout |
FLIGHT CLIENT Tab — General Sub-tab
(Applies to Execution Type = CLIENT only)
| Name | Default | Description | Overridable? |
|---|---|---|---|
| Default Delimiter | Double quote | Use this setting to specify the delimiter the connector uses for the target database. The connector replaces Teradata double quotes in schema paths (for example, "catalog.schema") with the delimiter supported by the target database (for example, `catalog`.`schema`). This setting applies only to schema paths. The connector does not replace double quotes used elsewhere in SQL statements. |
|
| Default Table Location | Use this setting to specify the default location for tables in catalog.schema format. For Dremio, you can also specify nested folders using the format catalog.folder1.folder2.schema. Use this setting when you want the connector to use a default catalog and schema when creating or accessing tables. |
||
| Enable Table Delimiter | False | Enable this option to automatically enclose table names with the default delimiter. This helps the connector work with table names that contain special characters or use reserved words. Disable this option if your table names do not require delimiters. |
|
| Export Workers Count | 2 | Use this setting to specify the maximum number of worker threads each driver instance uses to transfer data. Valid values are: 1–5 |
exportWorkersCount |
| GRPC Timeout | 86400 | Use this setting to specify how long the connector waits for a gRPC call to complete before timing out. A longer timeout allows more time for long-running operations to complete, while a shorter timeout helps detect connection or service issues sooner. |
|
| Remote Flight Server | Use this setting to specify the IP address or DNS name of the remote Arrow Flight SQL server. Required for CLIENT execution type. Supports only a single entry. |
||
| Remote Flight Server Port | Use this setting to specify the port number of the remote Arrow Flight SQL server. Required for CLIENT execution type. |
FLIGHT CLIENT Tab — Security Sub-tab
(Applies to Execution Type = CLIENT only)
| Name | Default | Description |
|---|---|---|
| Authentication Mechanism | Username/Password | Use this setting to specify the authentication method the connector uses to connect to the remote Arrow Flight SQL server. Valid values:
Required for CLIENT execution type. |
| Username | Use this setting to specify the user or service account name for the remote Arrow Flight SQL server. Required when you set Username/Password as the Authentication Mechanism. | |
| Password | Use this setting to specify the paswword for the user or service account name for the remote Arrow Flight SQL server. Required when you set Username/Password as the Authentication Mechanism. | |
| Personal Access Token | Use this setting to specify the Personal Access Token (PAT) used to authenticate with the target Dremio system. Required when you set Personal Access Tokenas the Authentication Mechanism. Viewpoint and logs redact the token. Currently supported only for Dremio. | |
| Project UUID | Use this setting to specify the ID of the Dremio Sonar project. If you do not specify a value, the connector uses the default Sonar project. | |
| CA Certificate (PEM Format) | Use this setting to specify the root CA certificate in PEM format. Required when you enable TLS and the target system uses a private certificate. For systems that use publicly trusted certificates, this field is optional. |
|
| Use TLS | True | Use this setting to specify the use of TLS encryption to protect data transmitted between the Arrow Flight SQL connector and the target database. |
| IDP Client Secret | Use this setting to specify the client secret that confidential clients use to obtain OAuth 2.0 access tokens or perform token exchanges with the identity provider IdP. For Dremio, you can optionally provide a client secret for token exchange. | |
| IDP Token Request URL | Use this setting to specify the URL of the IdP OAuth 2.0 token endpoint. | |
| IDP Token Request Additional Payload Info | Use this setting to specify additional payload fields to include in the IdP OAuth 2.0 token request (for example, client_id, grant_type, or scope). Format: grant_type=password;client_id=<value>;scope=profile openid If grant_type is set to password, you need to specify a Username and Password. |
|
| IDP Token Exchange URL | Use this setting to specify the HTTPS endpoint at the identity provider (IdP) where the client submits a token exchange request to obtain a new access token with a different audience or scope. For Dremio, use the Dremio OAuth 2.0 token exchange endpoint instead of the identity provider (IdP) endpoint. Token exchange is optional when you use OAuth 2.0. |
|
| IDP Token Exchange Additional Payload Info | Use this setting to specify additional payload fields to include in the OAuth 2.0 token exchange request. |
FLIGHT CLIENT Tab — Advanced Sub-tab
(Applies to Execution Type = CLIENT only)
| Name | Default | Description | Overridable? |
|---|---|---|---|
| 16.20+ BLOB Support | True | On Teradata 16.20 and later, the connector maps BINARY columns from Arrow Flight SQL–compliant databases to BLOB columns. Disable this option when:
If any BINARY column can exceed 64,000 bytes, keep this option enabled. Enabling can reduce performance on large datasets.
|
blobSupport |
| Default Binary Size | 64000 bytes | Use this setting to specify the maximum size, in bytes, that the connector uses when mapping VARBINARY data. This setting applies only when the initiating Teradata system does not support BLOB with Teradata Fabric. If you enable 16.20+ BLOB Support, the connector ignores this setting. Valid values are: 1–2097088000 bytes. |
defaultBinarySize |
| 16.20+ CLOB Support | False | On Teradata 16.20 and later, the connector maps UTF8 columns from Arrow Flight SQL–compliant databases to VARCHAR by default. Enable this option if:
Any VARCHAR column can exceed 32,000 Unicode characters or 64,000 bytes. Enabling can reduce performance on large datasets.
|
clobSupport |
| Default String Size | 32000 characters | Use this setting to specify the maximum number of Unicode characters the connector imports into a VARCHAR column. VARCHAR truncation size. Valid values are: 1–1048544000 characters. If you enable 16.20+ CLOB Support, the connector ignores this setting. |
defaultStringSize |
| Dry Run Mode | False | Use this setting to test query against a remote Arrow Flight SQL–compliant database without loading the results into Teradata. In dry run mode, the connector runs the query and measures data fetch throughput and latency, helping you evaluate performance without importing data. This option is only for internal production support.
|
|
| Flight Call Retry Max Attempts | 3 | Use this setting to specify the maximum number of retry attempts for an Arrow Flight RPC call after a transient error. | |
| Flight Call Retry Back Off | 2 | Use this setting to specify the base delay, in seconds, between Arrow Flight RPC retry attempts. The connector uses this value to calculate exponential backoff after transient errors occur. Valid values are: 0–100 seconds. |
|
| Queue Size | 2000 | Use this setting to specify the size (records) of the in-memory queue buffering data pulled from a remote Arrow Flight SQL–compliant database before sending to Teradata. Valid range are 100–200000000 records. Higher values help light-concurrency workloads but can hurt performance under high concurrency. |
FLIGHT SERVER Tab — General Sub-tab
(Applies to Execution Type = SERVER only)
| Name | Default | Description |
|---|---|---|
| Flight Server Network Interface | Use this setting to specify the network interface the Arrow Flight server uses when advertising its endpoint to clients. If you leave this field blank, the server uses the node hostname in GetFlightInfo endpoint responses. | |
| Flight Server Load Balancer Address | Use this setting to specify the load balancer address used to connect to this Arrow Flight SQL Connector (SERVER Execution Type). If you set this option, it always uses this address in GetFlightInfo endpoint responses. | |
| Flight Server Load Balancer Port | Use this setting to specify the load balancer port used to connect to this Arrow Flight SQL Connector (SERVER Execution Type). | |
| Flight Server Active Port | 5501 | Use this setting to specify the port on which the active Arrow Flight SQL Connector (SERVER Execution Type) listens for production client connections. |
| Flight Server Pending Port | 5502 | Use this setting to specify the port on which the pending (test) Arrow Flight SQL Connector (SERVER Execution Type) listens. |
| Flight Server Active FS | arrow_fs | Use this setting to specify the Teradata foreign server name used by the active Arrow Flight SQL Connector (SERVER Execution Type) to trigger export queries. |
| Flight Server Pending FS | arrow_fs_pending | Use this setting to specify the Teradata foreign server name used by the pending Arrow Flight SQL Connector (SERVER Execution Type) for testing. |
| Auth Token Encryption Key | Use this setting to specify the encryption key used to encrypt and decrypt authentication tokens for secure storage. Use a random string of at least 12 characters including uppercase, lowercase, and numbers. Required for SERVER execution type. | |
| Flight Server TLS Cert Refresh (Days) | 7 | Use this setting to specify the number of days before certificate expiry at which the server attempts to refresh the certificate. Min: 5 Max: 60 |
| Diagnostic Username | Use this setting to specify the username for the Flight Server diagnostic connection check. | |
| Diagnostic Password | Use this setting to specify the password used for the Flight Server diagnostic connection check. | |
| Diagnostic JWT Token | Use this setting to specify the JWT bearer token used for the Flight Server diagnostic connection check. When set, takes precedence over Diagnostic Username and Password. The server receives this through gRPC Authorization header and opens JDBC with LOGMECH=JWT. |
FLIGHT SERVER Tab — Flight Server Workload Management Sub-tab
(Applies to Execution Type = SERVER only)
| Name | Default | Description |
|---|---|---|
| Concurrent Query Limit | 50 | Use this setting to control the maximum number of queries that can run concurrently on a node. The connector automatically terminates queries that exceed the configured limit. Valid values are:
|
| Query Time Limit (minutes) | 1500 | Use this setting to prevent long-running queries from consuming system resources indefinitely. Use this setting to control the maximum time (minutes) a query can run before the connector automatically terminates it. Valid values are: 1440–2880 minutes. |
| Query Expiration Check Interval (minutes) | 60 | Use this setting to control how often the connector scans for expired queries and removes them from memory. Valid values are:
|
| Arrow Batch Buffer Size | 8 | Use this setting to control how much Arrow data the connector buffers in memory before processing it. Valid values are:
|
| Arrow RecordBatch Size | 4000 | Use this setting to control how many rows the connector groups into each Arrow RecordBatch. Valid values are:
|
| Arrow Flight Streams per Driver | 1 | Use this setting to control the number of parallel Arrow Flight streams per driver node. Higher values increase throughput and resource usage. Valid values are:
|
| Arrow Stream Start Timeout (seconds) | 60 | Use this setting to control the timeout used to mark a stream as abandoned if no stream starts within the configured duration. Valid values are:
|
| Arrow Abandonment Reaper Interval (seconds) | 60 | Use this setting to control the interval at which the reaper checks for abandoned Arrow streams. Valid values are:
|
FLIGHT SERVER Tab — Teradata Advanced SQL Engine Sub-tab
(Applies to Execution Type = SERVER only)
| Name | Default | Description |
|---|---|---|
| Teradata Advanced SQL Engine | Use this setting to enter the IP/hostname of the Teradata Database that the Arrow Flight SQL Connector (SERVER Execution Type) uses to connect through JDBC. Required for SERVER execution type. | |
| Teradata Advanced SQL Engine Port | Use this setting to enter the port of the Teradata Database. Required for SERVER execution type. Valid values are:
|
|
| JDBC Communication over TLS | False | Use this setting to secure JDBC connections to the Teradata Database with TLS encryption. Supported with JDBC Driver 17.10.00.07 and later. |
| TLS Port | 443 | Use this setting to enter the port for HTTPS/TLS connections. Valid values are:
|
| JDBC Connection Pool Idle TTL (ms) | 300000 | Use this setting to enter the time-to-live for idle connections in the JDBC pool. Min: 1000, Max: 3600000. Valid values are:
|
| JDBC Connection Pool Max Lifetime (ms) | 86400000 | Use this setting to enter the maximum lifetime of a connection in the JDBC pool. Min: 60000, Max: 86400000. Valid values are:
|
| JDBC Connection Pool Reaper Interval (ms) | 30000 | Use this setting to enter the interval at which the connection pool reaper cleans up stale connections. Min: 1000, Max: 300000. Valid values are:
|