PipeMeter event
Description
Occurs during pipeline processing after each block of rows
is read or written. The Commit factor specified for the Pipeline
in the Pipeline painter determines the size of each block.
Event ID
Event ID |
Objects |
---|---|
pbm_pipemeter |
Pipeline |
Parameters
None
Return Values
Long. Return code choices (specify in
a RETURN statement):
-
0 Continue
processing
Usage
The Start and Repair functions
initiate pipeline processing.
In the Pipeline painter, you can specify a Commit factor specifying
the number of rows that will be transferred before they are committed
to the database. The PipeMeter event occurs for each block of rows
as specified by the Commit factor.
For a complete example of using a Pipeline
object, see Application Techniques.
Examples
This code in a Pipeline user object’s PipeMeter
event report the number of rows that have been piped to the destination
database:
1 |
ist_status.Text = String(This.RowsWritten) & |
1 |
   + " rows written to the destination database." |