- Created by Sree Raman, last modified by Maksym Lozbin on Jan 19, 2019
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 3 Next »
Introduction
CDAP offers change data capture via three different approaches
- Golden gate for Oracle
- Log miner for Oracle
- Change tracking for SQL server
All these CDC mechanisms are supported via Realtime data pipelines and the plugins are available from Hub. The CDC solution currently runs on Spark 1.x and has experimental support for BigTable.
Use case(s)
The scope of work involves making the CDC solution work with Spark 2.x and being able to write to BigTable. The performance numbers throughput and latency should be published for these two destinations with all the three CDC approaches.
- ETL developers should be able to set up realtime pipelines to write data to BigTable/BigQuery
- Users should get field level lineage for the source and sink that is being used
- Reference documentation should be updated to account for the changes
- The solution should run with all versions of Spark 2.x
- Integration tests for specific plugins should be added in the test repos
- Reference document should be updated for the CDC plugins
Deliverables
- Source code in cask-solution/cdc repo
- Performance tests for the three approaches with BigTable
- Integration test code
- Relevant documentation in the source repo and reference documentation section in plugin
Relevant links
- Existing CDC plugin code: https://github.com/cask-solutions/cdc
- Experimental CDC for Big Table in a branch: https://github.com/cask-solutions/cdc/tree/bigtable-cdc-sink
- Field level lineage: https://docs.cdap.io/cdap/5.1.0-SNAPSHOT/en/developer-manual/metadata/field-lineage.html
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
Configurables
CDCBigTable Sink Properties
User Facing Name | Type | Description | Constraints |
---|---|---|---|
Reference Name | String | Reference specifies the name to be used to track this external source | Required |
Instance Id | String | BigTable instance id. | Required |
Project Id | String | Google Cloud Project ID, which uniquely identifies a project. If not specified, Project ID will be automatically read from the cluster environment. (Macro-enabled) | Optional |
Service Account File Path | String | Path on the local file system of the service account key used for If the plugin is run on a Google Cloud Dataproc cluster, the service account key does not need to be provided and can be set to 'auto-detect'. When running on other clusters, the file must be present on every node in the cluster. See Google's documentation on Service account credentials for details. (Macro-enabled) | Optional (default: null) |
CDCOracleLogMiner Source Properties
TODO
Design
Approach(s)
- Add lineage support for real-time plugins. Requires CDAP core modules modification (co.cask.cdap.etl.spark.streaming.DefaultStreamingContext).
- Make credentials optional for BigTable Sink.
- Add config, schema and third-party application health validation to "configurePipeline" step for all CDC plugins. To validate schema properly, source and sink plugins should use single schema for messages.
- Register datasets of source CDC plugins for lineage view.
- Register fields of all CDC plugins for lineage view.
- Create new core library for Spark 2 plugins. Analogue of "cdap-etl-api-spark".
- Migrate CDC plugins to CDAP core v6.x.x.
- Update documentation to be consistent with the other GCP plugins.
- Write documentation for CDCKudu Sink, CDCDatabase Source, CTSQLServer Source.
- Update UI widgets for all CDC plugins to match properties and schema defined in documentation.
- Implement integration tests for all CDC plugins. Tests should pass using Spark 2. Tests should use local environment if possible. Tests against paid services should run only with special maven profile.
- Try to support both Spark 1 and Spark 2 but drop Spark 1 support if necessary.
- Implement Log miner for Oracle (CDCOracleLogMiner Source).
- Implement performance tests for the three approaches with BigTable.
Limitation(s)
- CDC plugins may not be compatible with Spark 2.
Future Work
- Error rendering macro 'jira' : Unable to locate Jira server for this macro. It may be due to Application Link configuration.
- Oracle Log Miner Source Plugin
- Integration tests for CDC plugins
- Performance tests for CDC plugins
Test Case(s)
- Track changes from Golden gate for Oracle (create table, insert row, update row, delete row).
- Track changes from Log miner for Oracle (create table, insert row, update row, delete row).
- Track changes from SQL Server (create table, insert row, update row, delete row).
- Write changes to Apache Kudu (create table, insert row, update row, delete row).
- Write changes to HBase (create table, insert row, update row, delete row).
- Write changes to BigTable (create table, insert row, update row, delete row).
Sample Pipeline
Pipeline #1 (SQL Server → BigTable)
TODO
Table of Contents
Checklist
- User stories documented
- User stories reviewed
- Design documented
- Design reviewed
- Feature merged
- Examples and guides
- Integration tests
- Documentation for feature
- Short video demonstrating the feature
Introduction
CDAP offers change data capture via three different approaches
- Golden gate for Oracle
- Log miner for Oracle
- Change tracking for SQL server
All these CDC mechanisms are supported via Realtime data pipelines and the plugins are available from Hub. The CDC solution currently runs on Spark 1.x and has experimental support for BigTable.
Use case(s)
The scope of work involves making the CDC solution work with Spark 2.x and being able to write to BigTable. The performance numbers throughput and latency should be published for these two destinations with all the three CDC approaches.
- ETL developers should be able to set up realtime pipelines to write data to BigTable/BigQuery
- Users should get field level lineage for the source and sink that is being used
- Reference documentation should be updated to account for the changes
- The solution should run with all versions of Spark 2.x
- Integration tests for specific plugins should be added in the test repos
- Reference document should be updated for the CDC plugins
Deliverables
- Source code in cask-solution/cdc repo
- Performance tests for the three approaches with BigTable
- Integration test code
- Relevant documentation in the source repo and reference documentation section in plugin
Relevant links
- Existing CDC plugin code: https://github.com/cask-solutions/cdc
- Experimental CDC for Big Table in a branch: https://github.com/cask-solutions/cdc/tree/bigtable-cdc-sink
- Field level lineage: https://docs.cdap.io/cdap/5.1.0-SNAPSHOT/en/developer-manual/metadata/field-lineage.html
Plugin Type
- Batch Source
- Batch Sink
- Real-time Source
- Real-time Sink
- Action
- Post-Run Action
- Aggregate
- Join
- Spark Model
- Spark Compute
Configurables
CDCBigTable Sink Properties
User Facing Name | Type | Description | Constraints |
---|---|---|---|
Reference Name | String | Reference specifies the name to be used to track this external source | Required |
Instance Id | String | BigTable instance id. | Required |
Project Id | String | Google Cloud Project ID, which uniquely identifies a project. If not specified, Project ID will be automatically read from the cluster environment. (Macro-enabled) | Optional |
Service Account File Path | String | Path on the local file system of the service account key used for If the plugin is run on a Google Cloud Dataproc cluster, the service account key does not need to be provided and can be set to 'auto-detect'. When running on other clusters, the file must be present on every node in the cluster. See Google's documentation on Service account credentials for details. (Macro-enabled) | Optional (default: null) |
CDCOracleLogMiner Source Properties
TODO
CDCOracleLogMiner Source Properties
TODO
Design
Approach(s)
- Add lineage support for real-time plugins. Requires CDAP core modules modification (co.cask.cdap.etl.spark.streaming.DefaultStreamingContext).
- Make credentials optional for BigTable Sink.
- Add config, schema and third-party application health validation to "configurePipeline" step for all CDC plugins. To validate schema properly, source and sink plugins should use single schema for messages.
- Register datasets of source CDC plugins for lineage view.
- Register fields of all CDC plugins for lineage view.
- Create new core library for Spark 2 plugins. Analogue of "cdap-etl-api-spark".
- Migrate CDC plugins to CDAP core v6.x.x.
- Update documentation to be consistent with the other GCP plugins.
- Write documentation for CDCKudu Sink, CDCDatabase Source, CTSQLServer Source.
- Update UI widgets for all CDC plugins to match properties and schema defined in documentation.
- Implement integration tests for all CDC plugins. Tests should pass using Spark 2. Tests should use local environment if possible. Tests against paid services should run only with special maven profile.
- Try to support both Spark 1 and Spark 2 but drop Spark 1 support if necessary.
- Implement Log miner for Oracle (
CDCOracleLogMiner Source
. - Implement performance tests for the three approaches with BigTable.
Limitation(s)
- CDC plugins may not be compatible with Spark 2.
Future Work
- Unable to locate Jira server for this macro. It may be due to Application Link configuration.
Test Case(s)
- Track changes from Golden gate for Oracle (create table, insert row, update row, delete row).
- Track changes from Log miner for Oracle (create table, insert row, update row, delete row).
- Track changes from SQL Server (create table, insert row, update row, delete row).
- Write changes to Apache Kudu (create table, insert row, update row, delete row).
- Write changes to HBase (create table, insert row, update row, delete row).
- Write changes to BigTable (create table, insert row, update row, delete row).
Sample Pipeline
Pipeline #1 (SQL Server → BigTable)
TODO
Table of Contents
Checklist
- User stories documented
- User stories reviewed
- Design documented
- Design reviewed
- Feature merged
- Examples and guides
- Integration tests
- Documentation for feature
- Short video demonstrating the feature
- No labels