SharePlex 8.6.6 - Preinstallation Checklist

target

Use the target command to configure Post to support a specific type of target. This is known as the target configuration. The properties stored in the target configuration control how Post processes, formats, and outputs replicated data.

The target command also provides options to reset or view target configuration settings.

The target command can be used to control a target configuration both at the global level or, if the queue option is used, at the per-process level.

Usage

Syntax

Syntax Description

Category descriptions

cdc category

Supported targets

Oracle (configured as a change-history target)

Command options

target c.SID [queue queuename]

table tablename

{

set cdc preimage={yes | no}

reset cdc

show cdc

}

Usage

Overrides the global setting for updates that is set with the SP_OPO_TRACK_PREIMAGE parameter for a specific table. This controls whether the before image of update operations are tracked in the history table. Valid values are yes to track before images of updates, or no to exclude update before images.

characterset category

Supported targets

Open Target databases

Command options

target r.database [queue queuename]

{

set characterset character_set |

reset characterset character_set |

show characterset character_set

}

Usage

Directs the Post process to send replicated data to the local Oracle client to be converted to the specified character set before being posted to the target database. The specified character set overrides the default character set of Unicode that is used by Post when posting character data to Open Target targets.

Note: To use this option, there must be an Oracle client on the target system. For more information, see the Open Target databases

Example

To post the data in the GB2312 character set on the target, specify the Oracle ZHS16GBK character set.

target r.mymss set characterset ZHS16GBK

datatype category

Supported targets

Open Target databases

Command options

target r.database [queue queuename]

{

set datatype src_datatype=tgt_datatype |

reset datatype [src_datatype] |

show datatype [for database_type]

}

Usage

SharePlex provides default source-target column mappings for each type of Open Target target database that it supports. The mappings determine the datatypes of new columns that Post creates when applying Oracle ALTER TABLE ADD COLUMN commands to an Open Target target.

You can use the target command with the set dataype option to set your own column mapping for a supported target or for other Open Target targets in a test environment. The mapping affects the entire target configuration (not per table).

Important: If you modify the default mapping, SharePlex cannot validate the accuracy of the new mapping. Quest cannot be held responsible for any inaccuracies that result from custom mappings.

Use the reset datatype option to restore one or more mappings to their defaults. Use the show option to view the default mappings and any overrides.

Examples

The following command sets the Oracle datatype BLOB to map to the SQL Server datatype IMAGE.

target r.mymss set datatype blob=image

The following command displays the current and default datatype mappings for a SQL Server target.

target r.myss show datatype for sqlserver

file category

Supported targets

File

Command options

target x.file [queue queuename]

{

set file property=value |

reset file [property] |

show file

}

Usage

Example

target x.file set file max_size=320

format category

Supported targets

File

Command options

target x.file [queue queuename]

{

set format property=value |

reset format [property] |

show format

}

Usage

Example

target x.file set format record=sql

jms category

Supported targets

JMS

Command options

target x.jms [queue queuename]

{

set jms property=value |

reset jms [property] |

show jms

}

Usage

Each property takes the form of a keyword=value pair.

Example

target x.jms set jms queuename=SharePlexJMS

kafka category

Supported targets

Kafka

Command options

target x.kafka [queue queuename]

{

set kafka property=value |

reset kafka [property] |

show kafka

}

Usage

Each property takes the form of a keyword=value pair.

* To avoid latency, if Post detects no more incoming messages, it sends the packet to Kafka immediately without waiting for the threshold to be satisfied.

Example

target x.kafka set kafka topic=MyTopicName

metadata category

Supported targets

Oracle, File (XML output), JMS, Kafka

Command options

target {c.SID | x.file | x.jms | x.kafka} [queue queuename]

{

set metadata [colname:]property[, ...] |

reset metadata |

show metadata

}

Usage

The target command with set metadata can be used to override the default metadata properties that are set for a database target, an XML file target, a JMS target, or a Kafka target. All of these target types provide metadata in the Post output.

• For an Oracle change-history target, if no target specification is made, Post updates the default metadata columns, which must exist in their default names before starting replication. The default columns are shown in the default metadata properties that are marked in the following table with an asterisk (*). Use the target command with set metadata only if you want to add additional metadata or change a column name from its default to a custom name. To change a custom name, use the colname option shown in the command syntax.
• For XML output to a file, JMS, or Kafka, the metadata is added in XML format per the XML schema. Default metadata is added without any special configuration and is marked in the following table with an asterisk. Use the target command with set metadata only to add additional metadata.

For more information about configuring SharePlex to support a change history target database, see the SharePlexAdministrator Guide.

To set multiple metadata properties, specify them as a comma-separated list.

Note: The properties marked with asterisks (*) are populated by default without requiring the target command.

JMS and Kafka set metadata example

The following sets all Post processes to add the IP address or hostname of the source, name of the SharePlex queue, and the number of operations in the transaction to the output in the JMS target.

target x.jms set metadata host, queue, size

or...

target x.kafka set metadata host, queue, size

Oracle set metadata example

The following example sets the Post process associated with the myqueue1 queue to add the time of the operation and the userid that executed it to the Timestamp and User columns, both of which are user-defined names that are case-sensitive.

target c.targSID queue myqueue1 set metadata time:"Timestamp", userid:"User"

resources category

Supported targets

Teradata

Command options

target r.target [queue queuename]

{

set resources property=value |

reset resources [property] |

show resources [for datastore]

}

Usage

Examples

target r.mydb queue q1 set resources commit_frequency=10000

target r.mydb queue q1 set resources max_active_statements=10

target r.mydb show resources for teradata

rule | filter category

Supported targets

Oracle (configured as a change-history target)

Command options

target c.SID [queue queuename]

table tablename

{

set {rule | filter} { 'column_condition' | !filename }

reset {rule | filter}

show {rule | filter}

}

Usage

Applies to UPDATE operations. Applies conditional logic that qualifies the data that you want to track to a target table, while excluding data that is not of interest. There can be one rule or filter per target table, but you can combine nested expressions with parentheses and the AND, OR, and NOT logical connectives to create a wide variety of conditions.

Note: Batch and direct load operations are not supported by the rule/filter feature.

Examples

These commands show some examples of how to set different rules by combining expressions:

target c.mySIDtable mytable set rule '(col3 is not changed) and (col5 is not changed)'

target c.mySIDtable mytable set rule '([col1, col3] matches change_list)'

target c.mySIDtable mytable set rule 'not ([col2, col5] contains change_list)'

The following table shows the different ways that rule and filter work to include or discard rows.

source category

Supported targets

Oracle

Command options

target c.SID [queue queuename]

{

set source sourceID |

reset source |

show source

}

Usage

Sets the user-defined source identifier for the SHAREPLEX_SOURCE_ID metadata column. Use target with the set metadata source option to configure Post to populate this column. Specify any single alphanumeric string.

Example

The following shows the use of set source to support a configuration where the data from multiple source databases is being replicated to the same target database. This target configuration causes each Post process to update the SHAREPLEX_SOURCE_ID column with a different source ID, depending on the source database, to differentiate the data in the target database. This example uses four Post processes.

target c.target1 queue source718 set source east

target c.target1 queue source92 set source south

target c.target1 queue source101 set source west

target c.target1 queue source75 set source north

The Post process for queue “source718” will update column SHAREPLEX_SOURCE_ID with the value "east" for every insert or update to a table in its stream. The Post process for queue "source92" will update column SHAREPLEX_SOURCE_ID with the value "south", and so on for the other two Post processes.

sql category

Supported targets

File (SQL output)

Command options

target x.file [queue queuename]

{

set sql property=value |

reset sql [property] |

show sql

}

Usage

Example

target x.file set sql comment=#