15.10 - Interface with the Data Connector - Access Module

Teradata Tools and Utilities Access Module Reference

prodname
Access Module
vrm_release
15.10
category
Programming Reference
featnum
B035-2425-035K

Interface with the Data Connector

The Teradata Access Module for JMS must provide a main function called PIDMMain(), which is called by the Data Connector to request I/O operations. This function contains two parameters:

void PIDMMain (pmiCmdBlock_t *Opts, void *OptParms)

The first parameter (Opts) specifies one of the access module functions in Table 14 on page 105. The second parameter (OptParms) contains context specific information for each of the functions specified in the table.

 

Table 14: PIDMMain’s Opts Parameter Values 

Access Module Function

Description

Access Module Initialization

Initializes the Teradata Access Module for JMS and parses the initialization string.

Access Module Identification

Identifies the Teradata Access Module for JMS and version.

File Open

Opens the queue or topic connection.

File Close

Closes the queue or topic connection.

File Read

Gets and processes data messages from a specified queue or topic.

File Write

Puts and processes data messages to a specified queue or topic.

File Get Position

Returns the current position of a data file for checkpoint and restart purposes.

File Set Position

Restart at a given point of a data file for checkpoint and restart purposes.

Get Attribute

Returns an attribute to the Teradata load/export utilities. Primarily for exchanging information between the Teradata Access Module for JMS and the load/export utilities.

Put Attribute

Sends an attribute to the Teradata Access Module for JMS. This is for exchanging information.

Shutdown

Terminates the access module.