Chat now with support
Chat with Support

SharePlex 9.0.1 - Reference Guide

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

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 replication only if sp_cop was started using the [–s] option on a Unix or Linux machine. When there is an active configuration, replication normally starts automatically when you start sp_cop from the command line. But when the [–s] option is used at startup, the replication processes (Capture, Read, Export, Import, Post) remain in an idle state.

When sp_cop is started with the [–s] option, you cannot start processes individually with the start command. You must start them all with the startup command. All of the processes will start unless they were stopped with the stop command prior to shutting down sp_cop.

Note: For more information about starting SharePlex with the [-s] option, see the SharePlex Administration Guide.

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

stop

Use the stop command to stop a SharePlex replication process gracefully, allowing it to finish reading from, or writing to, its associated queues. When you stop a replication process, data accumulates safely in the queues.

A process stopped with the stop command remains stopped even when SharePlex is shut down and restarted. It can only be started with the start command. When the process starts again, it resumes processing at the point where stopped, so the data remains synchronized.

Note: The stop command differs from the abort service command in that it stops a replication process after the process has finished reading from, or writing to, its associated queue. The abort service command immediately terminates the process, whether or not the process is processing data.

Stopping the Capture process

Be careful when you stop the Capture process. The source and target data can go out of synchronization if:

  • Users continue changing the source data while Capture is stopped.

    and...

  • The Oracle redo logs wrap during that time.

    and...

  • The archive logs become unavailable.

Stopping Post at a specific point in time

Use one of the [at sourcetime] options to control when the Post process stops. Either of those options automatically stops Post when it receives the first message stamped with a designated time, or time and date. Subsequent messages accumulate in the post queue until Post is restarted.

You can use an [at sourcetime] option when a job is scheduled on the source system, and you want to be certain that the operations were successful there before they are applied to the target database. Set the option to stop Post just before the job is scheduled to run.

You also can use this option when you are running reports on the target system and do not want Post operations competing for overhead.

Because SharePlex is not synchronous, the actual time on the target system when Post stops probably will be later than the operation’s timestamp. The timing depends on how long it takes to post preceding messages in the queue.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Operator (2); Administrator (1) required to stop Capture
Issued for:
  • stop for Capture, Read and Export is issued for the source system.
  • stop for Import and Post is issued for the target system.
Related commands: abort service, start

Syntax

Basic command Command options Remote options
stop service

[to host]

[from host]

[for datasource]

[for datasource-datadest]

[queue queuename]

[at sourcetime hh:mm:ss]

[at sourcetime mm/dd/yyyy hh:mm:ss]

[ 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 stop. Valid values are:

  • Capture
  • Read
  • Export
  • Import
  • Post

Example:

sp_ctrl(sysA)> stop export

to host

This option stops Export to a designated target system, while allowing Export to other systems to continue.

  • to is a required part of the syntax.
  • host is the name of the target system.

Example:

sp_ctrl(sysA)> stop export to sysB

In this example, Export is stopped from sysA to sysB, but Export from sysA to other target systems continues.

from host

This option stops Import from a designated source system, while allowing Import from other systems to continue.

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

Example:

sp_ctrl(sysD)> stop import from sysC

In this example, Import from sys C is stopped on sysD, but Import on sysD from other systems continues.

for datasource

This option stops 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)> stop read for o.oraA

In this example, Read is stopped on sysA for instance oraA, but other Read processes for other instances on sysA continue processing.

for datasource-datadest

This option stops Post for a designated source-target data stream.

  • 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.

Example:

sp_ctrl(sysC)> stop post for o.oraA-o.oraC

In this example, Post is stopped on sysC for instance oraA replicating to oraC, but other Post processes on sysC continue posting.

queue queuename

This option stops the Export, Import or Post process associated with a named queue. Replication through other named queues continues unaffected.

  • queue is a required part of the syntax.
  • queuename is the user-defined name of the queue, as shown in the configuration file.

Example:

sp_ctrl(sysA)> stop export queue QA

In this example, Export of data through named export queue QA is stopped on sysA, but Export continues for data assigned to all other named queues.

at sourcetime hh:mm:ss

This option stops the Post process when it receives the first message stamped with the designated time. Subsequent messages accumulate in the post queue until Post is restarted.

  • at sourcetime is a required part of the syntax.
  • hh:mm:ss is the time stamp at which Post stops, which must be specified using a 24-hour clock. Pad single-digit components with a zero (0). Allow no spaces.

Example:

sp_ctrl(sysC)> stop post at sourcetime 24:00:00

In this example, Post stops on sysC when it receives the first message with the timestamp of midnight.

at sourcetime mm/dd/yyyy hh:mm:ss

This option stops the Post process when it receives the first message stamped with the designated time and date. It has the same purpose and functionality as stop post at sourcetime hh:mm:ss, with an added date option.

  • at sourcetime is a required part of the syntax.
  • mm/dd/yyyy is the date on which you want Post to stop at the designated time. The date component must precede the time component in the syntax. The year must include all four digits. Pad single-digit components with a zero (0). Allow no spaces. Separate this component from the time component with a space.
  • hh:mm:ss is the time stamp at which Post stops, which must be specified using a 24-hour clock. Pad single-digit components with a zero (0).

Example:

sp_ctrl(sysC)> stop post at sourcetime 01/31/2002 24:00:00

In this example, Post stops on sysC when it receives the first message stamped midnight, January 31, 2002.

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating