This tutorial shows you how to deploy a job that continuously replicates changed data from an Oracle database to a BigQuery dataset, using Cloud Data Fusion Replication. This feature is powered by Datastream, Google Cloud's cloud-native change provider and Replication service.
In this tutorial, you:
- Configure your Oracle database to enable supplemental logging.
- Create and run a Cloud Data Fusion Replication job.
- View the results in BigQuery.
This tutorial uses billable components of Google Cloud, including:
When Replication runs, you are charged for the Dataproc cluster and Cloud Storage, and you incur processing costs for Datastream and BigQuery. To optimize these costs, we strongly recommend that you use BigQuery flat rate pricing.
Before you begin
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.
Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.
- Enable the Cloud Data Fusion, Dataproc, Datastream, BigQuery, and Cloud Storage APIs.
- Create a private Cloud Data Fusion instance in version 6.4.0 or above. When you set up the instance:
- Enable Virtual Private Cloud peering.
- Enable Replication by clicking Add Accelerators and selecting Replication.
If you use an existing instance, or if you don't see Replication in the Cloud Data Fusion menu menu, see Upgrade to enable Replication.
Install Oracle in Compute Engine
This section (optional) shows you how to set up an example database. If you already have your own database set up elsewhere, you can skip this section. Note that Datastream supports only specific versions of Oracle database.
Upload your Docker image to the Container Registry.
Deploy your Docker image on a new VM instance. When you create the VM, change the disk size to 500 GB.
Install the HR sample schema.
Configure your Oracle Server to enable supplemental logging
Follow the steps to configure your source Oracle database.
Grant permissions to service accounts
Grant the Cloud Data Fusion service account and the Dataproc service account permission to call the Datastream API and access Cloud Storage.
In the Cloud Console, go to the IAM page.
In the permissions table, in the Members column, find the Cloud Data Fusion service account that matches the format
Click Edit, to the right of the service account.
Click Add Another Role.
Click Select a role.
Use the search bar to search for and select Datastream Admin.
Check that Datastream Admin appears in the Role column of the Permissions table.
Repeat this section to grant permission to the Dataproc service account:
For more information about service accounts and service account keys, see Creating and managing service account keys.
Create VPC network peering or firewall rule for your Oracle server
If your Oracle Database doesn't allow ingress traffic from public IPs, you need to set up VPC peering between the Datastream VPC and the VPC where your Oracle database can be accessed. See Create a private connectivity configuration for details.
Create and run a Cloud Data Fusion Replication job
In the Cloud Data Fusion web UI, click Hub in the upper right.
Click the Oracle via Datastream Replication Plugin and click Deploy.
In the Deploy window that opens, click Finish.
Create the pipeline
In the Cloud Data Fusion UI, click the menu and navigate to the Replication page. Click the green circle button on the top right.
On the Create new Replication job page, specify a Replication job Name. Optionally, specify a description.
Configure the source:
Select Oracle (by Datastream) as the source.
For Connectivity Method, if your Oracle server allows ingress traffic from Datastream public IPs, choose IP allowlisting. Otherwise, for Private Connection Name choose Private connectivity (VPC peering) and enter the VPC peering name you created in the Create VPC peering or firewall rule for your Oracle Server section.
For Host, enter the hostname of the Oracle Server to read from.
For Port, enter the port to use to connect to the Oracle Server: 1521.
For System Identity, enter
xe(the sample database name of the Oracle server).
In the credentials section, enter your username and password for accessing the Oracle Server.
Leave all other properties as is.
If the connection is successful, a list of tables under HR sample schema will appear. For this tutorial, select all of the tables and events to replicate (including Insert, Update, and Delete events).
Configure the target:
Select the BigQuery target.
The Project ID and Service Account Key are automatically detected. Keep the default values as is.
(Optional) In the Advanced section, you can configure the staging bucket's name and location, the load interval, the staging table prefix, and the behavior when tables or databases are dropped.
(Optional) Configure the advanced properties. For this tutorial, you can use the default settings.
On the Review assessment page, click View mappings by any of the tables to get an assessment of schema issues, missing features, or connectivity issues that might occur during Replication. If any issues occur, they must be resolved before you can proceed. For this tutorial, if any of the tables have issues, go back to the step where you selected tables and instead select a table or event (Inserts, Updates, or Deletes) without issues.
Review the summary Replication job details, and then click Deploy Replication job.
Start the job
On the Replication job details page:
The Replication job transitions from Provisioning to Starting to Running state. In the running state, the Replication job loads an initial snapshot of the table data that you selected into BigQuery. In this state, the state of the table is listed as Snapshotting. After the initial snapshot is loaded into BigQuery, any changes made to the table are replicated to BigQuery, and the state of the table is listed as Replicating.
Monitor the job
You can start and stop the Replication job, review its configuration and logs, and monitor your Replication job.
You can monitor Replication job activities from the Replication job details page.
From the Replication page, click the desired Replication job Name.
View the results in BigQuery
The Replication job creates a replicated dataset and table in BigQuery, with names inherited from the corresponding Oracle database and table names.
Open BigQuery in the Cloud Console.
In the left panel, click on your project name to expand a list of datasets.
xedataset, and then select a table to view.
For more information, see the BigQuery documentation.
To avoid incurring charges to your Google Cloud account for the resources used in this tutorial, either delete the project that contains the resources, or keep the project and delete the individual resources.
After you've finished the tutorial, clean up the resources you created on Google Cloud so they won't take up quota and you won't be billed for them in the future. The following sections describe how to delete or turn off these resources.
Delete the VM instance
In the Cloud Console, go to the VM instances page.
Select the checkbox for the instance that you want to delete.
To delete the instance, click Delete.
Delete the Cloud Data Fusion instance
Delete the project
The easiest way to eliminate billing is to delete the project that you created for the tutorial.
To delete the project:
- In the Cloud Console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.