Teradata
The Teradata connector lets you perform insert, delete, update, and read operations on Teradata database.
Before you begin
Before using the Teradata connector, do the following tasks:
- In your Google Cloud project:
- Grant the roles/connectors.admin IAM role to the user configuring the connector.
- Grant the following IAM roles to the service account that you want to use for the connector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.
- Enable the following services:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.
Configure the connector
Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:
- In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
- Click + CREATE NEW to open the Create Connection page.
- In the Location section, choose the location for the connection.
- Region: Select a location from the drop-down list.
For the list of all the supported regions, see Locations.
- Click NEXT.
- Region: Select a location from the drop-down list.
- In the Connection Details section, complete the following:
- Connector: Select Teradata from the drop down list of available Connectors.
- Connector version: Select the Connector version from the drop down list of available versions.
- In the Connection Name field, enter a name for the Connection instance.
Connection names must meet the following criteria:
- Connection names can use letters, numbers, or hyphens.
- Letters must be lower-case.
- Connection names must begin with a letter and end with a letter or number.
- Connection names cannot exceed 63 characters.
- Optionally, enter a Description for the connection instance.
- Service Account: Select a service account that has the required roles.
- Optionally, configure the Connection node settings (Preview):
- Minimum number of nodes: Enter the minimum number of connection nodes.
- Maximum number of nodes: Enter the maximum number of connection nodes.
A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
- Client Charset: Specifies the Java character set for encoding and decoding character data transferred to and from the Teradata Database.
- Database: The database selected as the default database when a Teradata connection is opened.
- Account: Specifies an account string to override the default account string defined for the Teradata Database user.
- Charset: Specifies the session character set for encoding and decoding character data transferred to and from the Teradata Database. The default value is ASCII.
- Column Name: Controls the behavior of the ResultSetMetaData getColumnName and getColumnLabel methods.
- Connect Failure TTL: This option enables the CData ADO.NET Provider for Teradata remember the time of the last connection failure for each IP address/port combination. Also, the CData ADO.NET Provider for Teradata skips connection attempts to that IP address/port during subsequent logins for the number of seconds specified by the Connect Failure time-to-live (CONNECTFAILURETTL) value.
- Connect Function: Specifies whether the Teradata Database should allocate a Logon Sequence Number (LSN) for this session or associate this session with an existing LSN.
- Cop: Specifies whether COP Discovery is performed.
- Cop Last: Specifies how COP Discovery determines the last COP hostname.
- Ddstats: Specify the value for DDSTATS.
- Disable Auto Commit In Batch: Specifies whether or not disable the autocommit when executing the batch operation.
- Encrypt Data: Specify the EncryptData value, ON or OFF.
- Error Query Count: Specifies the maximum number of times that JDBC FastLoad will attempt to query FastLoad Error Table 1 after a JDBC FastLoad operation.
- Error Query Interval: Specifies the number of milliseconds that JDBC FastLoad will wait in between attempts to query FastLoad Error Table 1 after a JDBC FastLoad operation.
- Error Table 1Suffix: Specifies the suffix for the name of FastLoad Error Table 1 created by JDBC FastLoad and JDBC FastLoad CSV.
- Error Table 2Suffix: Specifies the suffix for the name of FastLoad Error Table 2 created by JDBC FastLoad and JDBC FastLoad CSV.
- Error Table Database: Specifies the database name for the FastLoad error tables created by JDBC FastLoad and JDBC FastLoad CSV.
- Field Sep: Specifies a field separator for use with JDBC FastLoad CSV only. The default separator is ',' (comma).
- Finalize Auto Close: Specify the value for FinalizeAutoClose, ON or OFF.
- Geturl Credentials: Specify the value for GeturlCredentials, ON or OFF.
- Govern: Specify the value for GOVERN, ON or OFF.
- Literal Underscore: Automatically escape LIKE-predicate patterns in DatabaseMetaData calls, such as schemPattern and tableNamePattern.
- Lob Support: Specify the value for LobSupport, ON or OFF.
- Lob Temp Table: Specifies the name of a table with the following columns: id integer, bval blob, cval clob.
- Log: Specifies the logging level (verbosity) for a connection. Logging is always enabled. The logging levels are listed in order from terse to verbose.
- Log Data: Specifies additional data needed by a logon mechanism, such as a secure token, Distinguished Name, or a domain/realm name.
- Log Mech: Specifies the Logon Mechanism, which determines the connection's authentication and encryption capabilities.
- Logon Sequence Number: Specifies an existing Logon Sequence Number (LSN) to associate this session with.
- Max Message Body: Specifies the maximum Response Message size in bytes.
- Maybe Null: Controls the behavior of the ResultSetMetaData.isNullable method.
- New Password: This connection parameter enables an application to change an expired password automatically.
- Partition: Specifies the Teradata Database partition for the Connection.
- Prep Support: Specifies whether the Teradata Database performs a prepare operation when a PreparedStatement or CallableStatement is created.
- Reconnect Count: Enables Teradata Session Reconnect. Specifies the maximum number of times that the Teradata JDBC Driver will attempt to reconnect the session.
- Reconnect Interval: Enables Teradata Session Reconnect. Specifies the number of seconds that the Teradata JDBC Driver will wait in between attempts to reconnect the session.
- Redrive: Enables Teradata Session Reconnect, and also enables automatic redriving of SQL requests interrupted by database restart.
- Run Startup: Specify the value for RunStartup, ON or OFF.
- Sessions: Specifies the number of FastLoad or FastExport connections to be created, where 1 <= number of FastLoad or FastExport connections <= number of AMPs.
- Sip Support: Controls whether the Teradata Database and Teradata JDBC Driver use StatementInfo Parcel (SIP) to convey metadata.
- Slob Receive Threshold: Controls how small LOB values are received from the Teradata Database. Small LOB values are pre-fetched from the Teradata Database before the application explicitly reads data from Blob/Clob objects.
- Slob Transmit Threshold: Controls how small LOB values are transmitted to the Teradata Database.
- Sp Spl: Specifies behavior for creating or replacing Teradata stored procedures.
- Strict Encode: Specifies behavior for encoding character data to transmit to the Teradata Database.
- TMode: Specifies the transaction mode for the connection.
- TNano: Specifies the fractional seconds precision for all java.sql.Time values bound to a PreparedStatement or CallableStatement and transmitted to the Teradata Database as TIME or TIME WITH TIME ZONE values.
- TS Nano: Specifies the fractional seconds precision for all java.sql.Timestamp values bound to a PreparedStatement or CallableStatement and transmitted to the Teradata Database as TIMESTAMP or TIMESTAMP WITH TIME ZONE values.
- Tcp: Specifies one or more TCP socket settings, separated by plus signs ().
- Trusted Sql: Specify the value for TrustedSql.
- Type: Specifies the type of protocol to be used with the Teradata Database for SQL statements.
- Upper Case Identifiers: 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.
- Use XViews: Specifies which Data Dictionary views should be queried to return result sets from DatabaseMetaData methods.
- Optionally, click + ADD LABEL to add a label to the Connection in the form of a key/value pair.
- Click NEXT.
- In the Destinations section, enter details of the remote host (backend system) you want to connect to.
- Destination Type: Select a Destination Type.
- In the Host address field, specify the hostname or IP address of the destination.
- If you want to establish a private connection to your backend systems, follow these steps:
- Create a PSC service attachment.
- Create an endpoint attachment and then enter the details of the endpoint attachment in the Host address field.
- If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.
- If you want to establish a private connection to your backend systems, follow these steps:
To enter additional destinations, click +ADD DESTINATION.
- In the Host address field, specify the hostname or IP address of the destination.
- Click NEXT.
- Destination Type: Select a Destination Type.
-
In the Authentication section, enter the authentication details.
- Select an Authentication type and enter the relevant details.
The following authentication types are supported by the Teradata connection:
- Username and password
- Click NEXT.
To understand how to configure these authentication types, see Configure authentication.
- Select an Authentication type and enter the relevant details.
- Review: Review your connection and authentication details.
- Click Create.
Configure authentication
Enter the details based on the authentication you want to use.
-
Username and password
- Username: Username for connector
- Password: Secret Manager Secret containing the password associated with the connector.
Entities, operations, and actions
All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.
- Entity: An entity can be thought of as an object, or a collection of properties, in the
connected application or service. The definition of an entity differs from a connector to a
connector. For example, in a database connector, tables are the entities, in a
file server connector, folders are the entities, and in a messaging system connector,
queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the
Entities
list will be empty. For example, the Pub/Sub connector doesn't have any entity, but only has thepublishMessage
action. - Operation: An operation is the activity that you can perform on an entity. You can perform
any of the following operations on an entity:
- List
- Get
- Create
- Update
- Delete
Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, it is possible that a connector doesn't support any entity operations, in which case the
Operations
list will be empty. - Action: An action is a first class function that is made available to the integration
through the connector interface. An action lets you make changes to an entity or entities, and
vary from connector to connector. However, it is possible
that a connector doesn't support any action, in which case the
Actions
list will be empty.
Use the Teradata connection in an integration
After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.
- To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
- To understand how to create and use the Connectors task in Application Integration, see Connectors task.
Get help from the Google Cloud community
You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.What's next
- Understand how to suspend and resume a connection.
- Understand how to monitor connector usage.
- Understand how to view connector logs.