Parameters (Connect-Teradata Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| 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. |
| 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. |
| 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 |
| DisableAutoCommitInBatch | Specifies whether or not disable the autocommit when executing the batch operation. |
| HttpsPort | Connects to the database on the Transmission Control Protocol/Internet Protocol (TCP/IP) port specified for HTTPS/TLS connections. |
| MaxRows | Specifies the maximum rows returned for queries without aggregation or GROUP BY. |
| 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. |
| QueryPassthrough | This option passes the query to the Teradata server as is. |
| Readonly | Toggles read-only access to Teradata from the provider. |
| 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. |
| 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. |
| UseXViews | Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods. |