Chat now with support
Chat with Support

SharePlex 9.2.5 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters General SharePlex utilities Database Setup utilities SharePlex environment variables

flush

Use the flush command to stop the Post process at a certain point. It puts a marker in the data stream and automatically stops the Post process at the marker point. You can issue this command at a certain time or date – when month-end reports need to be generated, for example – and the data on the target system will reflect what was on the source system at the time the command was issued.

When you are performing backups, or when following certain documented SharePlex procedures, you issue the flush command after you stop user access on the source system to ensure that the last transaction gets posted to the target database before Post is stopped.

Starting Post again

Changes generated after the flush command accumulate in the queues and are applied to the target instance after you start Post again. Post remains stopped until the start post command is issued. Post keeps a record of where it stopped and resumes posting from that point to maintain synchronization.

Important: If users continue making changes on the source system while Post is stopped, data will accumulate in the post queue and possibly consume all available disk space. Remember to start Post as soon as permissible.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Operator (2)
Issued for: source system
Related commands: stop

Syntax

Basic command Command options Remote options
flush datasource

[to host]

[queue queuename]

[to host queue queuename]

[to host@target_SID]

[to host@target_SID queue queuename]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
datasource

This argument specifies the source data that the command will affect. Without additional options, it flushes the data through all queues on all target systems and stops Post.

datasource is expressed as o.SID, where SID is the ORACLE_SID of the source Oracle instance.

Example:

sp_ctrl(sysA)> flush o.oraA

In this example, the data for instance oraA is flushed to all target systems.

to host

This option flushes all of the data replicating to a designated target system. Replication to other target systems is unaffected.

Example:

sp_ctrl(sysA)> flush o.oraA to sysB

In this example, the data is flushed from sysA to sysB.

queue queuename

This option flushes data for a designated post queue. It flushes data flowing through all queues of that name on all target systems. This option is most useful when there are named post queues.

Example:

sp_ctrl(sysA)> flush o.oraA queue sales

In this example, the data is flushed for post queue sales on all target systems that have a post queue of that name.

to host queue queuename

This option flushes data for a designated post queue on a designated target system. Other post queues on that and other target systems are unaffected.

Example:

sp_ctrl(sysA)> flush o.oraA to sysB queue sales

In this example, the data is flushed for post queue sales on sysB.

to host@datadest

This option flushes data to a designated target instance on a designated target system. It does not affect:

  • Other target instances on that system.
  • Other target instances with the same ORACLE_SID on other target systems

In the syntax:

  • host is the target system’s name.
  • datadest is expressed as o.SID, where SID is the ORACLE_SID of the target instance.

Example:

sp_ctrl(sysA)> flush o.oraA to sysB@o.oraB

In this example, the data is flushed to instance oraB on sysB.

to host@datadest queue queuename

This option flushes data for a designated post queue and target instance on a designated target system. It does not affect:

  • Other post queues for that instance or any other target instance on that system.
  • Other post queues on any other target system.

In the syntax:

  • host is the target system’s name.
  • datadest is expressed as o.SID, where SID is the ORACLE_SID of the target instance.
  • queuename is the name of the post queue.

Example:

sp_ctrl(sysA)> flush o.oraA to sysB@o.oraB queue sales

In this example, the data is flushed for post queue sales for target instance oraB on sysB.

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

help

Use the help command to get help for SharePlex commands while working within sp_ctrl.

  • Using this command without any options produces a list of SharePlex command groups.
  • Additional options enable you to drill down through each group to get help for a specific command.

There are no [on host] options for this command.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: usage

Syntax

Basic command Command options Remote options
help

{group_name}

{command_name}

Not available

Syntax description

Component Description
group_name

Displays the commands within each group for which specific help can be obtained. Valid values are:

config

connect

info

maint

misc

param

properties

queues

run

sync

For a list of commands within each group, see “SharePlex commands at a glance.”

Example:

sp_ctrl(sysA)> help run

Control processes

abort service - Stop one or all replication processes immediately.

shutdown - Shut down SharePlex.

start - Restart one or all stopped replication processes.

stop - Stop one or all replication processes gracefully.

command_name

This option provides help for a designated command.

Example:

sp_ctrl(sysA)> help start

Restart a SharePlex process that was stopped with a "stop" or "abort service" command.

 

host

Use the host command to establish a default system for sp_ctrl. A default machine enables you to enter a series of commands without using the [on host] option for each one. The TCP/IP connection to the default system remains active until you exit sp_ctrl or issue another host command.

The default system name is displayed as part of the sp_ctrl prompt as shown below:

sp_ctrl(hostname)>.

The default system can be the machine where you are running sp_ctrl or any other system to which that machine can connect through TCP/IP.

To issue a command for a system other than the default, use the command’s [on host] option to temporarily connect to the alternate system. When the command finishes, it returns you to the default sp_ctrl connection.

The host command can only be issued from within sp_ctrl at the sp_ctrl prompt.

TIP: To set a default port number for an sp_ctrl session, use the port command.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: port

Syntax

Basic command Remote options
host hostname

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
hostname

The name of the machine that you want to establish as the default. This name must reside in your system’s /etc/hosts file (Unix and Linux) or hosts file (Windows).

Example:

sp_ctrl(sysA)> host sysB

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

hostinfo

Use the hostinfo command to view information about a system’s hardware, including the operating system, machine name, OS version and revision.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: none

Syntax

Basic command Remote options
hostinfo

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Remote options

These options enable you to issue the command on a remote machine and to script commands that include a login name, password, port number, or combination of those items.

Option Description
on host

Execute the command on a remote system (one other than the one where the current sp_ctrl session is running). You are prompted for login credentials for the remote system. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA

on host:portnumber

Execute the command on a remote system when a remote login and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on SysA:8304

on login/password@host

Execute the command on a remote system when a remote login, password, and host name must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA

on login/password@host:portnumber

Execute the command on a remote system when a remote login, password, host name, and port number must be provided. If used, must be the last component of the command syntax.

Example: sp_ctrl(sysB)>status on john/spot5489@SysA:8304

Related Documents