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 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 |
|---|---|
|
Constructor in PowerScript Reference |
When the user object is created. |
|
Destructor in PowerScript Reference |
When the user object is destroyed. |
|
PipeEnd in PowerScript Reference |
When Start or Repair is completed. |
|
PipeMeter in PowerScript Reference |
After each block of rows is read or written. The Commit factor specified for the pipeline determines the size of each block. |
|
PipeStart in PowerScript Reference |
When a Start or Repair is started. |
|
Pipeline function |
Datatype returned |
Description |
|---|---|---|
|
Cancel in PowerScript Reference |
Integer |
Stops execution of a pipeline. |
|
ClassName in PowerScript Reference |
String |
Returns the name assigned to the user object. |
|
GetContextService in PowerScript Reference |
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
GetParent in PowerScript Reference |
PowerObject |
Returns a reference to the name of the parent object. |
|
PostEvent in PowerScript Reference |
Boolean |
Adds an event to the end of the message queue of the user object. |
|
Repair in PowerScript Reference |
Integer |
Updates the target database with corrections that have been made in the pipeline user object's Error DataWindow. |
|
Start in PowerScript Reference |
Integer |
Executes a pipeline. |
|
TriggerEvent in PowerScript Reference |
Integer |
Sends an event to the user object and executes the script associated with the event. |
|
TypeOf in PowerScript Reference |
Object |
Returns the type of the user object. |
