Namespace: OpenEdge.DataAdmin.Util
Class
CDCTrackingHelper
Parent classes:
Inherits: Progress.Lang.Object

/* Copyright (c) 2017 by Progress Software Corporation
/*
/* All rights reserved. No part of this program or document
/* may be reproduced in any form or by any means without
/* permission in writing from Progress Software Corporation.
/* OpenEdge.DataAdmin.Util.CDCrackingHelper




Method Summary
Options Name Purpose
cachePolicy ()
LOGICAL ChangeBitSet (raw, integer)
HANDLE CreateChangeBuffer () /** Convenience method to provide a dynamic temp-table with a schema matching the change table for this source table. This is provided to give users a buffer into which split records can be stored. */
DeleteChangeTrackingRecord () /** Deletes the _Cdc-Change-Tracking record, and all corresponding change table records. The caller must have a started a transaction to call this method. */
FetchChangeRecord (handle) /** Fetches the change table record corresponding to the _Cdc-Change-Tracking row into the supplied buffer @param handle Handle to a buffer of a table into which to write the field from the change table record */
FetchChangeRecord (handle, logical) /** Fetches the change table record corresponding to the _Cdc-Change-Tracking row into the supplied buffer @param handle Handle to a buffer of a table into which to write the field from the change table record @param logical If the operation is an update, then retrieve the BEFORE record */
LOGICAL FieldChanged (character) /** Returns whether the named field was changed in the record currently in the _Cdc-Change-Tracking buffer. @param character The name of the field to query */
CHARACTER GetChangedFields () /** Returns an EXTENT of the names of the changed fields in the record currently in the _Cdc-Change-Tracking buffer. */
OpenEdge.DataAdmin.Util.CDCOperation GetOperation () /** Returns a CDCOperation enum value for the operation in the record currently in the _Cdc-Change-Tracking buffer. */
InternalFetchChangeRecord (handle, integer)
LOGICAL InternalIsRecordSplit (integer)
LOGICAL IsCreate () /** Whether the _Cdc-Change-Tracking record is for a create */
LOGICAL IsDelete () /** Whether the _Cdc-Change-Tracking record is for a delete */
LOGICAL IsRecordSplit () /** Returns whether the change table row corresponding to the _Cdc-Change-Tracking row was split */
LOGICAL IsRecordSplit (logical) /** Returns whether the change table row corresponding to the _Cdc-Change-Tracking row was split. @param logical If the operation is an update, then retrieve the BEFORE record */
LOGICAL IsUpdate () /** Whether the _Cdc-Change-Tracking record is for an update */

Constructor Summary
Options Name Purpose
CDCTrackingHelper (character, character, handle) /** Creates a CDCTrackingHelper for the given table and owner. @param character The name of the source table @param character The Owner (schema) of the source table, for SQL tables @param handle A handle to the _Cdc-Change-Tracking buffer used for querying */
CDCTrackingHelper (character, handle) /** Creates a CDCTrackingHelper for the given table in the PUB schema. @param character The name of the source table @param handle A handle to the _Cdc-Change-Tracking buffer used for querying */

Property Summary
Options Name Purpose
INTEGER SourceTableNumber /** Table number of source table, for querying _Cdc-Change-Tracking._Source-Table-Number */


Method Detail
Top

cachePolicy ()

Top

LOGICAL ChangeBitSet (raw, integer)

Parameters:
rbitmap RAW
ipos INTEGER
Returns LOGICAL
Top

HANDLE CreateChangeBuffer ()

Purpose: Convenience method to provide a dynamic temp-table
with a schema matching the change table for this source table.
This is provided to give users a buffer into which split records
can be stored.
Returns HANDLE
Top

DeleteChangeTrackingRecord ()

Purpose: Deletes the _Cdc-Change-Tracking record, and all
corresponding change table records.
The caller must have a started a transaction to call this method.
Top

FetchChangeRecord (handle)

Purpose: Fetches the change table record corresponding to the
_Cdc-Change-Tracking row into the supplied buffer
Parameters:
phChangeBuffer HANDLE
Top

FetchChangeRecord (handle, logical)

Purpose: Fetches the change table record corresponding to the
_Cdc-Change-Tracking row into the supplied buffer
Parameters:
phChangeBuffer HANDLE
plBefore LOGICAL
Top

LOGICAL FieldChanged (character)

Purpose: Returns whether the named field was changed
in the record currently in the _Cdc-Change-Tracking buffer.
Parameters:
ccolname CHARACTER
Returns LOGICAL
Top

CHARACTER GetChangedFields ()

Purpose: Returns an EXTENT of the names of the changed fields
in the record currently in the _Cdc-Change-Tracking buffer.
Returns CHARACTER
Top

OpenEdge.DataAdmin.Util.CDCOperation GetOperation ()

Purpose: Returns a CDCOperation enum value for the operation
in the record currently in the _Cdc-Change-Tracking buffer.
Returns OpenEdge.DataAdmin.Util.CDCOperation
Top

InternalFetchChangeRecord (handle, integer)

Parameters:
hchgrow HANDLE
iOperation INTEGER
Top

LOGICAL InternalIsRecordSplit (integer)

Parameters:
iOperation INTEGER
Returns LOGICAL
Top

LOGICAL IsCreate ()

Purpose: Whether the _Cdc-Change-Tracking record is for a create
Returns LOGICAL
Top

LOGICAL IsDelete ()

Purpose: Whether the _Cdc-Change-Tracking record is for a delete
Returns LOGICAL
Top

LOGICAL IsRecordSplit ()

Purpose: Returns whether the change table row corresponding to the
_Cdc-Change-Tracking row was split
Returns LOGICAL
Top

LOGICAL IsRecordSplit (logical)

Purpose: Returns whether the change table row corresponding to the
_Cdc-Change-Tracking row was split.
Parameters:
lBefore LOGICAL
Returns LOGICAL
Top

LOGICAL IsUpdate ()

Purpose: Whether the _Cdc-Change-Tracking record is for an update
Returns LOGICAL


Constructor Detail
Top

CDCTrackingHelper (character, character, handle)

Purpose: Creates a CDCTrackingHelper for the given table and owner.
Parameters:
pcSourceTableName CHARACTER
pcTableOwner CHARACTER
phChangeTrackingBuffer HANDLE
Top

CDCTrackingHelper (character, handle)

Purpose: Creates a CDCTrackingHelper for the given table in the PUB schema.
Parameters:
pcSourceTableName CHARACTER
phChangeTrackingBuffer HANDLE


Property Detail
Top

INTEGER SourceTableNumber

Purpose: Table number of source table, for querying _Cdc-Change-Tracking._Source-Table-Number
Returns INTEGER


Copyright © 2017 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7