Connection String Parameters for Teradata
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.
Name | Description |
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. |
AuthenticationMechanism | A session security context enabling data encryption and authentication. |
AuthenticationString | AuthenticationString enables support for mechanisms that require additional authentication information. |
CommandTimeout | The timeout before the command is aborted and the transaction rolled back. |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
ConnectionPooling | Enables or disables connection pooling. |
ConnectionPoolingTimeout | Specifies the time a connection may stay idle inside the pool. |
ConnectionTimeout | Specifies the time in seconds to wait for a Teradata session to be opened or established. |
ConnectMaxRetryCount | The maximum number of reattempts before the connection will fail. |
Database | The database selected as the default database when a Teradata connection is opened. |
DataEncryption | Enables or disables session-level encryption. Default: false. |
DataIntegrity | Enables or disables session-level integrity. Default: false. |
DataSource | The Teradata server name or, equivalently, the DBC Name or TDPID. |
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. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
IntegatedSecurity | Set this to true to use Single Sign On. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A path to the log file. |
MaxDecimalPrecision | Used to set the maximum precision of a decimal that can be retrieved from Teradata. |
MaxLogFileCount | 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. |
MaxLogFileSize | 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. |
MaxRows | 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. |
NodeDownTimeout | (Obsolete) the number of seconds that must elapse before a connection attempt is made to a node previously marked as unavailable. |
Other | These hidden properties are used only in specific use cases. |
Password | The password used to authenticate with Teradata;. |
PersistSecurityInfo | Set this to true to persist sensitive authentication information (false by default). |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
Port | Connects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025. |
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 | You can use this property to enforce 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 | The runtime key used for licensing. |
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. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseConnectionPooling | This property enables connection pooling. |
UseEnhancedSchemaTable | Gets or sets a Boolean value that indicates whether the GetSchemaTable method returns additional result set metadata (default: true). |
User | Specifies the username for the connection. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |