Todd McGrath

<p>How do you ingest from an existing relational database (RDBMS) to an Apache Cassandra or <a href="https://www.datastax.com/products/datastax-enterprise">DataStax Enterprise</a> cluster?</p>

<p>What about a one-time batch loading of historical data vs. streaming changes?</p>

<p>I know what some of you are thinking, write and deploy some code. And maybe the code can utilize a framework like Apache Spark. That's what I would have thought a few years ago. But, it often turns out that's not as easy as expected.</p>

<p>Don't get me wrong, writing and deploying code makes sense for some folks. But for many others, writing and deploying custom code may require significant time and resources.</p>

<p>Are there any alternatives to custom code for Cassandra ingestion from an RDBMS?</p>

<p>For example, are there any third party tools available which focus on data ingestion? And if so, do they support Cassandra or DataStax Enterprise from an RDBMS?</p>

<p><img alt="Cassandra Intro Gif" data-entity-type="file" data-entity-uuid="f6937ad6-3421-4fc6-8113-2b23f58cef6b" src="https://www.datastax.com/sites/default/files/inline-images/cassandra-ingest-intro.gif" /></p>

<p>Yes and Yes with StreamSets.</p>

<p>In this tutorial, we'll explore how you can use the open source StreamSets Data Collector for migrating from an existing RDBMS to DataStax Enterprise or Cassandra.</p>

<p>If this your first time with StreamSets, it's both a browser-based and REST API pipeline designer and execution engine as quickly shown in the following:</p>

<p>We're going to cover both batch and streaming based data ingestion from an RDBMS to Cassandra:</p>

<ul>
	<li>Use Case 1: Initial Bulk Load of historical RDBMS based data into Cassandra (batch)</li>
	<li>Use Case 2: Change Data Capture (aka CDC) trickle feed from RDBMS to Cassandra to keep Cassandra updated in near real-time (streaming)</li>
</ul>

<h3>Why this matters?</h3>

<ul>
	<li>Migrate to Cassandra more quickly than writing a custom code solution</li>
	<li>Build confidence in your Cassandra data models and operations using real-world data</li>
	<li>Switch-over from an RDBMS based environment to Cassandra with minimum downtown (in fact, no downtime is possible. keep reading.)</li>
	<li>Utilize a tool built for data ingest, so you can focus on your business objectives which rely on Cassandra. You're not in the data ingest business, right? So why build something when you don't have to. Prioritize.</li>
</ul>

<h2>Our Approach</h2>

<p><img alt="MySQL Diagram" data-entity-type="file" data-entity-uuid="e081f5cf-c98d-42be-9a59-9ef379235273" src="https://www.datastax.com/sites/default/files/inline-images/mysql-diagram.png" /></p>

<p>I'm going to riff off the world-famous Killrvideo reference application. (I'm assuming you know KillrVideo! If not, just search for it.) Specifically, we're going to present and solve for a migrating an RDBMS called KillrMovies to Cassandra. KillrMovies is a subset of the KillrVideo schema and will help highlight what we can do if we are migrating to DataStax or Cassandra from an RDBMS and not building something entirely new?</p>

<p>We're leveraging a subset of KillrVideo because it's often used when introducing and teaching data modeling in DataStax and Cassandra. And this especially relevant in this tutorial where we are taking an existing RDBMS based model and migrating to Cassandra.</p>

<p>The KillrMovies RDBMS data model is traditional, 3NF where normalization is paramount.</p>

<p>Conversely, when moving to Cassandra, the data model is based on known queries with denormalized data.</p>

<p><img alt="Cassandra Diagram" data-entity-type="file" data-entity-uuid="08fa0340-e76a-484f-b6fe-9bc16799d978" src="https://www.datastax.com/sites/default/files/inline-images/cassandra-diagram.png" /></p>

<h2>Requirements</h2>

<ol>
	<li>Cassandra or DataStax Enterprise (DSE) (see schema/cassandra_schema.cql file)</li>
	<li>An RDBMS with a JDBC driver such as Oracle, Microsoft SQL Server, PostgreSQL or mySQL (this tutorial uses mySQL)</li>
	<li>StreamSets Data Collector 3.4 or above</li>
</ol>

<p>Please note: If you are new to StreamSets, you are encouraged to visit <a href="http://www.streamsets.com/">http://www.streamsets.com</a> to learn more and complete the Basic Tutorials available at <a href="https://streamsets.com/tutorials/">https://streamsets.com/tutorials/</a> before attempting this tutorial.</p>

<h3>Use Case 1 - Bulk Loading Cassandra from RDBMS</h3>

<p>Let's work backward. What does the end result of bulk loading into Cassandra from an RDBMS with StreamSets look like?</p>

<p>In the following screencast, I demonstrate how to run the provided StreamSets bulk load pipeline. Along the way, we'll review the before and after state of the mySQL database and Cassandra.</p>

<p><iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/jGj1yGxmHdI" width="560"></iframe></p>

<h3>Key Deliverables</h3>

<p dir="ltr">In the demonstration, we saw the ability to move from a data model appropriate for RDBMS to a data model appropriate for Cassandra without writing any code. Instead, we utilized StreamSets configuration as code. That's an important point. StreamSets Data Collector is not a code generator. It is both a design tool and execution engine. As we saw in the pipeline import, pipelines are represented in JSON config.</p>

<p dir="ltr">Bonus Points: did you notice we converted auto-incrementing primary keys in RDBMS to uuid fields in Cassandra? The construct of auto-incrementing primary keys is not typically used with distributed databases due to the potential of gaps in the sequence and performance ramifications if attempting to implement. &nbsp;Auto-incrementing primary keys are not supported in Cassandra.</p>

<h3 dir="ltr">StreamSets configuration</h3>

<p dir="ltr">How should we configure StreamSets for this bulk load use case? &nbsp;</p>

<p dir="ltr">In the following screencast, let’s review the StreamSets configuration for the initial bulk load:</p>

<p><iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/msFiD2OidOs" width="560"></iframe></p>

<h3>Use Case 2 - Change Data Capture to Cassandra</h3>

<p>In databases, change data capture (CDC) is a set of software design patterns used to determine (and track) the data that has changed so that action can be taken using the changed data. [1]</p>

<p>In other words, for this tutorial, a mySQL CDC origin will allow us to identify insert, update or delete mutations in near real-time in order to translate these operations into our Cassandra destination.</p>

<p>StreamSets has many out-of-the-box options for CDC-enabled databases including Oracle, Microsoft SQL Server, Mongo, PostgreSQL and mySQL. [2]</p>

<p>When implementing CDC patterns, you need to make some high-level choices regarding logical vs. physical mutations:</p>

<ul>
	<li>Do you want to perform logical or physical deletes from origin to destination? This typically depends on the design of the origin database. Is the origin performing physical deletes? Logical deletes are often referred to as "soft deletes", in which a column is updated to indicate if a record has been deleted or not; i.e. a boolean deleted column or an operation_type column indicator.</li>
	<li>Do you want to perform logical or physical updates? When an update happens at the source RDBMS, do you want to update the record in the destination or do you want to write a new record with a logical update? As an example of logical update, you may have a data model with an operation_type column with int value indicators for INSERT, UPDATE or DELETE. An operation_type column is often paired with with a created_at timestamp column. These two columns would allow you to have a running history of updates to a particular entity. (or even deletes if you choose)</li>
</ul>

<p>You have options. In this tutorial, we’ll implement a logical approach when collecting RDBMS mutations to the Cassandra destination.</p>

<p>In this logical approach, we will retain a history of source mutations. See the FAQ section below for alternatives.</p>

<p>Let's take a look at streaming change data capture to Cassandra in the following screencast:</p>

<p><iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/-yH0aMgAMhQ" width="560"></iframe></p>

<h3>Key Deliverables</h3>

<p>In this second data pipeline example, we showed CDC from mySQL to Cassandra using a streaming pipeline. This is different from the first example which was a one-time batch pipeline. This pipeline is intended to run continuously.</p>

<p>We chose the approach of logical updates and deletes vs. physical.</p>

<h3>StreamSets Configuration</h3>

<p>Let's review how the streaming change data capture pipeline is configured in the following screencast:</p>

<p><iframe allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen="" frameborder="0" height="315" src="https://www.youtube.com/embed/_3nOPu5sfkc" width="560"></iframe></p>

<h2>FAQ</h2>

<p>Here are a few common questions and their answers:</p>

<ol>
	<li>What if my RDBMS has too many tables to address in a StreamSets pipeline, or I want to organize into multiple pipelines?<br />
	<br />
	Solution: Break up into multiple pipelines and filter accordingly. You can filter in both the Bulk Ingest pipeline as well as the CDC origin pipeline:<br />
	<br />
	To filter in JDBC Multitable origin, configure the Tables tab. This tutorial has filters for the movies and users tables. You can use wildcards and exclusion patterns if needed.<br />
	<br />
	To filter in mySQL bin log CDC origin, look in the Advanced tab, in the Include Tables and Ignore Tables config options.<br />
	&nbsp;</li>
	<li>What if I want to perform physical deletes vs. logical?<br />
	<br />
	Update your pipeline or create a new pipeline especially for deletes. Use the JDBC<br />
	Executor or JDBC Producer stage configured with a Cassandra JDBC driver to issue the dynamically constructed delete queries.<br />
	&nbsp;</li>
	<li>What if I want to perform physical updates vs. logical?<br />
	<br />
	In this case, simply update your StreamSets pipeline and Cassandra data model to remove the created_at and operation_type fields. An existing record in Cassandra will be updated (upsert). The cassandra_schema_no_history.cql file has this model already for you. Note: you'll need to address deletes or sdc.operation.type == 2 in your pipeline with this model.</li>
</ol>

<h3>Source</h3>

<p><a href="https://github.com/tmcgrath/cassandra-ingest">https://github.com/tmcgrath/cassandra-ingest</a></p>

<p>RDBMS data model created with <a href="https://dbdiagram.io/">https://dbdiagram.io</a></p>

<p>Cassandra/DataStax data model created with <a href="https://hackolade.com/">https://hackolade.com</a></p>

<h3>References</h3>

<ol>
	<li>[1] <a href="https://en.wikipedia.org/wiki/Change_data_capture">What is Change Data Capture?</a></li>
	<li><a href="https://streamsets.com/documentation/datacollector/latest/help/datacollector/UserGuide/Pipeline_Design/CDC-Overview.html">Change Data Capture (CDC) with StreamSets documentation[2]</a></li>
	<li><a href="https://github.com/tmcgrath/cassandra-ingest/wiki/Configuring-mySQL-binlog-Change-Data-Capture-Environment-Configuration">Configuring mySQL binlog for CDC</a></li>
</ol>

<h2>Conclusion</h2>

<p>In this tutorial, you saw how to batch load and stream changes from an RDBMS to Cassandra using StreamSets. If you have any questions or suggestions for improvement, let me know!</p>


Ingesting Data from Relational Databases to Cassandra with StreamSets

Todd McGrath

Discover more

Share

More Technology

Getting Started with DataStax Astra DB and Amazon Bedrock

Why You Can't Miss Cassandra Summit

Mitigate the OpenAI Debacle with Open Source and Cloud

Supercharge AI Assistants with Superagent and DataStax

NoSQL and Vector DB
for Generative AI,
Instantly, At Scale

Todd McGrath

Discover more

Share

More Technology

Getting Started with DataStax Astra DB and Amazon Bedrock

Why You Can't Miss Cassandra Summit

Mitigate the OpenAI Debacle with Open Source and Cloud

Supercharge AI Assistants with Superagent and DataStax

NoSQL and Vector DBfor Generative AI,Instantly, At Scale

NoSQL and Vector DB
for Generative AI,
Instantly, At Scale