Chat now with support
Chat with Support

SharePlex 10.1.3 - Reference Guide

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

job status

Use the job status command to view the status of the last compare, compare using, repair, repair using, copy or append job, and for any other jobs that are still running. The job status command can be used to view detailed status on a job or a portion of a job, or to view status on all jobs for which SharePlex has history. SharePlex retains the history for all jobs as specified by the SP_SYS_JOB_HISTORY_RETENTION parameter. See the clear history and remove log commands for information on actively removing history and/or job process logs.

 

sp_ctrl (sysA) > job status

Job ID : 861
PID : 20571
Host : sysa.domm.com
Started : 06-NOV-12 11:07:05
Job Type : Compare
Status : Processing - 4 objects completed

ID Tablename Status Time Total rows %Comp Total time
--- ------------------------- -------- --------- ------------------ ------ -----------
1 "SCOTT"."SRC_TEST1" Out Sync N/A 19 100 0:05
4 "SCOTT"."SRC_TEST4" WaitMarker 0:02 27392   0:04
5 "SCOTT"."SRC_TEST5" Init 0:01 27498   0:01

 

To view a summary of all jobs for which SharePlex has history:

sp_ctrl (alvspxl11:8567)> job status all

 

Job ID Type filename/tablename Status Started Completed
------- ------ ------------------ -------- --------------- -----------------
3441 Compare prod.conf Done - errors 16-DEC-11 15:39 16-DEC-11 15:40
3442 Repair scott.src_test4 Done 16-DEC-11 15:50 16-DEC-11 15:50
3443 Repair prod.conf Done 19-DEC-11 10:42 19-DEC-11 10:42
3444 Copy "SCOTT"."SRC_TEST5" Done 19-DEC-11 10:43 19-DEC-11 10:43
3445 Compare scott.src_test33 Done - errors 20-DEC-11 12:02 20-DEC-11 12:03

 

To view the status of a job with detail:

sp_ctrl (alvspxl11:8567)> compare status detail

 

Job ID : 3448
PID : 763
Host : sysa.domm.com
Started : 20-DEC-11 12:40:46
Job Type : Compare
Status : Done - 6 objects completed

 

Table ID : 3448.3
Table : "SCOTT"."SRC_TEST3"
From : sysa.domm.com@o.w111a64f
To : "SYSPROD"."SRC_TEST3" sysb.domm.com@o.w111a64f
Started : 20-DEC-11 12:40:55
Percent complete : 100%
Total Rows : 234452
Rows processed : 234452
Rows out-of-sync : 2
Status : Out Sync
Status Elapsed : N/A
Total Elapsed : 0:07
Inserts : 2
Updates : 0
Deletes : 0

 

Usage

Supported sources: Oracle
Supported targets: Oracle
Authorization level: Operator (2)
Issued for: source system
Related commands: copy status, append status, compare status, repair status

Syntax

Basic command Command options Remote options
job status

[job_id]

[job_id.table_id]

[all]

[full]

[detail]

[status]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
job_id

Displays status history for the job with the specified SharePlex-assigned job ID.

Example:

sp_ctrl(sysA)> job status 2828.2

job_id.table_id

Displays status history for the job with the specified SharePlex-assigned job ID and table.

Example:

sp_ctrl(sysA)> job status 2828.HR.SRC_TEST3

all

Displays a summary line for every job with history in the database.

Example:

sp_ctrl(sysA)> job status all

full

Displays the status of every object in the job. By default, the job status command displays the status of those objects not completed, or completed with an exceptional status.

Example:

sp_ctrl(sysA)> job status2828 full

detail

Displays detail information for every object reported upon. By default, the job status command displays a summary line for every object reported upon. Note that the detail information is the same as is displayed for the job_id.table_id option.

Example:

sp_ctrl(sysA)> job status detail

status

Displays status history for previous jobs with the specified status.

sp_ctrl(SysA)> job status “Error”

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

list config

Use the list config command to view a list of all active and inactive configurations on a source system. The command displays the following information:

  • File Name: The name of the configuration, the time and date that it was modified, and the size of the file.
  • State: Whether the configuration is active or inactive. Active means the configuration file is currently involved in replication. Inactive means the configuration is not currently involved in replication.
  • Datasource: The Oracle instance containing the objects being replicated by the configuration.
  • Internal Name: The name of the internal copy of the active configuration. This is the file that SharePlex actually replicates from. Its name is displayed under the State heading wherever there is an active configuration.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Viewer (3)
Issued for: source system
Related commands: view config, show config

Syntax

Basic command Remote options
list config

[ 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

list param

Use the list param command to display SharePlex tuning parameters. Without options, the command displays the basic (user configurable) parameters and their current settings. Options are available for displaying:

  • All SharePlex parameters, including those that should not be changed by a SharePlex user (internal parameters).
  • Only the basic and internal parameters whose settings have been changed from their default values. (These settings are recorded in the SharePlex variable-data directory.)
  • Either of the preceding options filtered according to the SharePlex module.

Parameters are grouped by module, each module representing a functional component of the software. The following table lists the modules that contain user-configurable parameters (which can be changed without guidance from Quest).

SharePlex parameter modules

Module Naming convention Function controlled
analyze SP_ANL analyze config command
cap SP_CAP Non-Oracle Capture
capture SP_OCT or SP_CAP Capture process
compare SP_DEQ or SP_CMP compare commands
config SP_OCF configuration activation process
cop SP_COP sp_cop
copy SP_OSY or SP_CPY the copy/ append commands
export SP_XPT Export process
import SP_IMP Import process
logging SP_SLG the SNMP feature
post SP_OPO or SP_OPX Post process
queue SP_QUE the SharePlex queues
read SP_ORD Read process
SNMP SP_SNMP SNMP support
system SP_SYS system-related items

Each list param display provides the parameter’s:

  • Name
  • Actual Value: the parameter’s current setting and its default value, if different.
  • Units: the parameter’s unit of measurement, such as seconds, kilobytes, or operations.
  • Set-At point: the point where the parameter becomes active when you issue the set param command, either immediately after the parameter is set, after the affected process is restarted, or after sp_cop is restarted.

Usage

Supported sources: Oracle
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: set param, reset param

Syntax

Basic command Command options Remote options
list param

[basic | all | modified] [module]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
basic

This option displays parameters that can be set by users without guidance from a Quest support engineer or technical specialist.

Example:

sp_ctrl(sysA)> list param basic

all

This option displays all of the SharePlex parameters, including basic (user-configurable) parameters and internal parameters (whose settings you should not change without guidance from Quest).

Example:

sp_ctrl(sysA)> list param all

modified

This option lists the user-configurable and internal parameters that have been modified from their default values.

Example:

sp_ctrl(sysA)> list param modified

module

This option constrains the output to parameters for a specific module. See SharePlex parameter modules.

This option, if used, must appear after the list param [all | modified] syntax.

Example:

sp_ctrl> list param all post

In this example, SharePlex displays all parameters for the Post process.

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

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

Usage

Supported sources: Oracle
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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating