Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Macro Enabled?

Version Introduced

Description

Basic Properties

Use an existing Datastream stream

No

Required. Whether to let this plugin create a new Datastream stream or use an existing Datastream stream. It’s recommended that you only have one Datastream stream per Oracle Database for performance concerns.

Region

No

Optional. The region of the Datastream stream. Supported regions can be found here.

Stream ID

No

Optional. The ID of the existing Datastream stream. Only applicable when you want to use an existing Datastream stream.

Connectivity Method

No

Optional. How you want the Datastream to connect to your database. See Source network connectivity options about what each option means and what you need to do for your network settings.

Host

No

Optional. The hostname or IP address of your SSH tunnel bastion server. Only applicalbe when you choose Forward SSH Tunnel as your Connectivity Method.

Port

No

Optional. The port number to use to connect to your SSH tunnel bastion server. Only applicable when you choose Forward SSH Tunnel as your Connectivity Method.

Default is 22.

Username

No

Optional. The username that Datastream can use to connect to your SSH tunnel bastion server. Only applicable when you choose Forward SSH Tunnel as your Connectivity Method.

Authentication Method

No

Optional. How your SSH tunnel bastion server authenticates the user (Datastream). Only applicable when you choose Forward SSH Tunnel as your Connectivity Method.

Private Key

No

Optional. The private key Datastream will use to connect to your SSH tunnel bastion server that matches the public key assigned to it. Only applicable when you choose Private/Public Key Pair as your Authentication Method.

Password

Yes

Optional. The passowrd to use to connect to your SSH tunnel bastion server. Only applicable when you choose Password as your Authentication Method.

Private Connection Name

Yes

Optional. Name of the private connection. The network admins of the Google Cloud Platform project should create a VPC peering between the database VPC and the Datastream VPC (see Use private connectivity for details). This is the name of the VPC peering they created. Only applicable when you choose Private connectivity (VPC peering) as your Connectivity Method.

Database Properties

Host

No

Optional. Hostname or IP address of your Oracle server to read from.

Port

No

Optional. Port number to use to connect to your Oracle server.

Default 1521.

System Identifier (SID)

No

Optional. The system identifier(SID) of the oracle database you want to replicate data from.

Default is ORCL.

Credentials

Username

No

Optional. Username to use to connect to your Oracle server.

Password

No

Optional. Password to use to connect to your Oracle server.

Advanced Properties

Replicate Existing Data

No

Optional. Whether to replicate existing data from the source database. When false, any existing data in the source tables will be ignored, and only changes that happened after the pipeline started will be replicated. By default, existing data will be replicated.

Default is Yes.

Project

No

Optional. The Google Cloud Platform project that has enabled the Datastream API. It will default to the value of the system property GOOGLE_CLOUD_PROJECT or GCLOUD_PROJECT for CDAP.

Datastream Service Account Key

No

Optional. The service account key for the service account that will be used as the identity to call the Datastream API. It will default to the content of the file referred by the system property GOOGLE_APPLICATION_CREDENTIALS for CDAP.

GCS Service Account Key

No

Optional. The service account key for the service account that will be used as the identity to access GCS. Datastream will write the change stream to the GCS bucket you specified as the GCS Bucket property of this plugin. This service account will be used as the identity to get and create (if you want this plugin to create a new bucket) the bucket and read Datastream result from the bucket. It will default to the content of the file referred by the system property GOOGLE_APPLICATION_CREDENTIALS for CDAP.

GCS Bucket

No

Optional. The GCS (Google Cloud Storage) bucket that Datastream will write its output to. If the bucket you provide doesn’t exist or you leave it as empty, this plugin will create a new one in the Project you specified in this plugin.

GCS Bucket Location

No

6.8.0

Optional. The location of GCS (Google Cloud Storage) bucket that Datastream will write its output to. A complete list of available locations can be found at https://cloud.google.com/bigquery/docs/locations . This value is ignored if an existing GCS bucket is specified.

Path Prefix

No

Optional. The GCS (Google Cloud Storage) path prefix in the bucket that Datastream will write its output to. This prefix will be prefixed to the Datastream output path. It’s usually used when you want Datastream to write its output to an existing bucket and you want to easily differentiate it from other existing GCS files by its path prefix.

Schema Evolution

This section lists the data definition language (DDL) operations supported during Oracle replication.

DDL Operation

Supported?

Create table

No

Rename table

No

Truncate table

No

Drop table

No

Add nullable column

Yes

Add required column

No

Alter column to make it nullable

Yes

Alter column to make it required

No

Alter column type 

No

Rename column

No

Drop column

No

...