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

shutdown

Use the shutdown command to shut down replication. Upon completion of the shutdown command, SharePlex shuts down sp_ctrl automatically.

Shutting down gracefully

The basic shutdown command shuts down sp_cop (the SharePlex service on Windows systems) and all other SharePlex processes gracefully, saving the state of each process, performing a checkpoint to disk, read-releasing buffered data, and cleaning up child processes. Data in the queues remains safely in place, ready for processing when an authorized user starts sp_cop again.

Shutting down forcefully

The shutdown command with the [force] option kills the SharePlex processes immediately, whether or not the normal shutdown procedures were completed. SharePlex recovers from a forced shutdown when you start sp_cop, but replication processing resumes from a previous save point, which means startup can be slightly longer.

Use the [force] option only if you tried to shut down SharePlex gracefully, but child processes remained running. You can verify whether SharePlex processes are still running by issuing the ps -ef | grep sp_ command in the command shell or by viewing the Processes tab in Windows Task Manager.

Important: If you shut down replication and users continue changing the objects in the active configuration(s), it is possible for the Oracle redo logs to wrap before SharePlex starts again. If the delay is long and the archive logs become unavailable, you will need to re-synchronize the data. The redo logs should be large and numerous enough to accommodate the time SharePlex will be shut down. For more information about the proper sizing of the redo logs for replication, see the SharePlex Installation and Setup Guide.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Administrator (1)
Issued for: source or target system
Related commands: startup

Syntax

Basic command Command options Remote options
shutdown

[force]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
force

This option shuts down all replication processes, including sp_cop, immediately, whether or not they have finished reading from or writing to a queue. Use this option if the default shutdown command fails or you cannot wait for a graceful shutdown.

Example:

sp_ctrl(sysA)> shutdown force

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

start

Use the start command to start a replication process after it was stopped using the stop or abort [service] command, or after Post was stopped by the flush command.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Operator (2); Administer (1) required for Capture
Issued for: source or target system
Related commands: stop

Syntax

Basic command Command options Remote options
start service

[to host]

[from host]

[for datasource]

[for datasource-datadest]

[queue queuename]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
service

The SharePlex process you want to start. Valid values are:

  • Capture
  • Read
  • Export
  • Import
  • Post

Example:

sp_ctrl(sysA)> start export

to host

This option starts Export to a designated target system only.

to is a required part of the syntax.

host is the name of the target system.

Example:

sp_ctrl(sysA)> start export to sysB

In this example, Export is started from sysA to sysB.

from host

This option starts Import from a designated source system only.

  • from is a required part of the syntax.
  • host is the name of the source system.

Example:

sp_ctrl(sysD)> start import from sysA

In this example, Import is started on sysD from sysA.

for datasource

This option starts Capture or Read for a designated datasource.

  • for is a required part of the syntax.
  • datasource is expressed as o.SID or r.database, where SID is an ORACLE_SID or database is the name of a SQL Server database.

Example:

sp_ctrl(sysA)> start read for o.oraA

In this example, Read is started on sysA for instance oraA.

for datasource-datadest

This option starts Post for a designated source SID-target SID data stream only.

  • for is a required part of the syntax.
  • datasource is expressed as o.SID or r.database, where SID is an ORACLE_SID or database is the name of a SQL Server database.

  • datadest is expressed as o.SID or r.database, where SID is an ORACLE_SID or database is the name of an Open Target database.

  • Note: When the source is SQL Server, datadest can only be an Oracle or SQL Server target.

Example:

sp_ctrl(sysC)> start post for o.oraA-r.mssA

In this example, Post is started on sysC for instance oraA replicating to SQL Server database mssA.

queue queuename

This option starts the Export, Import or Post process associated with a designated named queue.

queue is a required part of the syntax.

queuename is the named of the queue as written in the configuration file.

Example:

sp_ctrl(sysA)> start export queue QA

In this example, Export of data through named export queue QA is started on sysA.

   

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

startup

Use the startup command to start all processes at once. All of the processes will start unless they were stopped with the stop command prior to shutting down sp_cop.

When there is an active configuration, replication normally starts automatically when you start sp_cop from the command line.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Administrator (1)
Issued for: source or target system
Related commands: shutdown

Syntax

Basic command Remote options
startup

[ 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

status

Use the status command to view a summary of the status of replication on a system, to ensure that processes are running and to check for errors, warnings or notices. For a more detailed status report, use the lstatus command.

The status display shows:

  • Process: The name of the process.
  • State: The status of each process, either running, idle, stopped due to error, or stopped by user
  • PID: The operating-system process ID number of the process
  • Running Since: The date and time that the process was started
  • Other information: such as how the system is being used, if there is an active configuration on the system, and if replication errors occurred.

SharePlex updates the status display at intervals determined by the SP_COP_IDLETIME parameter.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: lstatus, qstatus, show, show statusdb

Syntax

Basic command Remote options
status

[ 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