Chat now with support
Chat with Support

SharePlex 8.6.6 - Reference Guide

About this guide Conventions used in this guide SharePlex commands SharePlex parameters SharePlex utilities Appendix B: SharePlex environment variables

lstatus

Use the lstatus command to view detailed information about the status of replication on a source or target system. This command is the most comprehensive information command in sp_ctrl. To view a brief status of replication, use the status command.

The lstatus command displays:

  • The status of the replication processes, including their associated queues.
  • The operating system process ID of each process.
  • When the process started.
  • The machine where the process is running.
  • The number of messages (SQL or SharePlex operations) in the queues and their age.
  • Whether the machine is a source or target system.
  • Events that took place since sp_cop started.
  • A list of active configurations.

 

The lstatus command also provides information about the queues, including:

  • Type: The kind of queue that it is (capture queue, export queue, post queue).
  • Queue name: The name of the queue, either a default name or the user-assigned name of a named queue.
  • # Messages: The number of messages in the queue. A message approximately corresponds to a SQL operation, but there can be multiple messages for one operation on a LONG or LOB column. Conversely, there could be one message for numerous operations in an array insert.
  • Size: The current size of the queue. This varies with the amount of data. For more information, see “Understanding the SharePlex queues.”
  • Age: The time difference between when the oldest and newest messages in the queue were written to that queue.
  • Oldest Msg Time: The date and time the oldest message entered the queue.
  • Newest Msg Time: The date and time the newest message entered the queue.

The lstatus command also provides other information, such as how the system is being used, its configuration activity, and errors that occurred.

Understanding the SharePlex queues

The following will help you understand the statistics for the SharePlex queues.

Queue size

Although SharePlex uses memory for the queues, the data is periodically written to disk as part of the checkpoint recovery system. The default size for SharePlex queue files is 8 MB. However, queue files are sparse files, meaning that from a system standpoint the file size is 8 MB, but the filesystem might only allocate part of the file for data written to the queues.

That is why the qstatus command can show a queue size of less than 8 MB, but what you see with qstatus is NOT the true indication of the actual file size. To predict disk space usage for the queue files, use the information from qstatus and not the filesystem.

Number of queues

It is normal for the capture and export queues to have fewer queue files than the post queue. Data that resides in one queue file on the source system is separated into multiple sub-queue files on the target system, each approximately corresponding to a user session on the source system.

Names of queues

Queue names are case-sensitive on all platforms. The following explains the naming conventions for SharePlex queues.

  • Default capture queues are identified by their datasource, which is expressed as o.SourceSID, for example o.ora64.
  • Default export queues are identified by the source system's name, for example SysA.
  • Default post queues are identified by the name of the source system appended with datasource-datadestination, where datasource is o.sourceSid and datadestination is o.targetSID, for example lajolla (o.ora10a-o.ora10b).
  • Named export and post queues are identified by their user-assigned names, not the default name. For more information about named queues, see the SharePlex Administrator’s Guide.

Usage

Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: qstatus, show, show statusdb, status

Syntax

Basic command Remote options
lstatus

[ 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

orainfo

Use the orainfo command to view Oracle database information including the SID. The following is an example of the display:

sp_ctrl (mysysl11:2101)> orainfo

Oracle instance #1:

Oracle SID ora12

Oracle HOME /oracle/products/12

Oracle Version 12

Oracle instance #2:

Oracle SID ora12

Oracle HOME /oracle/products/12

Oracle Version 12

 

The following will be displayed if a database account was not created for SharePlex or the statusdb was deleted, or if the command is executed from a version of SharePlex that does not support it.

sp_ctrl (alvspxl11:2101)> orainfo

 

Oracle information not available

Usage

Supported targets: Oracle
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: none

Syntax

Basic command Remote options
orainfo

[ 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

port

Use the port command to connect from sp_ctrl to an instance of sp_cop that is running on a TCP/IP port number other than the default. The default port number for sp_cop is either 2100 (the default port when SharePlex was installed) or a user-defined port that was set with the SP_COP_TPORT and SP_COP_UPORT parameters.

All commands issued during the current session of sp_ctrl will affect the sp_cop running on the specified port until the sp_ctrl session is terminated. A new session of sp_ctrl connects to the default port number or the user-defined port, if one was defined for the instance of SharePlex.

When to use the port command

When you are running one instance of sp_cop, using the port command is unnecessary. On startup, sp_ctrl determines the port number by first checking for a user-defined port and, if none exists, defaulting to port 2100.

Use the port command when you are running multiple instances of sp_cop on dedicated ports (such as in consolidated replication) and default ports for them were not set with the SP_COP_TPORT and SP_COP_UPORT parameters. To issue commands for multiple sp_cop instances, open a session of sp_ctrl for each one, and use the port command to set a port for each session.

SharePlex notifies you as follows if the port command is required when you start sp_ctrl:

“Your tcp port is not set properly or 'sp_cop' is not running.”

The warning indicates that sp_cop is not running or that it is running on a different port than the default.

The port command cannot be issued from a remote machine, so there are no [on host] options.

Usage

Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: host

Syntax

Basic command Remote options
port number Not available

Syntax description

Component Description
number

The port number you want to use. There must be a space between port and the port number.

Example:

sp_ctrl> port 2200

purge config

Use the purge config command to remove the data from all queues associated with a configuration without removing the queues themselves or deactivating the configuration. Avoiding a deactivation avoids the need for SharePlex to recalculate the configuration data. This saves time when the tables are large and numerous, enabling replication can start sooner.

Issue the purge config command on the source system to affect the source system and all target systems in the configured routes. Should any SharePlex process stop prior to or during the purge config activity, the command also stops working. When the process starts again, the command resumes working. Thus, purge config works even when the network is temporarily unavailable — the command remains in the queues until the connection is restored.

Cautions for using the purge config command

  • Do not activate a configuration and then follow the activate config command with a purge config command. You might be purging more than just queued data, including the configuration information that controls replication, thus rendering the activation invalid.
  • When there are multiple active configurations on the same source system, use the purge config command only if there are named export queues that separate the replication streams for each one. Without named export queues, SharePlex funnels all replicated data through one export queue, and a purge config command for one configuration deletes the data for all of them. To create named queues, see Chapter 5 of the SharePlex Administrator’s Guide.

Usage

Supported targets: All
Authorization level: Administrator (1)
Issued for: source system
Related commands: abort config, deactivate config

Syntax

Basic command Remote options
purge config filename

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
filename

The name of the configuration that you want to purge. Configuration names are case-sensitive.

Example:

sp_ctrl(sysA)> purge config sales

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