Saving a Yandex Data Streams data stream in Yandex Managed Service for ClickHouse®
With Data Transfer, you can deliver data from a data stream in Data Streams to Managed Service for ClickHouse®.
To transfer data:
If you no longer need the resources you created, delete them.
Required paid resources
The support cost includes:
-
Managed Service for ClickHouse® cluster fee: Using computing resources allocated to hosts (including ZooKeeper hosts) and disk space (see Managed Service for ClickHouse® pricing).
-
Fee for public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
-
Managed Service for YDB database fee. The charge depends on the usage mode:
- For the serverless mode, you pay for data operations and the amount of stored data.
- For the dedicated instance mode, you pay for the use of computing resources, dedicated DBs, and disk space.
Learn more about the Managed Service for YDB pricing plans here.
-
Data Streams fee, which depends on the pricing mode:
- Provisioned capacity pricing mode: You pay for the number of write units and resources allocated for data streaming.
- On-demand pricing mode:
-
If the DB operates in serverless mode, the data stream is charged according to the YDB serverless mode pricing policy.
-
If the DB operates in dedicated instance mode, the data stream is not charged separately (you only pay for the DB, see the pricing policy).
-
Learn more about the Data Streams pricing plans here.
-
Transfer fee: Using computing resources and the number of transferred data rows (see Data Transfer pricing).
Getting started
Set up your infrastructure:
-
Create a Managed Service for YDB database in any suitable configuration.
-
Create a Managed Service for ClickHouse® cluster in 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 having 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.editor
role. - Network.
- Subnet.
- Security group and rules required to connect to the Managed Service for ClickHouse® cluster from the internet.
- Managed Service for ClickHouse® target cluster.
- Target endpoint.
- Transfer.
-
Specify the following in
data-transfer-yds-mch.tf
:folder_id
: ID of the folder to host new resources.sa_name
: Name of the service account to use in endpoints.source_db_name
: Managed Service for YDB database name.target_db_name
: ClickHouse® database name.target_user
andtarget_password
: Username and password of the ClickHouse® database owner.transfer_enabled
: Set to0
to ensure that no transfer is created until you create a source endpoint manually.
-
Make sure the Terraform configuration files are correct using this command:
terraform validate
Terraform will show any errors found in your configuration files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform plan
If 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 data from the vehicle sensors in JSON format as a 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.editor
role.
-
Advanced settings:
- Conversion rules:
JSON
. - Data scheme: You can specify a schema in two ways:
-
Field list
.Set a list of topic fields manually:
Name Type Key device_id
STRING
Yes datetime
DATETIME
latitude
DOUBLE
longitude
DOUBLE
altitude
DOUBLE
speed
DOUBLE
battery_voltage
ANY
cabin_temperature
DOUBLE
fuel_level
ANY
-
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- Create a transfer of the Replication type that will use the created endpoints.
- Activate your transfer.
-
In the
data-transfer-yds-mch.tf
file, specify these variables:source_endpoint_id
: ID of the source endpoint.transfer_enabled
: Set to1
to create a transfer.
-
Make sure the Terraform configuration files are correct using this command:
terraform validate
Terraform will show any errors found in your configuration files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform plan
If 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.
-
Once created, your transfer is activated automatically.
-
Test your transfer
-
Wait for the transfer status to change to Replicating.
-
Send a new message to the data stream in Data Streams:
{ "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 the data from the stream in Data Streams has moved to the Managed Service for ClickHouse® cluster database:
- Connect to the Managed Service for ClickHouse® target cluster.
- Check that the ClickHouse® database contains a table with the same name as the created data stream in Data Streams and containing the same columns as the data schema in the source endpoint, along with the test data you sent.
Delete the resources you created
Note
Before deleting the resources you created, deactivate the transfer.
Some resources are not free of charge. To avoid unnecessary charges, delete the resources you no longer need:
-
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