MySQL® change data capture and delivery to YDS
You can track data changes in a Managed Service for MySQL® source cluster and send them to a Data Streams target cluster using change data capture (CDC).
To set up CDC using Data Transfer:
If you no longer need the resources you created, delete them.
Required paid resources
-
Managed Service for MySQL® cluster: computing resources allocated to hosts, size of storage and backups (see Managed Service for MySQL® pricing).
-
Public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
-
Each transfer: use of computing resources and number of transferred data rows (see Data Transfer pricing).
-
Managed Service for YDB database. Its pricing is based on deployment mode:
- In serverless mode, you pay for data operations and storage volume, including stored backups.
- In dedicated instance mode, you pay for the use of computing resources allocated to the database, size of storage and backups.
-
Data Streams: The cost depends on the pricing model:
- Based on allocated resources: You pay a fixed hourly rate for the established throughput limit and message retention period, and additionally for the number of units of actually written data.
- On-demand: You pay for the performed read/write operations, the amount of read or written data, and the actual storage used for messages that are still within their retention period.
See Data Streams pricing.
Getting started
Set up the infrastructure:
-
Create a Managed Service for MySQL® source cluster in any applicable configuration with publicly available hosts and the following settings:
- DB name:
db1 - Username:
mmy-user
- DB name:
-
Grant the user the
REPLICATION CLIENTandREPLICATION SLAVEadmin privileges. -
Set up security groups and make sure they allow cluster connections.
-
Create a Managed Service for YDB database named
ydb-examplein any suitable configuration. -
Create a service account named
yds-sawith theyds.editorrole. The transfer will use it to access Data Streams.
-
If you do not have Terraform yet, install it.
-
Get the authentication credentials. You can add them to environment variables or specify them later in the provider configuration file.
-
Configure and initialize a provider. There is no need to create a provider configuration file manually, you can download it
. -
Place the configuration file in a separate working directory and specify the parameter values. If you did not add the authentication credentials to environment variables, specify them in the configuration file.
-
Download the mysql-yds.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- Security group required for cluster connection.
- Managed Service for MySQL® source cluster.
- Managed Service for YDB database.
- Service account to use for Data Streams access.
- Source endpoint.
- Transfer.
-
In
mysql-yds.tf, specify the MySQL® user password. -
Make sure the Terraform configuration files are correct using this command:
terraform validateTerraform will show any errors found in your configuration files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform planIf you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
Wait for the operation to complete.
-
All the required resources will be created in the specified folder. You can check resource availability and their settings in the management console
. -
Set up your transfer
-
Create a data stream in Data Streams named
mpg-stream. -
Connect to the Managed Service for MySQL® cluster, create a table named
measurementsin thedb1database, and populate it with data:CREATE TABLE measurements ( device_id varchar(200) NOT NULL, datetime timestamp NOT NULL, latitude real NOT NULL, longitude real NOT NULL, altitude real NOT NULL, speed real NOT NULL, battery_voltage real, cabin_temperature real NOT NULL, fuel_level real, PRIMARY KEY (device_id) ); INSERT INTO measurements VALUES ('iv9a94th6rzt********', '2022-06-05 17:27:00', 55.70329032, 37.65472196, 427.5, 0, 23.5, 17, NULL), ('rhibbh3y08qm********', '2022-06-06 09:49:54', 55.71294467, 37.66542005, 429.13, 55.5, NULL, 18, 32); -
Create a target endpoint of the
Data Streamstype with the following settings:- Database:
ydb-example - Stream:
mpg-stream - Service account:
yds-sa
- Database:
-
Create a source endpoint and transfer:
ManuallyTerraform-
Create a source endpoint of the
MySQL®type and specify these cluster connection settings in it:- Connection type:
Managed Service for MySQL cluster - Managed Service for MySQL cluster:
<source_cluster_name>from the drop-down list. - Database:
db1 - User:
mmy-user - Password:
mmy-userpassword.
- Connection type:
-
Create a transfer of the Replication type that will use the new endpoints.
-
In the
mysql-yds.tffile, specify these variables:yds_endpoint_id: ID of the target endpoint.transfer_enabled: Set to1to create a transfer.
-
Make sure the Terraform configuration files are correct using this command:
terraform validateTerraform will show any errors found in your configuration files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform planIf you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
Wait for the operation to complete.
-
-
-
Activate the transfer
- Activate the transfer and wait for its status to change to Replicating.
Make sure the data from the source has been moved to the Data Streams stream:
- In the management console
, select Data Streams. - Select the target stream from the list and navigate to
Data viewer. - Make sure
shard-000000now contains messages with the source table rows. For a closer look at the messages, click .
-
Install the AWS CLI
. -
Configure the environment for Data Streams.
-
Read the stream data using:
Test the replication process
-
Connect to the source cluster.
-
Add a new row to the
measurementstable:INSERT INTO measurements VALUES ('ad02l5ck6sdt********', '2022-06-05 17:27:00', 55.70329032, 37.65472196, 427.5, 0, 23.5, 19, 45); -
Make sure you can now see the new row in your data stream.
Delete the resources you created
Note
Before deleting the created resources, deactivate the transfer.
Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need:
Delete the other resources depending on how you created them:
-
In the terminal window, go to the directory containing the infrastructure plan.
Warning
Make sure the directory has no Terraform manifests with the resources you want to keep. Terraform deletes all resources that were created using the manifests in the current directory.
-
Delete resources:
-
Run this command:
terraform destroy -
Confirm deleting the resources and wait for the operation to complete.
All the resources described in the Terraform manifests will be deleted.
-