MySQL Setup (mysql_setup)
Database setup for MySQL
Overview
Run the Database Setup utility for MySQL (mysql_setup) on a MySQL system to establish SharePlex as a MySQL database user.
This utility creates the following:
- A SharePlex user account with full DBA privileges
- Tables and indexes for use by SharePlex and owned by the SharePlex user in a database of your choosing
- A default database connection.
Supported databases
MySQL on Linux. For supported Linux platforms and versions, see the SharePlex Release Notes.
Guidelines for use
- Run the setup utility on all MySQL instances in the SharePlex replication configuration.
- Within a cluster, run the setup utility on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
- For consolidated replication, run the setup utility for each variable-data directory.
Required privileges
Review the following requirements to ensure that the setup succeeds:
- The setup utility must be run as a MySQL Administrator that retains all of that user's default privileges. Both local and cloud MySQL Administrators should have the required privileges by default. The Administrator user is able to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account and objects.
- (Cloud installations) Common restrictions on privileges in cloud-hosted database services make it difficult for the setup utility to succeed in every possible type of scenario. To ensure that the database setup succeeds, only use the setup utility for the following purposes: To do a first-time database setup with a new SharePlex user, or, to modify an existing SharePlex user that either owns the database or has access to it.
Run database setup for MySQL
Perform the following steps to to run database setup for MySQL:
- Shut down any running SharePlex processes and sp_cop on the MySQL system.
-
Run the mysql_setup program from the bin subdirectory of the SharePlex product directory.
Important! If you installed the SharePlex instance on any port other than the default of 2100, use the -p option to specify the port number. For example, in the following command the port number is 9400.
C:\users\splex\bin> mysql_setup -p9400
Table 6: Setup prompts and responses
| Prompt | Response |
|---|---|
|
Enter the MySQL connection string [] : |
Enter a connection string that connects to the MySQL database. Do not use a DSN. If you are replicating data larger than 500 MB to MySQL Aurora on Amazon RDS, include the MySQL parameter max_allowed_packet in the connection string and set its value to the maximum size of the data. See the example. Example connection string DRIVER=/usr/lib64/libmyodbc5.so;socket=/var/lib/mysql/mysql.sock;character-set-server=utf8;collation-server=utf8_general_ci;max_allowed_packet=2G;wait_timeout= 6000;Server=servername.amazonaws.com |
|
Enter the MySQL Administrator name : |
Enter the name of the MySQL Administrator. This user will perform the setup work on the SharePlex account and schema. |
|
Enter the password for the Administrator account : |
Enter the password of the Administrator. |
|
Enter the replication target database name : |
Enter the name of the MySQL database where you want to install the SharePlex objects. |
|
Database name database does not exist. Would you like to create it? [y] : |
If this prompt is displayed, the specified database does not exist. Press Enter to have the setup utility create it for you. |
|
Would you like to create a new SharePlex user [y]: |
Press Enter to accept the default to create a new SharePlex database user account, or enter n to use an existing account as the SharePlex database user. |
|
Enter the name of the new SharePlex user: Enter the name of the existing SharePlex user: |
One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user.
|
|
Enter the password for the SharePlex user : |
Enter the password of the SharePlex user account. |
|
Re-enter the password for the SharePlex user : |
Enter the SharePlex password again. |
A successful setup terminates with a message similar to the following:
Completed SharePlex for MySQL database configuration
SharePlex User name: mysql29
Database name: mysql29
Target specification in SharePlex configuration: r.mysql29
Configure SharePlex to support MySQL database on Azure platform
You can configure SharePlex to support the MySQL database on the Azure platform using the below steps:
- Add the DSN entry along with Socket path (SOCKET=) in the Odbc.ini file at /etc/odbc.ini and the …/var/odbc directory.
- Copy the /etc/odbcinst.ini file to the …/var/odbc directory.
- Run the MySQL setup utility.
Table 7: Setup Prompts and Responses
| Prompt | Response |
|---|---|
|
Enter the MySQL DSN name or connection string [] : |
Enter the MySQL DSN name or a connection string that connects to the MySQL database system. Example: pslazpgdb02 |
|
Is DB hosted over Azure ? : |
Y |
|
Enter the Database hostname : |
Enter the Azure database host name. Note: MySQL Administrator name should be in the <username> format (Do not mention the hostname) Example: pslazpgdb02.mysql.database.azure.com If a user already exists for SharePlex then it should be entered in the <username@hostname> format. If a new user needs to be created for SharePlex then is should be entered in the <username> format. |
|
Enter the MySQL Administrator name : |
Enter the name of the MySQL Administrator. This user will perform the setup work on the SharePlex account and schema. Example: mysql |
|
Enter the password for the Administrator account: |
Enter the password of the Administrator. Note: User 'mysql@pslazpgdb02.mysql.database.azure.com' got the superuser role. |
|
Enter the replication target database name : |
Enter the target database name on which replication needs to be performed. Example: sp_mk |
|
Would you like to create a new SharePlex user? Enter the name of the existing SharePlex user: |
N (If you want to create a user, enter “y”)
Enter the name of the SharePlex user. |
|
Enter the password of the SharePlex user : |
Enter the password of the SharePlex user account. |
|
Re-enter the password for the SharePlex user : |
This prompt is only shown if you created a new user. Enter the SharePlex password again. |
A successful setup terminates with a message similar to the following:
Completed SharePlex for MySQL database configuration
SharePlex User name: mysql@pslazpgdb02.mysql.database.azure.com
Database name: sp_mk
The data source identifier in the SharePlex configuration is 'r.sp_mk' –
Oracle Setup (ora_setup)
Database setup for Oracle
Overview
Use the Database Setup utility for Oracle (ora_setup) to establish SharePlex as an Oracle user and create the required SharePlex database objects.
This setup utility creates the following:
- A SharePlex account
- Tables and other objects for use by SharePlex and owned by the SharePlex account
- Default connection for the SharePlex user
It is recommended that you review all of the content in this section before running this setup utility.
Supported databases
Oracle source or target on supported platforms
When to run Oracle setup
Whether or not to run this utility at the time of SharePlex installation depends on whether the database is a source, intermediary, or target database, and on how you intend to synchronize the data. To view the initial synchronization procedures, see the SharePlex Administration Guide.
| System Type | When to run Oracle Setup |
|---|---|
|
Source system |
During installation of SharePlex |
| Intermediary system | An intermediary system is used in a cascading configuration, where SharePlex replicates data to a remote system (or systems) and then sends that data from the intermediary system to the final target. If you intend to configure SharePlex to post data to a database on an intermediary system, and you intend to use a hot backup to establish the data on that system and the target, do not run the Database Setup utility on the intermediary or target systems. You will run it when you perform the initial synchronization procedure. |
|
Target system |
Depends on the method that you will use to synchronize the source and target data when you are ready to activate replication:
Note: If you run the Database Setup utility before the backup and recovery, the setup gets overwritten, and you will need to re-run it again after the backup and recovery. |
Supported Oracle connections
The setup utility can configure any of the following connections for the SharePlex user to use when connecting to the database.
| Database type | Connection |
|---|---|
| Database with or without ASM | Bequeath |
|
Database with or without ASM |
TNS alias |
| PDB with ASM |
TNS alias for the PDB and either TNS or bequeath for the ASM instance. |
|
Amazon RDS |
TNS alias |
Required run privileges
The user who runs the Database Setup utility must have the following privileges:
Amazon RDS source or target
The user who runs the setup utility must be the primary user that was created when the Oracle RDS instance was created. You are prompted for this user during the setup.
Non-multitenant (standard) database:
The user who runs the setup utility must have DBA privileges.
Multitenant database:
The user who runs the setup utility should have SYSDBA privileges (recommended), but at minimum the user should be a DBA user with privileges for sys.users$ and sys.enc$.
The minimum following grants are required for the SharePlex user:
create user c##sp_admin identified by sp_admin;
grant dba to c##sp_admin container=ALL;
grant select on sys.user$ to c##sp_admin with grant option container=ALL;
Privileges granted to SharePlex
|
Privilege granted |
Description |
|---|---|
|
DBA role |
The Database Setup utility grants DBA role and unlimited resource privileges, tablespace privileges, and read privileges to the redo logs. |
|
Default Oracle profile |
By default this profile has the unlimited resource privileges originally assigned by Oracle. |
|
Grants |
The following grants are issued to SharePlex:
|
Privileges required by SharePlex to perform replication
The following is a list of privileges required by SharePlex to perform replication. If you revoke the DBA role for the SharePlex database user, ensure these privileges are granted.
| Privilege | Details |
|---|---|
| CREATE SESSION | |
| ALTER SESSION | |
| ALTER SYSTEM | |
| RESOURCE role |
RESOURCE role privileges required by SharePlex:
|
| SELECT ANY DICTIONARY | |
| SELECT ANY TABLE | |
| INSERT ANY TABLE | |
| UPDATE ANY TABLE | |
| DELETE ANY TABLE | |
| UNLIMITED TABLESPACE | |
| CREATE ANY TABLE | |
| DROP ANY TABLE | |
| LOCK ANY TABLE | |
| EXECUTE ON DBMS_FLASHBACK | |
| SELECT ANY TRANSACTION | |
| CREATE ANY INDEX | |
| DROP ANY INDEX | |
| ALTER ANY TABLE | |
| ALTER ANY INDEX | |
| CREATE ANY VIEW | |
| ALTER ANY SEQUENCE | |
| EXP_FULL_DATABASE role | |
| IMP_FULL_DATABASE role | |
| SELECT ON SYS.ENC$ | |
| SELECT ON SYS.USER$ |
Requirements
- Install the database client on the system where you are running Oracle Setup. Consult the Oracle documentation for the appropriate client version to use with the database.
- Run the Database Setup utility for all source and target Oracle instances in the SharePlex replication configuration.
- For a consolidated replication topography, or other topology with multiple variable-data directories, run the Database Setup utility for each variable-data directory.
-
SharePlex supports local BEQUEATH connections or remote connections using a TNS alias. Be prepared to supply Oracle Setup the needed connection values for whichever connection you want to use. If using TNS, the tnsnames.ora file must be configured prior to running setup.
- If the Oracle database is a multitenant container database, run the Database Setup utility for each pluggable database involved in a replication scenario. A SharePlex user and schema objects must exist in each PDB.
- If you run the Database Setup utility when there is an active configuration, the DDL that the setup performs to install or update the SharePlex internal tables will be replicated to the target. To work around this issue, set the SP_OCT_REPLICATE_ALL_DDL parameter to 0 before running the utility, then return the parameter to its previous setting after the setup is complete. This parameter takes effect immediately.
SharePlex schema storage requirements
The Database Setup utility for Oracle installs some database objects for use by SharePlex. The storage requirements for these objects should be satisfied before running Oracle Setup. See the following table.
| Storage | Description |
|---|---|
| SharePlex objects tablespace |
The Database Setup utility installs some tables into a tablespace of your choosing. All but the SHAREPLEX_LOBMAP table use the default storage settings of the tablespace. The SHAREPLEX_LOBMAP table contains entries for LOBs stored out-of-row. It is created with a 1 MB INITIAL extent, 1 MB NEXT extent, and PCTINCREASE of 10. The MAXEXTENTS is 120, allowing the table to grow to 120 MB. Preferred action: If you enable supplemental logging for primary and unique keys, you can set the SP_OCT_ENABLE_LOBMAP parameter to 0, and nothing will be stored in the SHAREPLEX_LOBMAP table. In this case, you do not have to consider its size growth. It is recommended that you enable supplemental logging for primary and unique keys to maximize the performance of the Read process. Alternate action: The default storage usually is sufficient for SHAREPLEX_LOBMAP, permitting more than 4 million LOB entries. If the Oracle tables to be replicated have numerous LOB columns that are inserted or updated frequently, consider increasing the size the SharePlex tablespace accordingly. Take into account that this table shares the tablespace with other SharePlex tables. If the database uses the cost-based optimizer (CBO) and the tables that SharePlex processes include numerous LOBs, incorporate the SHAREPLEX_LOBMAP table into the analysis schedule. Note: A new installation of SharePlex does not change storage parameters from a previous installation. |
| SharePlex temporary tablespace |
The Database Setup utility prompts for a temporary tablespace for SharePlex to use for sorts and other operations, including sorts performed by the compare commands. The default temporary tablespace is the one where the SharePlex objects are installed. If you plan to use the compare commands to compare large tables, especially those without a primary or unique key, specify a dedicated temporary tablespace for SharePlex. |
| SharePlex index tablespace |
The Database Setup utility prompts for a tablespace to store the indexes for the SharePlex tables. The default index tablespace is the one where the SharePlex objects are installed. To minimize I/O contention, specify a different index tablespace from the one where the tables are installed. Note: If indexes from a previous version of SharePlex are installed in the SharePlex objects tablespace, you can move them to a different tablespace and then specify that tablespace when you run the setup utility. |
Run database setup for Oracle
Important! The Oracle instance must be open before this procedure is performed.
Perform the following steps to run database setup for Oracle:
-
(Unix and Linux only) If you are using multiple variable-data directories, export the environment variable that points to the variable-data directory for the SharePlex instance for which you are running Database Setup.
ksh shell:
export SP_SYS_VARDIR=/full_path_of_variable-data_directory
csh shell:
setenv SP_SYS_VARDIR=/full_path_of_variable-data_directory
- Shut down any SharePlex processes that are running, including sp_cop.
-
Run the Database Setup program from the command prompt of the operating system, using the full path from the SharePlex bin subdirectory.
-
Specify whether the system is a source system, a target system, or both a source and target system in the SharePlex configuration.
Note: This prompt only appears the first time that you run setup for this database.
- For connection type, select Oracle.
- Refer to the following table for the prompts and responses to configure SharePlex correctly for the desired connection type.
Table 8: Setup prompts and response
| Prompt | Response | |
|---|---|---|
| Will SharePlex install be using a BEQUEATH connection? (Entering 'n' implies a SQL*net connection): |
Press Y to use a local BEQUEATH connection, or press N to use a TNS alias connection.
| |
|
Are you configuring SharePlex for an AWS RDS database? |
Press N if you are not configuring SharePlex for an Oracle database on RDS. Press Y if you are configuring SharePlex for an Amazon AWS RDS database.
| |
|
One of the following prompts is shown:
|
Non-multitenant database: Accept the default or type the correct SID or TNS alias. On RAC, the TNS alias must be a global alias. Multitenant database: Type the TNS alias of the PDB. Amazon RDS: Type the TNS alias of the RDS database.
| |
|
One of the following prompts is shown:
|
Non-multitenant database: Type the name of a database user that has DBA privileges. Multitenant database: Type the name of a common user who has the required privileges to install the account and objects. Amazon RDS database: Type the name of the RDS primary user.
| |
|
One of the following prompts is shown:
|
Non-multitenant database: Type the password of the DBA user. Multitenant database: Type the password of the common user. Omit the @ and the rest of the connect string. SharePlex constructs the connect string in the proper format. Amazon RDS database: Type the password of the RDS primary user.
| |
|
Current SharePlex user is user. Would you like to create a new SharePlex user? |
Press N to update an existing SharePlex account or Y to create a new SharePlex account. Type the credentials when prompted. You are allowed five attempts to type a valid password for an existing SharePlex user. Passwords are obfuscated. Important! If there is an active configuration and you changed the schema, copy the objects from the old schema to the new one to preserve the replication environment. | |
|
Do you want to enable replication of tables with TDE? |
Press N since TDE is not supported for RDS. Press Y to capture data encrypted by the Oracle TDE wallet. | |
| Are the TDE keys stored in the Oracle wallet? |
Press Y if you have a valid Oracle path. Press N if the Oracle wallet key is stored on external storage that is HSM. Enter the fully qualified pathname of the HSM PKCS11 library, including the library name: [] | |
| Enter the default tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. | |
| Enter the temporary tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. | |
| Enter the index tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. | |
| Will the current setup for sid: SID be used as a source (including cases as source for failover or primary-primary setups)? |
Press Y if this is a source system or press N if this is a target system. Important: All systems in a primary-primary configuration (peer-to-peer) and in a high-availability configuration are considered to be source systems due to the bidirectional nature of the replication.
| |
| ||
|
ASM detected. Do you wish to connect to ASM using BEQUEATH connection?
|
Press Y for SharePlex to use a BEQUEATH connection to connect to the ASM instance, or press N to use a TNS alias. Important! If the database uses ASM and the database TNS alias is configured with a SCAN IP, then you must specify connection through an ASM TNS alias in order for SharePlex to connect to the ASM instance. | |
|
The following prompt is displayed if you did not select a BEQUEATH connection: Do you wish to keep connecting using the same user/password?
|
Press Y to use the same user and password as the login user, or press N to be prompted for a different user and password. Normally the user running SharePlex must be a member of the OSASM group. This does not apply if SP_OCT_OLOG_USE_OCI is set to the non-default value of 1. Also if you are using a BEQUEATH connection, the user running SharePlex must be a member of the OSDBA group. | |
|
Note: If you selected to use a BEQUEATH connection to connect to ASM, the database setup is complete. Continue to Database setup for Oracle. If you selected N, you need to supply a TNS alias, and the prompts continue. | ||
|
Enter the ASM tns alias to be used by SharePlex: |
Type the name of the TNS alias. | |
|
Enter an ASM admin (has both sysdba and sysasm privilege) username for alias: |
Type the name of a user with sysasm and sysdba privileges to the ASM instance. | |
|
Enter user password for user: |
Type the password of the user. | |
|
SharePlex installs internal objects that include a package to support the SDO_GEOMETRY data type of the Oracle Spatial and Graph option. If this option is not installed in the database, the following prompt is shown: The SharePlex object that supports replication of SDO_GEOMETRY cannot be installed because the Oracle Spatial and Graph feature is not installed. Do you want to continue with the setup without support for SDO_GEOMETRY? [n]: |
Press Y to continue the database setup without support for SDO_GEOMETRY, or press N to terminate ora_setup. | |
- After completion of the Oracle setup, the ora_setup.config file will be generated inside <Installation_directory>/var/data.
Note about the tnsnames file
When you set up SharePlex for database connection through a TNS alias and ASM connection locally through a BEQUEATH connection (through OS authentication), it is important to set up the tnsnames.ora file correctly on each node. Assuming a SharePlex database account exists on the primary node, SharePlex will always connect to the primary ASM_SID automatically because it was provided when SharePlex was installed. However, upon failover, SharePlex must query the local v$asm_client view to get the correct ASM_SID of the failover instance. Therefore, ensure that the IP address of a given node is always listed first in the local tnsnames.ora file on that node. |
Run database setup for Oracle remote capture
Important! The Oracle instance must be open before this procedure is performed.
Perform the following steps to run database setup for Oracle remote capture:
- (Unix and Linux only) If you are using multiple variable-data directories, export the environment variable that points to the variable-data directory for the SharePlex instance for which you are running Database Setup.
ksh shell:
export SP_SYS_VARDIR=/full_path_of_variable-data_directory
csh shell:
setenv SP_SYS_VARDIR=/full_path_of_variable-data_directory
- Set the SP_OCT_OLOG_USE_OCI parameter to 1 and restart the Capture process.
- Shut down any SharePlex processes that are running, including sp_cop.
-
Run the Database Setup program from the command prompt of the operating system, using the full path from the SharePlex bin subdirectory.
-
Specify whether the system is a source system, a target system, or both a source and target system in the SharePlex configuration.
Note: This prompt only appears the first time that you run setup for this database.
- For connection type, select Oracle.
- Refer to the following table for the prompts and responses to configure SharePlex correctly for the desired connection type.
Table 9: Setup prompts and response
| Prompt | Response |
|---|---|
| Will SharePlex install be using a BEQUEATH connection? (Entering 'n' implies a SQL*net connection): |
Press N to use a TNS alias connection. |
|
Are you configuring SharePlex for an AWS RDS database? |
Press N if you are not configuring SharePlex for an Oracle database on RDS. |
|
One of the following prompts is shown:
|
Non-multitenant database: Accept the default or type the correct SID or TNS alias. On RAC, the TNS alias must be a global alias. Multitenant database: Type the TNS alias of the PDB. Amazon RDS: Type the TNS alias of the RDS database. |
|
One of the following prompts is shown:
|
Non-multitenant database: Type the name of a database user that has DBA privileges. Multitenant database: Type the name of a common user who has the required privileges to install the account and objects. Amazon RDS database: Type the name of the RDS primary user.
|
|
One of the following prompts is shown:
|
Non-multitenant database: Type the password of the DBA user. Multitenant database: Type the password of the common user. Omit the @ and the rest of the connect string. SharePlex constructs the connect string in the proper format. Amazon RDS database: Type the password of the RDS primary user.
|
|
Enter the Local Oracle Client Library directory: |
Enter the Oracle Client Home directory path. Example: /u01/app/oracle/product/19.0.0/clienthome_1 |
| Enter the TNS alias for which SharePlex should be installed (Blank to abort) : | Enter the name of the TNS alias |
|
Current SharePlex user is user. Would you like to create a new SharePlex user? |
Press N to update an existing SharePlex account or Y to create a new SharePlex account. Type the credentials when prompted. You are allowed five attempts to type a valid password for an existing SharePlex user. Passwords are obfuscated. Important! If there is an active configuration and you changed the SharePlex schema, copy the SharePlex objects from the old schema to the new one to preserve the replication environment. |
|
Do you want to enable replication of tables with TDE? |
Press N since TDE is not supported for RDS. |
| Enter the default tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. |
| Enter the temporary tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. |
| Enter the index tablespace for use by SharePlex: |
Press Enter to accept the default or type the name of a different tablespace. |
| Will the current setup for sid: SID be used as a source (including cases as source for failover or primary-primary setups)?
|
Press Y if this is a source system or press N if this is a target system. Important: All systems in a primary-primary configuration (peer-to-peer) and in a high-availability configuration are considered to be source systems due to the bidirectional nature of the replication. |
|
The following prompt is displayed if you did not select a BEQUEATH connection: Do you wish to keep connecting using the same user/password?
|
Press Y to use the same user and password as the login user, or press N to be prompted for a different user and password. Normally the user running SharePlex must be a member of the OSASM group. This does not apply if SP_OCT_OLOG_USE_OCI is set to the non-default value of 1. Also if you are using a BEQUEATH connection, the user running SharePlex must be a member of the OSDBA group. |
|
SharePlex installs internal objects that include a package to support the SDO_GEOMETRY data type of the Oracle Spatial and Graph option. If this option is not installed in the database, the following prompt is shown: The SharePlex object that supports replication of SDO_GEOMETRY cannot be installed because the Oracle Spatial and Graph feature is not installed. Do you want to continue with the setup without support for SDO_GEOMETRY? [n]: |
Press Y to continue the database setup without support for SDO_GEOMETRY, or press N to terminate ora_setup. |
Note: While running the ora_cleansp utility, enter the TNS alias provided while performing ora_setup.
Run database setup for Oracle in silent mode
Important! The Oracle instance must be open before this procedure is performed.
Perform the following steps to run database setup for Oracle in silent mode:
-
(Linux only) If you are using multiple variable-data directories, export the environment variable that points to the variable-data directory for the SharePlex instance for which you are running Database Setup.
ksh shell:
export SP_SYS_VARDIR=/full_path_of_variable-data_directory
csh shell:
setenv SP_SYS_VARDIR=/full_path_of_variable-data_directory
- Shut down any SharePlex processes that are running, including sp_cop.
- Use the following command to run Ora_setup in the background in silent mode:-
nohup ./ora_setup -f <Full_file_path of ora_setup.config> > SilentOra.out 2>&1 - For more details on how to configure the
Ora_setup.configfile, refer to theora_setup.configfile at the below location:/<product directory>/install/ora_setup.config
Note: After the setup is completed successfully, all of the password fields will be automatically removed from the config file for security reasons.
SQL Server Setup (mss_setup)
Database setup for SQL Server
Overview
Run the Database Setup utility for SQL Server (mss_setup) on a Microsoft SQL Server system to establish SharePlex as a SQL Server database user.
This utility creates the following:
- A SharePlex user account with
- Tables and indexes for use by SharePlex and owned by the SharePlex user in a database of your choosing
- A default database connection.
Supported databases
For supported SQL Server platforms and versions, see the SharePlex Release Notes.
Guidelines for use
- A system DSN (data source name) must exist for the SQL Server database. SharePlex Post uses the DSN to connect to the database through ODBC.
- Run the Database Setup utility on all SQL Server instances in the SharePlex replication configuration.
- Within a cluster, run the Database Setup utility on the node to which the shared disk that contains the variable-data directory is mounted.
- For consolidated replication, run the Database Setup utility for each variable-data directory.
Required privileges
Review the following requirements to ensure that the setup succeeds.
-
The Database Setup utility must be run as a SQL Server System Administrator in order to grant SharePlex the required privileges to operate on the database and to create the SharePlex database account and objects.
-
The sysadmin role is required to run mss_setup, but it is not required by the SharePlex database account used to run SharePlex replication (the SharePlex User). The db_owner role is required by the SharePlex User account and it is granted by mss_setup (for source and target).
- (Cloud installations) Common restrictions on privileges in cloud-hosted database services make it difficult for the setup utility to succeed in every possible type of scenario. To ensure that the database setup succeeds, only use the setup utility for the following purposes: To do a first-time database setup with a new SharePlex user, or, to modify an existing SharePlex user that either owns the database or has access to it. (Cloud installation is not supported while replicating data from PostgreSQL to SQL Server)
Run database setup for SQL server
Perform the following steps to run database setup for SQL server:
- Shut down any running SharePlex processes and sp_cop on the SQL Server system.
-
Run the mss_setup program from the bin subdirectory of the SharePlex product directory.
Important! If you installed the SharePlex instance on any port other than the default of 2100, use the -p option to specify the port number. For example, in the following command the port number is 9400. C:\users\splex\bin>mss_setup-p9400
Table 10: Setup prompts and responses
| Prompt | Response |
|---|---|
|
Enter the Microsoft SQL Server DSN name [] : |
Enter the data source name (DSN) that connects to SQL Server. Make certain the DSN is a system DSN, not a user DSN. |
|
Enter the Microsoft SQL Server Administrator name : |
Enter the name of the SQL Server Administrator. This user will perform the setup work on the SharePlex account and schema. |
|
Enter the password for the Administrator account : |
Enter the password of the Administrator. |
|
Enter the database name: |
Enter the name of the database where you want to install the SharePlex objects. |
|
Database name database does not exist. Would you like to create it? [y] : |
If this prompt is displayed, the specified database does not exist. Press Enter to have the setup utility create it for you. |
|
Would you like to create a new SharePlex login [y]: |
Press Enter to accept the default to create a new SharePlex database user account, or enter n to use an existing account as the SharePlex database user. |
|
Enter the name of the existing SharePlex login: Enter the name of the new SharePlex login: |
One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user.
|
|
Enter the password for login: |
Enter the password of the SharePlex user account. |
|
Re-enter the password for login : |
Enter the SharePlex password again. |
|
Will this database be used as a source? |
Accept the default of n if the database will only be a target. Enter y if this database will be a source database for SharePlex. A response of y prompts the setup to prepare the database for data capture and installs the SharePlex account and objects. |
A successful setup terminates with a message similar to the following:
Completed SharePlex for Microsoft SQL Server database configuration
SharePlex User name: splex
Database name: db1
Target specification in SharePlex configuration: r.db1
Configure remote posting from a Linux to a SQL Server database
To replicate data from a Linux server to a SQL server database, follow the steps below:
-
Install the latest SQL Server ODBC drivers on Linux.
By default, the ODBC drivers will be installed at /opt/microsoft/msodbcsql18/lib64. -
Modify the odbcinst.ini and odbc.ini files in the <var_dir>/odbc directory.
-
Run the mss_setup program from the bin subdirectory of the SharePlex product directory.
-
Provide other details when it prompts you, like the database name, username, password, etc. For more information, see Run Database Setup for SQL Server.
A successful setup terminates with a message similar to the following:
Completed SharePlex for Microsoft SQL Server database configuration
SharePlex User name: splex
Database name: db1
Target specification in SharePlex configuration: r.db1
Database setup for Snowflake
Snowflake configuration prerequisites:
-
If any user has used Snowflake setup utility of a version prior to 11.4, they should first perform the following cleanup steps:
-
Drop the role 'SHAREPLEX_ROLE' from the Snowflake account using the owner role. For example, if 'SHAREPLEX_ROLE' was created with a user having the 'ACCOUNTADMIN' role, execute the following query using the same privileges:
drop role "SHAREPLEX_ROLE";
-
Drop the table 'SHAREPLEX_OPEN_TRANS' from the target DB.SCHEMA. Refer to the query below:
drop table SHAREPLEX_OPEN_TRANS;
Re-run the Snowflake setup utility now, following the guidelines below. 'SHAREPLEX_ROLE' will be re-created correctly by the setup using the 'USERADMIN' role."
-
-
Configure DSN in the ODBC directory as per your requirement (for password based authentication or for RSA based authentication).
-
Enter the warehouse name that SharePlex is using in the odbc.ini file. For more information, see Guidelines for use section.
-
SharePlex setup requires one Admin user to operate, below is the query is reference. Create an Admin user as shown in the following query::
create user <user_name> identified by '<user_password>'; -
Grant the SYSADMIN and USERADMIN roles to the Admin user using the following queries:
grant role SYSADMIN to user <user_name>;
grant role USERADMIN to user <user_name>; -
Snowflake_setup internally uses the USERADMIN role to create a new SharePlex role to be used in replication and user-related tasks. The SYSADMIN role is used to grant access to databases and warehouses.
-
If the SYSADMIN role does not have access to the intended database and warehouse, provide access using the following queries:
grant OWNERSHIP on database <database name> to SYSADMIN with grant option;
grant USAGE on warehouse <warehouse_name> to role SYSADMIN with grant option;
grant OPERATE on warehouse <warehouse_name> to role SYSADMIN with grant option;
-
The required privileges will be granted to the SharePlex role (SHAREPLEX_ROLE), which will then be assigned to the SharePlex user provided as input.
Overview
Use the Database Setup utility for Snowflake (snowflake _setup) to establish SharePlex as a Snowflake user and create the required SharePlex database objects.
This setup utility:
-
Create a new role SHAREPLEX_ROLE if it does not exist.
-
Creates a new user or uses an existing user
-
Creates SharePlex internal tables and objects
It is recommended that you review all of the content in this topic before running the setup utility.
Guidelines for use
-
Run the Snowflake_Setup utility on the target Snowflake instance in the SharePlex replication configuration.
-
Within a server cluster, run the Snowflake Setup utility on the node to which the shared disk that contains the SharePlex variable-data directory is mounted.
-
For consolidated replication, run the Snowflake Setup utility for each variable-data directory.
-
Provide a DSN (Data Source Name) as mentioned below:
-
If you have a DSN defined, and you want to use it for the SharePlex connection, copy or link the ODBC files in which that DSN is defined (odbc.ini and odbcinst.ini) to the odbc subdirectory of the SharePlex variable-data directory. This prevents connection errors when the SharePlex processes connect to the database.
-
If you do not have a DSN defined but want to use one, you can create it in the template files provided in the odbc subdirectory.
-
For an example of the sample odbc.ini and odbcinst.ini files, see the example below.
Sample of an ODBC file in a password based authentication:
Sample of an ODBC file for in an RSA based authentication:
Privileges granted to SharePlex
The database setup utility creates the SHAREPLEX_ROLE and assigns it to SharePlex users. SharePlex assigns the following privileges to the SharePlex_role:
|
Privilege types |
Privileges |
|---|---|
|
Database privileges |
|
| Schema | ALL PRIVILEGES |
| Warehouse | Usage |
Run database setup for Snowflake
Important! The Snowflake instance must be open before this procedure is performed.
Perform the following steps to run database setup for Snowflake:
-
(Linux only) If you are using multiple variable-data directories, export the environment variable that points to the variable-data directory for the SharePlex instance for which you are running Database Setup.
ksh shell:
export SP_SYS_VARDIR=/full_path_of_variable-data_directory
csh shell:
setenv SP_SYS_VARDIR=/full_path_of_variable-data_directory
- Shut down any SharePlex processes that are running, including sp_cop.
-
Run the Snowflake database Setup command (./snowflake_setup ) using password or RSA based admin user.
- Refer to the following table for the prompts and responses to configure SharePlex correctly for the desired connection type.
Table 11: Setup prompts and response for password based authentication
| Prompt | Response |
|---|---|
| Enter the snowflake DSN name [ ] : |
Enter a DSN name. Example: sp_snowflake_5 |
| Is authentication based on RSA public key? [n] : | For password based authentication, enter "n" |
| Enter the Snowflake administrator name : | Enter an administrator name. |
| Enter the password for the administrator account: | Enter the administrator account password. |
| Enter the replication target database name : |
Enter the name of the Snowflake database where you want to install the SharePlex objects. Example: shareplex_test |
| Database name database does not exist. Would you like to create it? [y] : | If this prompt is displayed, the specified database does not exist. Press Enter to have the setup utility create it for you. |
| Enter the DB schema name: |
Enter the DB schema name. Example: shareplex_test_5 |
| DB schema name does not exist. Would you like to create it? [y] : | If this prompt is displayed, the specified DB schema name does not exist. Press Enter to have the setup utility create it for you. |
| Would you like to create a new SharePlex user? [y/n] : | Press Enter to accept the default to create a new SharePlex database user account in the specified database, or enter n to use an existing SharePlex account. |
|
Enter the name of the new SharePlex user: Enter the name of the existing SharePlex user: |
One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user. |
| Enter the password for the new SharePlex user: | Enter a password for the new SharePlex user. |
| Re-enter the password for the new SharePlex user: | This prompt is only shown if you created a new user. Enter the SharePlex password again. |
A successful setup terminates with a message similar to the following:
Completed SharePlex for Snowflake database configuration
SharePlex user name: amore2
Database name: SHAREPLEX_TEST
- - The datasource identifier in the SharePlex configuration is 'r.SHAREPLEX_TEST' - -
Table 12: Setup prompts and response for RSA based authentication
| Prompt | Response |
|---|---|
| Enter the snowflake DSN name [ ] : |
Enter a DSN name. Example: sp_snowflake_5 |
| Is authentication based on RSA public key? [y] : |
For password based authentication, enter "y". Note: Make sure that the RSA key has been configured for Admin user. |
| Enter the snowflake administrator name : | Enter an administrator name. |
| Enter the replication target database name : |
Enter the name of the Snowflake database where you want to install the SharePlex objects. Example: shareplex_test |
| Database name database does not exist. Would you like to create it? [y] : | If this prompt is displayed, the specified database does not exist. Press Enter to have the setup utility create it for you. |
| Enter the DB schema name: |
Enter the DB schema name. Example: shareplex_test_5 |
| DB schema name does not exist. Would you like to create it? [y] : | If this prompt is displayed, the specified database schema does not exist. Press Enter to have the setup utility create it for you. |
| Would you like to create a new SharePlex user? [y/n] : | Press Enter to accept the default to create a new RSA user account in the specified database, or enter n to use an existing SharePlex account. |
|
Enter the name of the new SharePlex user: Enter the name of the existing SharePlex user: |
One of these prompts is displayed depending on whether you elected to create a new user or use an existing user. Enter the name of the SharePlex user. |
| Enter path for RSA public key for configuration of New User. |
Enter the path for the RSA public key. (This field is applicable only for a new user) Note: For existing user account, make sure that the RSA key has been configured for Admin user. |
A successful setup terminates with a message similar to the following:
Completed SharePlex for Snowflake database configuration
SharePlex user name: amore2
Database name: PROVIDENCE
- - The datasource identifier in the SharePlex configuration is 'r.SHAREPLEX_TEST' - -