Loading data from Yandex Object Storage to a ClickHouse® data mart
Note
You can migrate data from Yandex Object Storage to the Managed Service for ClickHouse® table using Data Transfer. To do this:
If you no longer need the resources you created, delete them.
Required paid resources
The support cost for this solution includes:
- Fee for an Object Storage bucket: Covers data storage and bucket operations (see Object Storage pricing).
- Managed Service for ClickHouse® cluster fee: Use of computing resources allocated to hosts (including ZooKeeper hosts) and disk storage (see Managed Service for ClickHouse® pricing).
- Fee for public IP address assignment on cluster hosts (see Virtual Private Cloud pricing).
- Per-transfer fee: Use of computing resources and number of transferred data rows (see Data Transfer pricing).
Getting started
Set up the infrastructure:
-
Create a target Managed Service for ClickHouse® cluster with the following settings:
- Number of ClickHouse® hosts: Minimum of 2 to enable replication within the cluster.
- Public access to cluster hosts: Allowed.
- DB name:
db1. - Username:
user1. - Password:
<user_password>.
-
If using security groups, make sure they are configured correctly and allow inbound connections to your cluster.
-
Create a service account named
storage-viewerwith thestorage.viewerrole. The transfer will use it to access the bucket. -
Create a static access key for the
storage-viewerservice account.
-
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 object-storage-to-clickhouse.tf
configuration file to your current working directory.This file describes:
- Network.
- Subnet.
- Cluster access security group.
- Service account for bucket operations, e.g., creation and access.
- Yandex Lockbox secret for the service account static key required to configure the source endpoint.
- Source Object Storage bucket.
- Target Managed Service for ClickHouse® cluster.
- Target endpoint.
- Transfer.
-
In the
object-storage-to-clickhouse.tffile, specify the following:folder_id: Cloud folder ID matching the one specified in your provider settings.bucket_name: Bucket name consistent with the following naming conventions.ch_password: ClickHouse® user 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
-
Prepare two CSV files with test data:
-
demo_data1.csv:1,Anna 2,Robert 3,Umar 4,Algul 5,Viktor -
demo_data2.csv:6,Maria 7,Alex
-
-
Upload the
demo_data1.csvfile to the Object Storage bucket.
Set up and activate the transfer
-
Create an
Object Storage-type source endpoint with the following settings:-
Database type:
Object Storage. -
Bucket: Object Storage bucket name.
-
Access Key ID: Public component of the service account’s static key. If you created your infrastructure using Terraform, copy the key value from the Yandex Lockbox secret.
-
Secret Access Key: Service account’s secret access key. If you created your infrastructure using Terraform, copy the key value from the Yandex Lockbox secret.
-
Endpoint:
https://storage.yandexcloud.net. -
Region:
ru-central1. -
Data format:
CSV. -
Delimiter: Comma (
,). -
Table:
table1. -
Result table schema: Select
Manualand specify the following field names and data types:Id:Int64Name:UTF8
Keep the default values for all other settings.
-
-
Create a target endpoint and set up the transfer:
ManuallyUsing Terraform-
Create the
ClickHouse®-type target endpoint and specify its 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 new endpoints.
-
Activate the transfer and wait for its status to change to Replicating.
-
In the
object-storage-to-clickhouse.tffile, specify the following settings:source_endpoint_id: Source endpoint ID.transfer_enabled:1(create a transfer).
-
Make sure the Terraform configuration files are correct 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 activate automatically upon creation. Wait for its status to change to Replicating.
-
Test the transfer
To verify that the transfer is operational, test the copy and replication processes.
Test the copy operation
-
Connect to
db1in your target Managed Service for ClickHouse® cluster. -
Run this query:
SELECT * FROM db1.table1;Response example
__file_name | __row_index | Id | Name --------------+-------------+----+-------- demo_data1.csv | 1 | 1 | Anna demo_data1.csv | 2 | 2 | Robert demo_data1.csv | 3 | 3 | Umar demo_data1.csv | 4 | 4 | Algul demo_data1.csv | 5 | 5 | Viktor
Test the replication process
-
Upload the
demo_data2.csvfile to the Object Storage bucket. -
Verify that the data from
demo_data2.csvhas been loaded into the target database:-
Connect to
db1in the Managed Service for ClickHouse® target cluster. -
Run this query:
SELECT * FROM db1.table1;Response example
__file_name | __row_index | Id | Name --------------+-------------+----+-------- demo_data1.csv | 1 | 1 | Anna demo_data1.csv | 2 | 2 | Robert demo_data1.csv | 3 | 3 | Umar demo_data1.csv | 4 | 4 | Algul demo_data1.csv | 5 | 5 | Viktor demo_data2.csv | 1 | 6 | Maria demo_data2.csv | 2 | 7 | Alex
-
Delete the resources you created
Note
Before deleting the resources, deactivate the transfer.
Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need:
-
Bucket objects.
-
Delete other resources using the same method used for their creation:
ManuallyUsing Terraform-
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.
-
-