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 the section called “Piping Data Between Data Sources” in Application Techniques.
|
Pipeline property |
Datatype |
Description |
|---|---|---|
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control |
|
DataObject |
String |
The name of the pipeline object (the object created in the Data Pipeline painter, but that you must assign dynamically at runtime) |
|
RowsInError |
Long |
The number of rows the pipeline found in error (for example, rows containing a duplicate key) |
|
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 object (the object created in the Data Pipeline painter) |
|
Pipeline event |
Occurs |
|---|---|
|
When the user object is created. |
|
|
When the user object is destroyed. |
|
|
When Start or Repair is completed. |
|
|
After each block of rows is read or written. The Commit factor specified for the pipeline determines the size of each block. |
|
|
When a Start or Repair is started. |
|
Pipeline function |
Datatype returned |
Description |
|---|---|---|
|
Integer |
Stops execution of a pipeline. |
|
|
String |
Returns the name assigned to the user object. |
|
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
|
PowerObject |
Returns a reference to the name of the parent object. |
|
|
Boolean |
Adds an event to the end of the message queue of the user object. |
|
|
Integer |
Updates the target database with corrections that have been made in the pipeline user object's Error DataWindow. |
|
|
Integer |
Executes a pipeline. |
|
|
Integer |
Sends an event to the user object and executes the script associated with the event. |
|
|
Object |
Returns the type of the user object. |
