Connection String Options
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 connecting, see Establishing a Connection.
Property | Description |
AuthenticationString | AuthenticationString enables support for mechanisms that require additional authentication information. |
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 | Specifies the user ID of the authenticating Teradata user account. |
Password | Specifies the password of the authenticating user account. |
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. |
AccountString | Identifies an individual user account and is associated with a specific User Id. |
IntegatedSecurity | Set this to true to use Single Sign On. |
Property | Description |
ConnectionTimeout | Specifies the time in seconds to wait for a Teradata session to be opened or established. |
ConnectionPooling | Enables or disables connection pooling. |
ConnectionPoolingTimeout | Specifies the time a connection may stay idle inside the pool. |
ConnectMaxRetryCount | The maximum number of reattempts before the connection will fail. |
Property | Description |
FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Property | Description |
Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
Property | Description |
Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Property | Description |
AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
CacheConnection | The connection string for the specified cache database. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheTolerance | The tolerance, in seconds, for stale data in the specified cache database. |
Offline | Get the data from the specified cache database instead of live Teradata data. |
CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
Property | Description |
BatchSize | Specifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request. |
CommandTimeout | The timeout before the command is aborted and the transaction rolled back. |
ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. Set to 0 or leave empty for no time limit. |
DataEncryption | Enables or disables session-level encryption. Default: false. |
DataIntegrity | Enables or disables session-level integrity. Default: false. |
DataSourceDnsEntries | The number of entries defined in DNS for the DataSource . |
DisableAutoCommitInBatch | Specifies whether or not disable the autocommit when executing the batch operation. |
EnableDateTimeOffset | Enables and disables the mapping of TIMESTAMP WITH ZONE to DateTimeOffset. Default: true. |
EnableTdDateTime | Enables and disables mapping date-time types to provider-specific types. Default: true. |
EnableTdDecimal | Enables and disables mapping of Decimal(18) to the TdDecimal provider-specific type. |
HttpsPort | Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections. |
MaxDecimalPrecision | Used to set the maximum precision of a decimal that can be retrieved from Teradata. |
MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
NodeDownTimeout | (Obsolete) the number of seconds that must elapse before a connection attempt is made to a node previously marked as unavailable. |
Other | Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties. |
PersistSecurityInfo | Set this to true to persist sensitive authentication information (false by default). |
PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. |
PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. The default value is 100. Set to 0 or a negative value to disable pooling. |
PoolMinSize | Specifies the minimum number of connections maintained in the connection pool. The default value is 1. |
PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. The default is 60 seconds. |
ProfileName | Specifies the profile name to access supported properties from the application configuration file. |
QueryBand | Gets or sets the Query Bands that are to be defined at the connection level. |
QueryPassthrough | This option passes the query to the Teradata server as is. |
ReadAhead | Enables additional buffering of results, while the current buffer is consumed by an application. True by default. |
Readonly | Toggles read-only access to Teradata from the provider. |
Recovery | Sets Recoverable Network Protocol (RNP) and Redrive properties used during a network error or database failure. |
RecoveryCommandTimeoutOverride | Enables a RecoveryTimeout value to be supplied during reconnection for commands that contain a finite CommandTimeout . True by default. |
RecoveryIntervalFactor | This represents the adjustment in the recovery interval period from the preceding interval period. The factor is an additive factor in seconds (2 by default). |
RecoveryMaximumInterval | This represents the maximum interval time in seconds to wait while attempting to reconnect to the database. |
RecoveryStartInterval | The starting time interval (in seconds) after which an attempt to retry a reconnection is performed. |
RecoveryTimeout | Recovery timeout in seconds used to re-establish a connection. |
ResponseBufferSize | Gets and sets the initial size of the internal communication data buffers. |
RestrictToDefaultDatabase | Set this to true to restrict schema queries invoking GetSchema to the default database (false by default). |
RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key. |
SessionCharacterSet | Gets or sets the character encoding (Text.Encoding) for the connection. |
SessionMode | Specifies the session mode on a Teradata Database V2R2.0 or later system. The selected mode applies for the duration of the session. |
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 | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout. |
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. |
UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
UseEnhancedSchemaTable | Gets or sets a Boolean value that indicates whether the GetSchemaTable method returns additional result set metadata (default: true). |
UseXViews | Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. |