Quick Start for HVR - Oracle
Last updated on Apr 02, 2021
Contents |
---|
This quick start guide helps you to get started with HVR for replicating data between Oracle databases.
To proceed with this replication you must have basic understanding about HVR's architecture and terminologies like Hub, Location, Channel, Location Groups, Actions etc.
The example here demonstrates how to replicate tables from one Oracle schema (source location) to another Oracle schema (target location).
In real-life scenarios, the source location(s) and the target location(s) reside on different machines and the HVR hub can reside on source or target or a separate machine. However, in this example, for simplicity we have the source, target, and HVR hub on the same machine i.e., a single Oracle instance with three schemas.
Before proceeding with this example ensure that the requirements for using HVR with Oracle are met.
For information about access privileges and advanced configuration changes required for performing replication using Oracle, see Requirements for Oracle.
Create Demo Schemas and Tables
The initial step of this demonstration is to create:
- a schema in the source location
- tables in the source schema (and insert values into these tables)
- a schema in the target location
Source Location
Skip this section if you already have a database with tables which you plan to use for this replication.
For this demonstration, in the source location, create a schema (e.g. sourcedb) with two tables (e.g. dm51_product and dm51_order), and insert values into these tables.
Target Location
Create a schema (e.g. targetdb) in the target location.
default tablespace users
temporary tablespace temp
quota unlimited on users;
Create Hub Database
HVR supports the creation of a hub database on certain databases (location classes) only. For the list of supported location classes, see section Hub Database in Capabilities.
For this demonstration, the hub database (e.g. hvrhub) is created in Oracle.
Create the hub database (hvrhub) with password (hvr).
create user hvrhub
identified by hvr
default tablespace users
temporary tablespace temp
quota unlimited on users;
Grants/Access Privileges
This section describes the grants/access privileges required for the source schema, target schema, and hub database.
Configure the privileges for source schema (sourcedb). For more information, see section Grants for Log-Based Capture in Requirements for Oracle.
grant create session to sourcedb;
grant create table to sourcedb;
grant alter any table to sourcedb;
grant select any dictionary to sourcedb;
grant select any transaction to sourcedb;Configure the privileges for target schema (targetdb). For more information, see section Grants for Integrate and Refresh in Requirements for Oracle.
grant create session to targetdb;
grant create table to targetdb;Configure the privileges for hub schema (hvrhub). For more information, see section Grants for Hub Schema in Requirements for Oracle.
grant create session to hvrhub;
grant create table to hvrhub;
grant create procedure to hvrhub;
grant create trigger to hvrhub;
grant execute on dbms_alert to hvrhub;A user with dba privileges should grant execute on dbms_alert to the hub database user (e.g. hvruser).
Download and Install HVR
Install HVR on a hub machine. For details on installing HVR, see the respective operating system sections:
The HVR distribution requires a license key in order for the software to operate. Please see the HVR licensing page for more details on how to install the HVR license.
After the installation, you can control HVR using the HVR graphical user interface (HVR GUI).
- If the hub machine is Windows, then HVR GUI can be executed directly on the hub machine.
- To control HVR remotely from your PC, connect to the hub machine using Windows Remote Desktop Connection and launch HVR GUI on the hub machine.
- If the hub machine is Linux, then HVR GUI can be executed directly on the hub machine. However, an application like X Server or VNC viewer must be installed to run HVR GUI directly on Linux.
- To control HVR remotely from your PC, install HVR on the PC (with Windows or macOS) and configure the HVR Remote Listener on the hub machine.
- If the hub machine is Unix, then HVR GUI should typically be run remotely from a PC to control HVR installed on the hub machine. To do this, install HVR on the PC (with Windows or macOS) and configure the HVR Remote Listener on the hub machine.
The HVR Remote Listener allows you to connect HVR GUI available on your PC to the remote HVR hub machine. For more information about connecting to remote HVR installation, see Configuring Remote Installation of HVR on Unix or Linux and Configuring Remote Installation of HVR on Windows.
Launch HVR GUI
- On Windows and macOS, double-click the HVR shortcut icon available on the desktop or execute command hvrgui in the CLI.
On Linux, double-click the hvrgui file available in the HVR_extracted_path/bin directory or execute command hvrgui in the CLI.
Linux requires applications like X server or VNC viewer to execute HVR GUI.
On Unix, HVR GUI is not supported. So, HVR GUI should be run on a remote PC (with Windows, Linux, or macOS) to control HVR installed on the Unix machine.
Register Hub
When you launch HVR GUI for the first time, the Register Hub dialog is displayed automatically. The Register Hub dialog can also be accessed from menu File by selecting Register Hub. Skip steps 1 to 4 if you want to run HVR GUI directly on the hub machine.
Click Connect to HVR on remote machine.
To connect HVR GUI on a PC to a remote HVR hub machine, the HVR Remote Listener must be configured and running on the HVR hub machine.
- Enter the name or IP address of the hub machine in the Node field (e.g. myserver).
- Enter the port number (defined in the HVR Remote Listener of the hub machine) in the Port field (e.g. 4343).
- Enter the Login (e.g. myserveradmin) and Password for the hub machine. By default, this is the operating system login credentials of the hub machine.
- Select Oracle in the Class pane.
- Specify Database Connection details.
- Enter the directory path in ORACLE_HOME. You can also click the browse button to select the directory path.
- Enter the Oracle System ID in ORACLE_SID or TNS credentials.
- Enter the user name of the hub database in User (e.g. hvrhub).
- Enter the password for the hub database in Password (e.g. hvr).
- Click Connect.
Click Yes in the prompt dialog asking to create catalog tables in the hub database.
HVR displays this prompt when connecting to a hub database for the first time.
On connecting successfully to the hub database, the navigation tree pane displays the hub machine and the hub database. Location Configuration, Channel Definitions, and Scheduler are displayed under the hub database.
Create Locations
This section describes how to create locations in HVR GUI. Location is a storage place (for example, database or file storage) from where HVR captures (source location) or integrates (target location) changes.
Create one source location (src) connected to source schema (sourcedb) and one target location (tgt) connected to target schema (targetdb).
- In navigation tree pane, right-click Location Configuration ▶ New Location.
- Enter Location name and Description for the location.
- Select Oracle in Class.
- Provide Database Connection details. For more information on Database Connection fields, see section Location Connection.
- Enter directory path for ORACLE_HOME. You can also click browse to select directory path.
Enter Oracle System ID in ORACLE_SID or TNS credential or RAC credential.
For RAC connectivity, ensure to provide remote machine connection details under Connection tab.
- Enter user name of schema in User. For example, sourcedb.
- Enter password for schema in Password. For example, hvr.
- Click Test Connection to verify the connection to location database.
- Click OK.
Create Channel
- In the navigation tree pane, right-click Channel Definitions ▶ New Channel.
- In the New Channel dialog, enter Channel name and Description for the channel.
- Click OK.
Create Location Groups
This section describes how to create location groups in a channel. The location groups are used for defining action on the location. Typically a channel contains two location groups - one for the source location and one for the target location. Each location group can contain multiple locations.
In this example, create one source location group (SRCGRP) and one target location group (TGTGRP).
- In navigation tree pane, click + next to the channel (hvrdemo).
- Create source location group (SRCGRP):
- Right-click Location Groups ▶ New Group.
- Enter Group Name and Description for the location group.
- Select source location (src) from Group Membership.
- Click OK.
- Create target location group (TGTGRP):
- Right-click Location Groups ▶ New Group.
- Enter Group Name and Description for the location group.
- Select target location (tgt) from Group Membership.
- Click OK.
Select Table(s)
This section describes how to select the tables (dm51_product and dm51_order) from source location for replication. Table Explore allows you to select schema(s) and/or table(s) for replication.
- Right-click Tables ▶ Table Explore.
- Select source location (src) from the list.
- Click Connect.
- Select tables from Table Explore dialog. Press Shift key to select multiple tables or Ctrl+A to select all tables.
- Click Add to add the selected tables.
- Click OK in HVR Table Name dialog.
- Click Close in Table Explore dialog.
Define Actions
This section describes how to define Actions on the location groups (SRCGRP and TGTGRP). Actions define the behavior of a replication activity.
- Define action Capture to capture changes from all tables in the source location group.
- Right-click source location group SRCGRP ▶ New Action ▶ Capture.
- Click OK.
- Right-click source location group SRCGRP ▶ New Action ▶ Capture.
- Define action Integrate.
- Right-click target location group TGTGRP ▶ New Action ▶ Integrate.
Click OK.
- Right-click target location group TGTGRP ▶ New Action ▶ Integrate.
The Actions pane only displays actions related to the object selected in the navigation tree pane. Click on the channel name (hvrdemo) to view actions defined for all location groups in the selected channel.
Initialize
In this example, HVR Initialize creates one capture job (hvr_demo-cap-src) and one integrate job (hvr_demo-integ-tgt).
- Right-click channel hvrdemo ▶ HVR Initialize.
- Select Create or Replace Objects in HVR Initialize dialog.
- Click Initialize.
- Click OK.
- Click Close.
Click Scheduler node in navigation tree pane to view the capture and integrate jobs in Jobs tab.
For more information about initiating replication in HVR, see Replication Overview.
Start Scheduler
- Start Scheduler. In the navigation tree pane, right-click Scheduler ▶ Start.
- On Windows, the following steps are required to create the HVR Scheduler system service.
- Click Create... in the prompt asking to create the service hvrscheduler_hvrhub.
- In the Create Windows Service dialog, select Local System Account ('SYSTEM') and click Create.
- Click Create... in the prompt asking to create the service hvrscheduler_hvrhub.
Start Capture Job
- In the navigation tree pane, click Scheduler.
- Start capture job. In the Jobs pane, right-click capture job hvrdemo-cap-src ▶ Start.
Click Yes in Start dialog.
On starting the capture job (hvrdemo-cap-src) successfully, the status of the job changes from SUSPEND to RUNNING.
Refresh
This section describes how to perform initial load into the target database. HVR Refresh copies all existing data from source location (src) to the target location (tgt) and optionally creates new tables and keys in target location.
- In the navigation tree pane, right-click channel hvrdemo ▶ HVR Refresh.
- Select Create Absent Tables in HVR Refresh dialog.
- Click Refresh.
- Click Yes to begin HVR Refresh.
When the refresh is completed, the Refresh Result dialog displays the total number of rows replicated from the selected tables.
- Click Close in Refresh Result dialog.
- Click Close in HVR Refresh dialog.
Start Integrate Job
- In the navigation tree pane, click Scheduler.
- Start integrate job. In the Jobs pane, right-click integrate job hvrdemo-integ-tgt ▶ Start.
Click Yes in Start dialog.
On starting the integrate job (hvr_demo-integ-tgt) successfully, the status of the job changes from SUSPEND to RUNNING.
Verify Replication
This section describes the two methods for verifying HVR's replication activity.
Viewing Log File
- In navigation tree pane, click + next to the Scheduler.
- Right-click hvr_demo ▶ View Log to view the output of the jobs.
- Update the value(s) in source location database.
The replication activity details will be displayed in the Log of channel tab.
The directory path for HVR log files is displayed in the Log of channel tab.
Using HVR Compare
HVR Compare allows you to verify the replication activity by comparing the data in source and target locations. To compare the source and target locations,
- Stop the Integrate job (hvrdemo-integ-tgt),
- In the navigation tree pane, click Scheduler.
- In the Jobs pane, right-click integrate job hvrdemo-integ-tgt ▶ Suspend.
- Click Yes in Start dialog.
- Update the value(s) in source location database.
- Execute HVR Compare,
- In the navigation tree pane, right–click channel hvrdemo ▶ HVR Compare.
- Select source location (src) on the left side and target location (tgt) on the right side.
- Select Row by Row Granularity in the Options tab.
- Click Compare.
- On completion, Compare Result dialog is displayed. If the State column displays Different, it indicates the data in source and target locations are not identical.
- Click Close in Compare Result dialog and HVR Compare dialog.
- In the navigation tree pane, right–click channel hvrdemo ▶ HVR Compare.
- Start Integrate Job (hvrdemo-integ-tgt).
- Execute HVR Compare again (step 3). In Compare Result dialog, if the State column displays Identical, it indicates the changes are replicated successfully.