Delivering data from a YDS queue to ClickHouse®
Data Transfer enables you to deliver data from a Data Streams stream to Managed Service for ClickHouse®.
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 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, storage size, and backups.
-
Data Streams (see Data Streams pricing). 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.
-
Managed Service for ClickHouse® cluster: Use of 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).
-
Each transfer: Use of computing resources and number of transferred data rows (see Data Transfer pricing).
Getting started
Set up the infrastructure:
-
Create a Managed Service for YDB database with your preferred configuration.
-
Create a Managed Service for ClickHouse® cluster with any suitable configuration.
-
-
Database type:
ClickHouse. -
Endpoint parameters:
-
Connection settings:
-
Connection type:
Managed cluster.- Managed cluster: Select the source cluster from the list.
-
Database: Enter the database name.
-
User and Password: Enter the name and password of the user who has access to the database, e.g., the database owner.
-
-
-
-
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 data-transfer-yds-mch.tf
configuration file to the same working directory.This file describes:
- Managed Service for YDB database.
- Service account with the
yds.editorrole. - Network.
- Subnet.
- Security group and rules for internet access to the Managed Service for ClickHouse® cluster.
- Managed Service for ClickHouse® target cluster.
- Target endpoint.
- Transfer.
-
In the
data-transfer-yds-mch.tffile, specify the following:folder_id: ID of the folder for the new resources.sa_name: Service account name for endpoints.source_db_name: Managed Service for YDB database name.target_db_name: ClickHouse® database name.target_userandtarget_password: ClickHouse® database owner username and password.transfer_enabled: Set to0to postpone transfer creation until you manually set up a source endpoint.
-
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
. -
Set up a data stream in Data Streams
- Create a data stream in Data Streams.
- Send test data to this stream. Use the vehicle sensor data in JSON format as the message:
{
"device_id":"iv9a94th6rzt********",
"datetime":"2022-06-05 17:27:00",
"latitude":55.70329032,
"longitude":37.65472196,
"altitude":427.5,
"speed":0,
"battery_voltage":"23.5",
"cabin_temperature":17,
"fuel_level":null
}
Set up and activate the transfer
Note
To rapidly deliver a large volume of data, use special endpoint settings.
-
-
Database type:
Yandex Data Streams. -
Endpoint settings:
-
Connection settings:
- Database: Select the Managed Service for YDB database from the list.
- Stream: Specify the name of the stream in Data Streams.
- Service account: Select or create a service account with the
yds.editorrole.
-
Advanced settings:
- Conversion rules:
JSON. - Data scheme: You can specify a schema using one of these two methods:
-
Field list.Set a list of topic fields manually:
Name Type Key device_idSTRINGYes datetimeDATETIMElatitudeDOUBLElongitudeDOUBLEaltitudeDOUBLEspeedDOUBLEbattery_voltageANYcabin_temperatureDOUBLEfuel_levelANY -
JSON specification.Create and upload a data schema file in JSON format,
json_schema.json:json_schema.json
[ { "name": "device_id", "type": "string", "key": true }, { "name": "datetime", "type": "datetime" }, { "name": "latitude", "type": "double" }, { "name": "longitude", "type": "double" }, { "name": "altitude", "type": "double" }, { "name": "speed", "type": "double" }, { "name": "battery_voltage", "type": "any" }, { "name": "cabin_temperature", "type": "double" }, { "name": "fuel_level", "type": "any" } ]
-
- Conversion rules:
-
-
-
Create a transfer:
ManuallyTerraform-
In the
data-transfer-yds-mch.tffile, specify the following variables:source_endpoint_id: ID of the source endpoint.transfer_enabled:1to create a transfer.
-
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 activate automatically upon creation.
-
-
Test the transfer
-
Wait for the transfer status to change to Replicating.
-
Send a new message to the Data Streams data stream:
{ "device_id":"rhibbh3y08qm********", "datetime":"2022-06-06 09:49:54", "latitude":55.71294467, "longitude":37.66542005, "altitude":429.13, "speed":55.5, "battery_voltage":null, "cabin_temperature":18, "fuel_level":32 } -
Make sure that the Data Streams stream data has been transferred to the Managed Service for ClickHouse® cluster database:
- Connect to the Managed Service for ClickHouse® target cluster.
- Check that the ClickHouse® database now contains a table named after the Data Streams data stream. The table must have columns matching the source endpoint’s data schema and must include the test data that you sent.
Delete the resources you created
Note
Before deleting the resources, deactivate the transfer.
To reduce the consumption of resources you do not need, delete them:
-
Delete the resources depending on how you created them:
ManuallyTerraform-
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