15.10 - PutEvent Modifiers - Parallel Transporter

Teradata Parallel Transporter Application Programming Interface

prodname
Parallel Transporter
vrm_release
15.10
category
Programming Reference
featnum
B035-2516-035K

PutEvent Modifiers

All PutEvent modifiers must be used after the Stream driver has initiated and before it has terminated. TD_Unavailable is returned when a modifier cannot be used.

The following table lists modifiers that are used with the PutEvent function of the Connection object to modify the Rate and Periodicity values of the Stream driver in the middle of the stream job.

 

Table 25: Stream Driver PutEvent Modifiers 

Event

Expected Input Data

TD_Evt_UserCommand

A character buffer containing 9 bytes of data used to pass the user command.

User Command Syntax

  • RATE=value
  • where value must be an integer greater than 0 or ‘unlimited’ (for character-string).

  • PERIODICITY=value
  • where value must be an integer between 0 and 600.

  • RATE=value, PERIODICITY=value
  • PERIODICITY=value, RATE=value
  • The commands and values are case-insensitive.

    Invalid user commands or specified values:

  • RATE=unknown
  • RATE=0
  • RATE=-1
  • PERIODICITY=0
  • PERIODICITY=-1
  • PERIODICITY=600
  • PERIODICITY=601
  • Invalid multiple RATE or PERIODICITY commands:

  • RATE=10, RATE=200
  • PERIODICITY=10, PERIODICITY=20
  • For usage examples of the TD_Evt_UserCommand, see “Stream Driver Private Logs for TD_Evt_UserCommand” on page 143.