3.1 Preparing for Installation
Prepare your Java environment by ensuring that you have the correct version of Java installed, and that the environmental variables have been set up and configured correctly.
- Downloading Oracle GoldenGate for Big Data
- Installation Overview
- Directory Structure
- Setting up Environmental Variables
Parent topic: Prepare
3.1.1 Downloading Oracle GoldenGate for Big Data
Oracle GoldenGate (both Classic and Microservices) for Big Data are available for Windows, Linux, and UNIX. To download, first visit the Oracle support site to see if there is a patch available for your operating system and architecture.
Note:
If you are not planning to use the generic build included in the installation, ensure that the major release of the Oracle GoldenGate for Big Data build you download matches (or is known to be compatible with) the major release of the Oracle GoldenGate instance that will be used with it.
-
Navigate to
http://support.oracle.com
. -
Sign in with your Oracle ID and password.
-
Select the Patches and Upgrades tab.
-
On the Search tab, click Product or Family.
-
In the Product field, type Oracle GoldenGate for Big Data.
-
From the Release drop-down list, select the release version that you want to download.
-
Make sure Platform is displayed as the default in the next field, and then select the platform from the drop-down list.
-
Leave the last field blank.
-
Click Search.
-
In the Advanced Patch Search Results list, select the available builds that satisfy the criteria that you supplied.
-
In the file Download dialog box, click the ZIP file to begin the download.
If patches are not available on the support site, go to the Oracle delivery site for the release download.
Parent topic: Preparing for Installation
3.1.2 Installation Overview
This section provides an overview of the installation contents and the Oracle GoldenGate instances used with the Oracle GoldenGate for Big Data.
- Contents of the Installation ZIP File
- Using the Generic Build of Oracle GoldenGate
- Considerations for Using a Custom Build for a Big Data Instance of Oracle GoldenGate
- Installing to a Non-Generic Instance of Oracle GoldenGate
Parent topic: Preparing for Installation
3.1.2.1 Contents of the Installation ZIP File
The Oracle GoldenGate for Big Data installation ZIP file contains:
-
Oracle GoldenGate Java Adapter
-
A version of Oracle GoldenGate designed to stream data to Big Data targets. This version is labeled generic because it is not specific to any database, but it is platform dependent.
Parent topic: Installation Overview
3.1.2.2 Using the Generic Build of Oracle GoldenGate
For JMS capture, the Java Adapter must run in the generic build of Oracle GoldenGate. However, the generic build is not required when using the adapter for delivery of trail data to a target; in this case, the Java Adapter can be used with any database version of Oracle GoldenGate.
Parent topic: Installation Overview
3.1.2.3 Considerations for Using a Custom Build for a Big Data Instance of Oracle GoldenGate
There are both advantages and disadvantages to installing a custom build for a Big Data Oracle GoldenGate instance. Also, there are limitations in the releases of Oracle GoldenGate that are compatible with releases of the Big Data.
Advantages
-
The non-generic instance allows you to configure Extract to login to the database for metadata. This removes the need to use a source definitions file that must be synchronized your the source database DDL.
-
There is no need to manage two separate versions of Oracle GoldenGate when doing database capture and JMS delivery on the same server.
Disadvantages
-
If you need to patch Oracle GoldenGate core instance, you must also copy the Big Data into the new patched installation of Oracle GoldenGate.
-
The Oracle GoldenGate for Big Data are only tested and certified with the generic version of Oracle GoldenGate core. New patches of the core can trigger incompatibilities.
Limitations
-
The Replicat module to write to Big Data targets is only available in the Generic Oracle GoldenGate distribution.
-
The generic build must be used with JMS capture, as this is the only version of Extract that is capable of loading the VAM.
-
A
DEFGEN
utility is not included with the Big Data. To generate source definitions, you will need a version of Oracle GoldenGate that is built specifically for your database type.
Parent topic: Installation Overview
3.1.2.4 Installing to a Non-Generic Instance of Oracle GoldenGate
If you decide to install the Java user exit to a non-generic instance of Oracle GoldenGate, unzip to a temporary location first and then copy the adapter files to your Oracle GoldenGate installation location.
To install the Java user exit to a non-generic instance of Oracle GoldenGate:
Parent topic: Installation Overview
3.1.3 Directory Structure
The following table is a sample that includes the subdirectories and files that result from unzipping the installation file and creating the subdirectories. The following conventions have been used:
-
Subdirectories are enclosed in square brackets []
-
Levels are indicated by a pipe and hyphen |
-
-
The Internal notation indicates a read-only directory that should not be modified
-
Text files (
*.txt
) are not included in the list -
Oracle GoldenGate utilities, such as Defgen, Logdump, and Keygen, are not included in the list
Table 3-1 Sample installation directory structure
Directory | Explanation |
---|---|
[gg_install_dir] |
Oracle GoldenGate installation directory, such as
|
|-ggsci |
Command line interface used to start, stop, and manage processes. |
|-mgr |
Manager process. |
|-extract |
Extract process that will start the Java application. |
|-replicat |
Replicat process that will start the Java application. |
|-[UserExitExamples] |
Sample C programming language user exit code examples. |
|-[dirprm] |
Subdirectory that holds all the parameter and property files created by the user, for example: javaue.prm javaue.properties jmsvam.prm jmsvam.properties ffwriter.prm |
|-[dirdef] |
Subdirectory that holds source definitions files
(
|
|-[dirdat] |
Subdirectory that holds the trail files produced by the VAM Extract or read by the user exit Extract. |
|-[dirrpt] |
Subdirectory that holds log and report files. |
|-[dirchk] |
Internal Subdirectory that holds checkpoint files. |
|-[dirpcs] |
InternalSubdirectory that holds process status files. |
|-[dirjar] |
Internal Subdirectory that holds Oracle GoldenGate Monitor jar files. |
|-[ggjava] |
Internal Installation directory for Java jars. Read-only; do not modify. |
|-|-ggjava.jar |
The main Java application jar that defines the class path and dependencies. |
|-|-[resources] |
Subdirectory that contains all
|
|-ggjava_vam.dll |
The VAM shared library. This is
|
|
Used by the Replicat based delivery process. This is
|
|-. . . |
Other subdirectories and files included in the installation or created later. |
Parent topic: Preparing for Installation
3.1.4 Setting up Environmental Variables
To configure your Java environment for Oracle GoldenGate for Java:
-
The
PATH
environmental variable should be configured to find your Java Runtime -
The shared (dynamically linked) Java virtual machine (JVM) library must also be found.
On Windows, these environmental variables should be set as system variables; on Linux/UNIX, they should be set globally or for the user running the Oracle GoldenGate processes. Examples of setting these environmental variables for Windows, UNIX, and Linux are in the following sections.
Note:
There may be two versions of the JAVA_HOME/.../client
, and another in JAVA_HOME/.../server
. For improved performance, use the server version, if it is available. On Windows, only the client JVM may be there if only the JRE was installed (and not the JDK).
Parent topic: Preparing for Installation
3.1.4.1 Java on Linux/UNIX
Configure the environment to find the JRE in the PATH
, and the JVM
shared library, using the appropriate environmental variable for your system. For
example, on Linux (and Solaris), set LD_LIBRARY_PATH
to include the
directory containing the JVM shared library as follows (for
sh/ksh/bash
):
Note:
On AIX platforms, you set LIBPATH=
. On HP-UX IA64, you set SHLIB_PATH=
.
Example 3-1 Configuring path for Java on Linux
export JAVA_HOME=/opt/jdk1.8 export PATH=$JAVA_HOME/bin:$PATH export LD_LIBRARY_PATH=$JAVA_HOME/jre/lib/amd64/server:$LD_LIBRARY_PATH
In this example, the directory $JAVA_HOME/jre/lib/i386/server
should contain the
libjvm.so
and
libjsig.so
files. The actual
directory containing the JVM library depends on the
operating system and if the 64-bit JVM is being
used.
Verify the environment settings by opening a command prompt and checking the Java version as in this example:
$ java -version java version "1.8.0_92" Java(TM) SE Runtime Environment (build 1.8.0_92-b14)
Parent topic: Setting up Environmental Variables
3.1.4.2 Java on Windows
After Java is installed, configure the PATH
to find the JRE and JVM DLL (jvm.dll
):
Example 3-2 Configuring Path for Java on Windows
set JAVA_HOME=C:\Program Files\Java\jdk1.8.0 set PATH=%JAVA_HOME%\bin;%PATH% set PATH=%JAVA_HOME%\jre\bin\server;%PATH%
In the example above, the directory %JAVA_HOME%\jre\bin\server
should contain the file jvm.dll.
Verify the environment settings by opening a command prompt and checking the Java version as in this example:
C:\> java -version java version "1.8.0_92" Java(TM) SE Runtime Environment (build 1.8.0_92-b14))
Parent topic: Setting up Environmental Variables