PG_cleansp
PG_Cleansp Utility
Description
Use the pg_cleansp utility to remove the current replication state on a system where SharePlex is replicating to a PostgreSQL source and target both.
Caution: The effects of pg_cleansp are not reversible.
Usage guidelines
- To use this utility, the Korn (ksh) shell must be installed on the system. The utility calls this shell during processing.
- pg_cleansp must be run on all PostgreSQL source and target systems in the replication configuration.
- To fully remove the replication environment, run the pg_cleansp utility on all PostgreSQL source systems in the replication configuration. To verify if and when pg_cleansp was run on a system, view the SharePlex event log on that system.
What this utility does
pg_cleansp does the following on the source system:
- Truncates all the SharePlex Client internal tables in the SharePlex schema and any other SharePlex-installed tables as applicable.
- Removes the following from the variable-data directory: the queue files, the process log files, the statusdb file, the contents of the dump and state directories, and all but one entry in the event log (the status entry for pg_cleansp)
pg_cleansp preserves the following:
- The SharePlex database, account, and password, and only cleans the data in the SharePlex tables.
- User-created files such as the paramdb and the target configuration settings
To run the pg_cleansp utility on PostgreSQL source and target:
- Stop all SharePlex processes on the system.
- Shut down sp_cop.
-
Run the pg_cleansp utility from the bin sub-directory of the SharePlex product directory with the following syntax:
<installationDirectiory\ProductDirectory>/binpg_cleansp [portnumber ] database_name/user_name
where:
- portnumber is the port number of the SharePlex instance, if other than the default of 2100.
- database_name is the name of the SharePlex database.
- user_name is the name of the SharePlex user account.
-
Enter the password at the prompt.
Enter the password for the SharePlex User :
-
Type Y to confirm that you want to run cleanup for this SharePlex instance.
Are you sure you want to perform the clean for '/splex/vardir/var2' and port 2200? [N] :Y
A successful setup terminates with a message similar to the following:
Clean port 3800
sh: /splex/atul/1100B51/opt/.app-modules//clean_vardir.sh: /bin/ksh: bad interpreter: No such file or directory
postgress internal tables are cleaned up.
Snowflake_Cleansp Utility
Description
Use the snowflake_cleansp utility to remove the current replication state on a system where SharePlex is replicating to a Snowflake target.
Caution: The effects of snowflake_cleansp are not reversible.
Usage guidelines
What this utility does
snowflake_cleansp does the following on the target system:
- Truncates all the SharePlex Client internal tables in the SharePlex schema and any other SharePlex-installed tables as applicable.
- Removes the following from the variable-data directory: the queue files, the process log files, the statusdb file, the contents of the dump and state directories, and all but one entry in the event log (the status entry for snowflake_cleansp)
snowflake_cleansp preserves the following:
- The SharePlex database, account, and password, and only cleans the data in the SharePlex internal tables.
- User-created files such as the paramdb and the target configuration settings
To run the snowflake_cleansp utility on Snowflake target:
- Stop all SharePlex processes on the system.
- Shut down sp_cop.
-
Run the snowflake_cleansp utility from the bin sub-directory of the SharePlex product directory with the following syntax:
<installationDirectiory\ProductDirectory>/binsnowflake_cleansp [portnumber ] database_name/ schema name / user_name
where:
-
Enter the password at the prompt.
Enter the password for the SharePlex User :
Note: This option will not be displayed for the RSA based user.
-
Type Y to confirm that you want to run cleanup for this SharePlex instance.
Are you sure you want to perform the clean for '/splex/vardir/var2' and port 2200? [N] :Y
A successful setup terminates with a message similar to the following:
Clean port 5626
Cleaning /splex/aparopka/sf_datatypes/var subdirectories
DEMO_SCHEMA_20.SHAREPLEX_OPEN_TRANS table truncated.
License utilities
SharePlex License Utilities
Description
Use the SharePlex license utilities to view, add, and remove license keys to hosts in the SharePlex replication environment. Each installation of SharePlex requires a valid license key.
There are three types of SharePlex license keys for each supported platforms:
-
Trial license keys
- Perpetual License keys (Permanent)
- Term license keys
Following is the list of supported platforms for which licenses are available:
-
Oracle
-
File
-
JMS
-
Kafka
-
SQL Server
-
Postgres
-
MySQL
-
Snowflake
-
Event Hubs
-
All Platforms
SharePlex licensing information can be found in the Quest Software Product Guide. Please contact your account manager if you have questions.
If you do not have a valid license key, you may obtain one from Quest Technical Support or your Quest sales representative for the required platform from the above list of supported platforms. Use the appropriate procedure in this documentation to obtain the necessary information to support your license request.
NOTE: To install a trial version of SharePlex, users need to select the All Platforms option when prompted during installation of SharePlex or while running the splex_add_key utility.
License utilities on Unix and Linux
On Unix and Linux systems, separate utilities are used to:
Add a license key
Use the splex_add_key utility to add a license key to a machine during the installation of SharePlex or afterward to convert from one type of license to another.
You can use the splex_add_key utility as follows:
- You can use splex_add_key on the primary node of a cluster to install licenses for all secondary nodes in the cluster, because they all share one variable-data directory.
- You cannot use splex_add_key to add licenses for non-clustered machines from one machine. It must be run on each non-clustered replication system so that the license information is stored in the variable-data directory on each system.
To run splex_add_key:
- Log on to the system as the SharePlex Administrator.
- Run sp_ctrl on the machine where you want to install a license key.
-
If SharePlex is running, shut it down.
sp_ctrl> shutdown
-
Run splex_add_key from the install sub-directory of the SharePlex product directory.
$ /proddir/install/splex_add_key
-
Choose a platform to add/update license key:
SharePlex License Utility
1) Oracle
2) File
3) JMS
4) Kafka
5) SQL Server
6) Postgres
7) MySQL
8) Snowflake
9) Event Hubs
10) All Platforms
q) Quit License Utility
Enter option:
NOTE: To install a trial version of SharePlex, users need to select the All Platforms option.
-
Enter the appropriate number from the above list to choose the platform.
-
Enter the key manually as received from Quest. Press Enter when finished entering the key.
- Enter q to exit the utility.
- Start SharePlex when you are ready for replication to resume.
View a license key
Use the splex_get_key utility to view the SharePlex license key related details. Run this utility from the install sub-directory of the SharePlex product directory.
$ /proddir/install/splex_get_key
The information is similar to the following example:
$ /splex/proddir/install/splex_get_key
Platform = All
Product Name = SharePlex
Product Version = 11
License Number = 123-456-789
License Key Type = Trial
License Expiry = Midnight of Jan 01, 2050
License Key = lxxjLny9CqMCqdPZKZGRXIjnz7vpbTPQANliJi7PXJ7+Q8=
Remove a license key
Use the splex_remove_key utility to remove already installed SharePlex license key for a particular platform. If no license key is installed on the machine, it will display the "No license installed" message.
To run splex_remove_key:
- Log on to the system as the SharePlex Administrator.
-
Run splex_remove_key from the install sub-directory of the SharePlex product directory to remove a license key. Remove key will display a list of previously added licence keys.
$ /proddir/install/splex_remove_key
-
Choose the appropriate platform to remove a license key:
SharePlex License Utility
1) Oracle
2) Postgres
q) Quit License Utility
Enter option: 1
A successful removal of the license terminates with a message similar to the following:
The SharePlex for Oracle license has been successfully removed.
ots
Description
Use the OTS utility (ODBC Test Suite) to test the ability of SharePlex to connect to an Open Target target database through a selected ODBC driver, and then post test data to different column types.
Notes:
- The OTS utility uses a generic ODBC connection and data type handling method to provide a preliminary test of ODBC databases that are not yet SharePlex Certified (see How a database is considered for support by SharePlex ). The OTS utility is not needed for databases that are certified. For a list of certified databases, see the SharePlexRelease Notes.
- This utility should not be considered as definitive proof of the suitability of an ODBC datastore as a SharePlex target. Comprehensive testing of actual data in a replica of the proposed production environment must always be part of the certification process.
|
Supported databases
Open Target databases being considered for use with SharePlex.
Requirements
-
Install the ODBC driver that you want to test.
-
(Linux) Set the following environment variables:
- OTS creates a table to test INSERT, UPDATE, and DELETE operations. The table is created and owned by the user that connects to the database (see How to run OTS). This user must have sufficient permissions to create and own this table.
How to install a standalone OTS
OTS is available in the SharePlex build as well as a standalone version.
To install the standalone version:
Linux: Download the OTS package SPOodbc_test_suite-version-Beta-db_version-rh-40-amd64-m64.tpm. You are prompted for an installation directory.
How to run OTS
Perform the follwing steps to run OTS:
-
Run OTS. If you are running it from within an installation of SharePlex or the standalone OTS package on Linux, run it from the util subdirectory.
- Type one of the following:
OTS requires connection information for the tested database.
Enter data source name (DSN) or connection string: mydsn
How it works
The OTS utility performs the following tests:
- Connect to the Open Target target with a name and password or a connection string provided by the person that is running the utility.
- Query the target database for a list of supported operations and data types, including allowed storage values and whether a column is nullable.
- Issue a full set of SharePlex-supported DML and DDL operations for each data type.
- Summarize the results on screen (see How to interpret the OTS results).
-
Create a report, dump files, and logs to support debugging and support cases.
Note: The report file is only generated when OTS can connect to the database. If the connection fails, the file is empty.
How to interpret the OTS results
The OTS screen summary provides the following:
- A summary of the connection information that was used
- A summary list of data types that were tested
- Details of the test
The detail results are organized into tables, one per data type category, for example character data types or integer data types, as shown in the example.
Figure 1: Example detail table for character data types
Test: Character data types
--------------------------------------------------------------------------------
Name Size Nullable Insert Insert Update Delete Add Drop Trunc Pass/Fail
Null Col Col
--------------------------------------------------------------------------------
char 4096 Y P P P P P P P P
nchar 4096 Y P P P P P P P P
varchar 4096 Y P P P P P P P P
sysname 30 Y P P P P P P P P
nvarchar 4096 Y P P P P P P P P
The first three columns of each table (Name, Size, Nullable) are taken from a query to the ODBC driver. If the data type is allowed to contain NULL, the Nullable column shows a Y (yes). Otherwise, it shows an N (no).
Following the query columns are columns that represent the tests that were performed. There is a row for each data type that was tested.
The SharePlex-supported operations that OTS tests are as follows:
- INSERT with NULL value
- INSERT
- UPDATE
- DELETE
- ALTER TABLE to ADD COLUMN
- ALTER TABLE to DROP COLUMN
- TRUNCATE TABLE
The results also show the maximum and minimum (where applicable) storage values that were used for CHAR and VARCHAR data types in each test:
- For a data type that has only a maximum value (VARCHAR and CHAR) OTS will insert a data length that is greater than the maximum size to determine whether the ODBC database driver returns an error or automatically truncates the data with no error.
- For a data type that has both minimum and maximum values (numerical data types) a series of operation tests are run for each value. Numbers less than the minimum value and greater than the maximum value are tested to see if the ODBC database driver returns an overflow error or automatically rounds off and truncates the value.
For each test of a data type and operation, a P (pass) or F (fail) result is given, indicating whether or not SharePlex was able to perform that specific DML or DDL operation with that specific data type.
The final column, Pass/Fail, shows at a glance whether the test passed or failed as a whole for a specific data type. An F for any given operation type across the row triggers an F in the Pass/Fail column, meaning an overall failure of testing for that data type.
How to use the results
The OTS utility is an initial screening tool for Open Target databases that are not yet Quest SharePlex Certified. Its purpose is to determine whether the types of operations that you want to replicate to a given target, with a given set of metadata, are likely to succeed, without requiring the installation or setup of SharePlex itself. For example, you could assume that SharePlex probably can post to a target if the outcome of the test is the following:
- All of the DML tests except one passed, but the failed data type is not defined in your data.
- All of the DDL failed, but you do not need to replicate DDL.
The OTS utility is only a first step. It is not a substitute for testing a full installation of SharePlex with your actual data, using actual operations that your source Oracle applications generate, and posting those replicated operations to your actual target tables in a test environment. Additionally, a successful test with OTS does not necessarily mean the database will be fully supported by SharePlex. See How to run OTS
How a database is considered for support by SharePlex
To determine whether SharePlex will support a given Open Target database, the following are considered:
- Can SharePlex, through OTS, run a full set of transactions through a given ODBC driver for the database?
-
Does SharePlex Product Management approve the technical and market feasibility of supporting the database?
- Have the SharePlex QA labs verified in testing that SharePlex can support the database?
If the answer to questions 1 and 2 are yes, then the database is ODBC-approved. This means the database is then eligible for testing in the QA labs to answer question 3.
It is not realistic to test every possible edition, version, and platform of a given database. Based on market and technical factors, Product Management will determine which variants of a database will be tested. If those tests are successful, Product Management can then consider assigning the database a designation of SharePlex Certified.
