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 | The Teradata user account used to authenticate. |
| Password | The password used to authenticate the user. |
| 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 | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| 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 | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| QueryPassthrough | This option passes the query to the Teradata server as is. |
| Readonly | You can use this property to enforce read-only access to Teradata from the provider. |
| RTK | The runtime key used for licensing. |
| 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 | The value in seconds until the timeout error is thrown, canceling the operation. |
| 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. |