Excel Add-In for Teradata

Build 24.0.9060

Connection Properties

The connection 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 settings for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication


PropertyDescription
AuthenticationStringAuthenticationString enables support for mechanisms that require additional authentication information.
DataSourceThe Teradata server name or, equivalently, the DBC Name or TDPID.
AuthSchemeSpecifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities.
UserThe Teradata user account used to authenticate.
PasswordThe password used to authenticate the user.
DatabaseThe database selected as the default database when a Teradata connection is opened.
PortConnects to the Teradata Database on the TCP/IP port specified. The default Teradata Database port is 1025.
AccountSpecifies an account string to override the default account string defined for the Teradata Database user.
AccountStringIdentifies an individual user account and is associated with a specific User Id.
IntegatedSecuritySet this to true to use Single Sign On.

Connection


PropertyDescription
ConnectionTimeoutSpecifies the time in seconds to wait for a Teradata session to be opened or established.
ConnectionPoolingEnables or disables connection pooling.
ConnectionPoolingTimeoutSpecifies the time a connection may stay idle inside the pool.
ConnectMaxRetryCountThe maximum number of reattempts before the connection will fail.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
CacheConnectionThe connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
CommandTimeoutThe timeout before the command is aborted and the transaction rolled back.
DataEncryptionEnables or disables session-level encryption. Default: false.
DataIntegrityEnables or disables session-level integrity. Default: false.
DataSourceDnsEntriesThe number of entries defined in DNS for the DataSource .
DisableAutoCommitInBatchSpecifies whether or not disable the autocommit when executing the batch operation.
EnableDateTimeOffsetEnables and disables the mapping of TIMESTAMP WITH ZONE to DateTimeOffset. Default: true.
EnableTdDateTimeEnables and disables mapping date-time types to provider-specific types. Default: true.
EnableTdDecimalEnables and disables mapping of Decimal(18) to the TdDecimal provider-specific type.
HttpsPortConnects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections.
MaxDecimalPrecisionUsed to set the maximum precision of a decimal that can be retrieved from Teradata.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
NodeDownTimeout(Obsolete) the number of seconds that must elapse before a connection attempt is made to a node previously marked as unavailable.
OtherThese hidden properties are used only in specific use cases.
PersistSecurityInfoSet this to true to persist sensitive authentication information (false by default).
ProfileNameSpecifies the profile name to access supported properties from the application configuration file.
QueryBandGets or sets the Query Bands that are to be defined at the connection level.
QueryPassthroughThis option passes the query to the Teradata server as is.
ReadAheadEnables additional buffering of results, while the current buffer is consumed by an application. True by default.
ReadonlyYou can use this property to enforce read-only access to Teradata from the provider.
RecoverySets Recoverable Network Protocol (RNP) and Redrive properties used during a network error or database failure.
RecoveryCommandTimeoutOverrideEnables a RecoveryTimeout value to be supplied during reconnection for commands that contain a finite CommandTimeout . True by default.
RecoveryIntervalFactorThis represents the adjustment in the recovery interval period from the preceding interval period. The factor is an additive factor in seconds (2 by default).
RecoveryMaximumIntervalThis represents the maximum interval time in seconds to wait while attempting to reconnect to the database.
RecoveryStartIntervalThe starting time interval (in seconds) after which an attempt to retry a reconnection is performed.
RecoveryTimeoutRecovery timeout in seconds used to re-establish a connection.
ResponseBufferSizeGets and sets the initial size of the internal communication data buffers.
RestrictToDefaultDatabaseSet this to true to restrict schema queries invoking GetSchema to the default database (false by default).
SessionCharacterSetGets or sets the character encoding (Text.Encoding) for the connection.
SessionModeSpecifies the session mode on a Teradata Database V2R2.0 or later system. The selected mode applies for the duration of the session.
SslCaSpecifies the file name of a PEM file that contains Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
SslCaPathSpecifies a directory of PEM files that contain Certificate Authority (CA) certificates for use with SSLMODE=VERIFY-CA or VERIFY-FULL.
SslModeSpecifies the mode for connections to the database.
SslProtocolSpecifies the TLS protocol for HTTPS/TLS connections.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UpperCaseIdentifiersThis 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.
UseEnhancedSchemaTableGets or sets a Boolean value that indicates whether the GetSchemaTable method returns additional result set metadata (default: true).
UseXViewsSpecifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060