Loading data from YDB to Yandex Managed Service for ClickHouse® using Yandex Data Transfer
Data Transfer enables you to transfer data from a database in Managed Service for YDB to a Managed Service for ClickHouse® cluster.
To transfer data:
If you no longer need the resources you created, delete them.
Required paid resources
-
Managed Service for YDB database (see Managed Service for YDB pricing). Its cost depends on the 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, storage size, and backups.
-
Managed Service for ClickHouse® cluster, which includes computing resources allocated to hosts, storage and backup size (see Managed Service for ClickHouse® pricing).
-
Public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
Getting started
Set up your infrastructure:
-
Create a Managed Service for YDB database named
ydb1of your preferred configuration. -
Create a Managed Service for ClickHouse® cluster of any suitable configuration with publicly accessible hosts and the following settings:
- DB name:
db1 - Username:
user1
- DB name:
-
If using security groups, make sure they are configured correctly and allow connections to your Managed Service for ClickHouse® cluster.
-
Create a service account named
ydb-accountwith theydb.editorrole. The transfer will use it to access the database.
-
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 ydb-to-clickhouse.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- Security group and rules for internet access to the Managed Service for ClickHouse® cluster.
- Managed Service for YDB database.
- Managed Service for ClickHouse® target cluster.
- Source endpoint.
- Target endpoint.
- Transfer.
-
In the
ydb-to-clickhouse.tffile, specify the following settings:mch_version: ClickHouse® version.mch_password: ClickHouse® database owner password.
-
Validate your Terraform configuration files using this command:
terraform validateTerraform will display any configuration errors detected in your 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
. -
Prepare your test data
-
Create a row-oriented table named
table1with the following columns:Name Type Primary key IdInt64Yes NameUtf8You can create this table using the following SQL query:
CREATE TABLE table1 ( Id Int64, Name Utf8, PRIMARY KEY (Id) ) -
Populate the table with data using the following SQL query:
INSERT INTO table1 (Id, Name) VALUES (1, "Anna"), (2, "Robert"), (3, "Umar"), (4, "Algul"), (5, "Viktor");
Set up and activate the transfer
-
Create a source endpoint of the
YDBtype with the following database connection settings:-
Connection settings:
-
Database: Select your Managed Service for YDB database from the list.
-
Service account ID: Select the
ydb-accountservice account.
-
-
Included paths list:
table1.
-
-
Create a target endpoint of the
ClickHouse®type with the following cluster connection settings:- Connection type:
Managed cluster. - Managed cluster:
<ClickHouse®_target_cluster_name>from the drop-down list. - Database:
db1. - User:
user1. - Password:
<user_password>.
- Connection type:
-
Create a transfer of the Snapshot and replication type that will use the endpoints you created.
-
Activate the transfer and wait for its status to change to Replicating.
-
In the
ydb-to-clickhouse.tffile, settransfer_enabledto1. -
Validate your Terraform configuration files using this command:
terraform validateTerraform will display any configuration errors detected in your 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.
-
The transfer will be activated automatically upon creation.
-
Test the transfer
Make sure the transfer works correctly by testing copying and replication.
Test copying
-
Connect to the
db1database in the Managed Service for ClickHouse® target cluster. -
Run this query:
SELECT * FROM db1.table1;Response example
# | Id | Name | __data_transfer_commit_time | __data_transfer_delete_time --+-----+----------+-----------------------------+---------------------------- 1 | "1" | "Anna" | "1722023098109014844" | "0" 2 | "2" | "Robert" | "1722023098109014844" | "0" 3 | "3" | "Umar" | "1722023098109014844" | "0" 4 | "4" | "Algul" | "1722023098109014844" | "0" 5 | "5" | "Viktor" | "1722023098109014844" | "0"
Test replication
-
Add data to the table named
table1:INSERT INTO table1 (Id, Name) VALUES (6, "Maria"), (7, "Alex"); -
Check that the data has been replicated to the target database:
-
Connect to the
db1database in the Managed Service for ClickHouse® target cluster. -
Run this query:
SELECT * FROM db1.table1;Response example
# | Id | Name | __data_transfer_commit_time | __data_transfer_delete_time --+-----+----------+-----------------------------+---------------------------- 1 | "1" | "Anna" | "1722023098109014844" | "0" 2 | "2" | "Robert" | "1722023098109014844" | "0" 3 | "3" | "Umar" | "1722023098109014844" | "0" 4 | "4" | "Algul" | "1722023098109014844" | "0" 5 | "5" | "Viktor" | "1722023098109014844" | "0" 6 | "6" | "Maria" | "1722023655224000000" | "0" 7 | "7" | "Alex" | "1722023655225000000" | "0"
-
Delete the resources you created
Note
Before deleting the resources, deactivate the transfer.
To reduce the consumption of resources, delete those you do not need:
-
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.
-
ClickHouse® is a registered trademark of ClickHouse, Inc