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

edit

 

Use the edit command in the following ways:

  • To make changes to a SharePlex command that you previously issued. This saves time when you need to issue a command again, but with slightly different syntax, or if you need to correct a syntax mistake.
  • To execute commands that contain more than 255 characters, a limitation of the operating system.

The edit command opens a temporary text file in the default text editor from within the sp_ctrl interface. You enter the command in the file, and it automatically executes when you save the file.

To use the edit command

  1. If no commands were issued previously in the current session of sp_ctrl, type the first word of the command at the sp_ctrl prompt, then press Enter. Otherwise, skip this step. (Ignore the online help or error that is displayed.)
  2. At the sp_ctrl prompt, issue the edit command to open a temporary text file.

    sp_ctrl(sysA)> edit

  3. In the text file, use the editor’s standard commands to edit out any unwanted characters and type the command string.
  4. Save and exit out of the file using the editor’s standard save command. The command executes immediately

Note: SharePlex provides keyboard shortcuts for the edit command in the for of the up arrow (  ) and the forward slash ( / ) keys.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: The user must have the previous command’s authorization level or higher.
Issued for: The system affected by the previous command
Related commands: none

Syntax

Basic command Remote options
edit | ed not available

edit config

Use the edit config command to modify an inactive configuration file. This command opens the configuration in SharePlex’s default text editor. Modify and save the configuration using the tools provided by the editor.

To modify an active configuration, it is recommended that you copy the active configuration with the copy config command, and then edit the copy with the edit config command. When you activate the copy, the original configuration deactivates.

To view a list of configurations on a system, use the list config command. To view the contents of a configuration, use the view config command.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Operator (2)
Issued for: source system
Related commands: activate config, copy config, create config, list config, remove config, rename config, verify config, view config

Syntax

Basic command Remote options
edit 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 edit. Configuration names are case-sensitive.

Example:

sp_ctrl(sysA)> edit 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

exit

Use the exit command to close the current session of sp_ctrl. Closing sp_ctrl does not shut down replication; all replication processes continue without interruption unless they have been stopped by a user. This command merely discontinues your session with sp_ctrl on that system. To run sp_ctrl again, change to the directory containing the SharePlex binaries and enter the ./sp_ctrl command (for Unix and Linux systems) or double-click the sp_ctrl shortcut (Windows systems).

There are no [on host] options for the exit command. It must be issued on the system where you want to stop running sp_ctrl.

This command is the same as the quit command.

Usage

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

Syntax

Basic command Remote options
exit | e not available

expand

Use the expand command to expand a wildcard specification and display it to the screen. This is particularly useful if you are not sure whether a wildcard specification will produce the list of tables that you want to replicate. For more information on how to use wildcards in the configuration file, see the SharePlex Administration Guide.

Usage

Supported sources: Oracle and SQL Server
Supported targets: All
Authorization level: Viewer (3)
Issued for: source or target system
Related commands: create config, edit config, show config, verify config

Syntax

Basic command Command options Remote options
expand filespec

[not (list of exclusions)]

[for o.source_sid]

[on host]

[ on host |

on host:portnumber |

on login/password@host |

on login/password@host:portnumber ]

Syntax description

Component Description
filespec

The wildcard specification (including the owner) that the command will verify. Without the for o.source_sid option, it is assumed that there is an active configuration file that contains the wildcarded objects.

Example:

sp_ctrl(sysA)> expand scott.%

In this example, the result will display all objects in the scott schema.

not (list of exclusions)

Exclusions to the wildcard specification. Listed objects are excluded from the expansion.

Example:

sp_ctrl(sysA)> expand scott.% for o.oraA not (%"sal"%)

In this example, the result displays all objects in the scott schema from the oraA instance, except for any objects with names that contain “sal.” Please note that in this example, "sal" is enclosed within quotation marks because it is case sensitive.

for o.source_sid

Use when there is no active configuration file to specify the Oracle instance against which the command will be executed.

Example:

sp_ctrl(sysA)> expand scott.% for o.oraA

In this example, the result will display all objects in the “scott” schema from the oraA instance.

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