Pipeline object
A Pipeline system object is used to manage a data pipeline
during execution. You use a Pipeline object by defining a standard
class user object inherited from the built-in Pipeline object in
the User Object painter. You can then access the Pipeline events
by writing scripts that contain code for the events.
For more information about piping data, see Application
Techniques.
Properties
Pipeline property |
Datatype |
Description |
---|---|---|
ClassDefinition |
PowerObject |
An object of type PowerObject containing |
DataObject |
String |
The name of the pipeline object (the |
RowsInError |
Long |
The number of rows the pipeline found |
RowsRead |
Long |
The number of rows read by the pipeline |
RowsWritten |
Long |
The number of rows written by the pipeline |
Syntax |
String |
The syntax used to create the pipeline |
Events
Pipeline event |
Occurs |
---|---|
When the user object is created. |
|
When the user object is destroyed. |
|
When Start or Repair is |
|
After each block of rows is read or written. |
|
When a Start or Repair is started. |
Functions
Pipeline function |
Datatype returned |
Description |
---|---|---|
Integer |
Stops execution of a pipeline. |
|
String |
Returns the name assigned to the user |
|
Integer |
Creates a reference to a context-specific |
|
Power |
Returns a reference to the name of the |
|
Boolean |
Adds an event to the end of the message |
|
Integer |
Updates the target database with corrections |
|
Integer |
Executes a pipeline. |
|
Integer |
Sends an event to the user object and |
|
Object |
Returns the type of the user object. |