Pipeline object – PB Docs 126

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
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)

Events

Pipeline event

Occurs

Constructor

When the user object is created.

Destructor

When the user object is destroyed.

PipeEnd

When Start or Repair is
completed.

PipeMeter

After each block of rows is read or written.
The Commit factor specified for the pipeline determines the size
of each block.

PipeStart

When a Start or Repair is started.

Functions

Pipeline function

Datatype returned

Description

Cancel

Integer

Stops execution of a pipeline.

ClassName

String

Returns the name assigned to the user
object.

GetContextService

Integer

Creates a reference to a context-specific
instance of the specified service.

GetParent

Power
Object

Returns a reference to the name of the
parent object.

PostEvent

Boolean

Adds an event to the end of the message
queue of the user object.

Repair

Integer

Updates the target database with corrections
that have been made in the pipeline user object’s Error
DataWindow.

Start

Integer

Executes a pipeline.

TriggerEvent

Integer

Sends an event to the user object and
executes the script associated with the event.

TypeOf

Object

Returns the type of the user object.


Document get from Powerbuilder help
Thank you for watching.
Was this article helpful?
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x