Importing data from Yandex Object Storage, processing and exporting to Yandex Managed Service for ClickHouse®
|
This tutorial is based on a Data Stories |
|
In this example, we use two CSV tables which we will merge into a single one, import it to Parquet format, and transfer to Managed Service for ClickHouse®.
Required paid resources
The support cost for this solution includes:
- Managed Service for ClickHouse® cluster fee: Covers the use of computational resources allocated to hosts (including ZooKeeper hosts) and disk storage (see Managed Service for ClickHouse® pricing).
- Yandex Data Processing cluster fee: Covers the use of VM computing resources, Compute Cloud network disks, and Cloud Logging for log management (see Yandex Data Processing pricing).
- Fee for public IP address assignment on cluster hosts (see Virtual Private Cloud pricing).
- Object Storage bucket fee: storing data and performing operations with it (see Object Storage pricing).
- Fee for a NAT gateway (see Virtual Private Cloud pricing).
Getting started
Set up the infrastructure:
-
Create a service account named
dataproc-s3-saand assign thedataproc.agentanddataproc.provisionerroles to it. -
In Object Storage, create buckets and configure access to them:
- Create a bucket for the input data and grant the
READpermission for this bucket to the cluster service account. - Create a bucket for the processing output and grant the cluster service account
READ and WRITEpermissions for this bucket.
- Create a bucket for the input data and grant the
-
Create a cloud network named
dataproc-network. -
Within the
dataproc-network, create a subnet in any availability zone. -
Set up a NAT gateway for your new subnet.
-
In
dataproc-network, create a security group nameddataproc-sgand add the following rules to it:-
One inbound and one outbound rule for service traffic:
- Port range:
0-65535. - Protocol:
Any(Any). - Source/Destination name:
Security group. - Security group:
Current(Self).
- Port range:
-
Rule for outgoing HTTPS traffic:
- Port range:
443. - Protocol:
TCP. - Destination name:
CIDR. - CIDR blocks:
0.0.0.0/0.
- Port range:
-
Egress rule to allow TCP access to ClickHouse® on port 8443:
- Port range:
8443. - Protocol:
TCP. - Destination name:
CIDR. - CIDR blocks:
0.0.0.0/0.
- Port range:
-
-
Create a Yandex Data Processing cluster with the host configuration of your choice and the following settings:
- Environment:
PRODUCTION. - Services:
SPARKYARNHDFS
- Service account:
dataproc-sa. - Bucket name: Bucket you created for the output data.
- Network:
dataproc-network. - Security groups:
dataproc-sg. - UI Proxy: Enabled.
- Environment:
-
Create a Managed Service for ClickHouse® cluster of any suitable configuration and the following settings:
- Public access to cluster hosts: Enabled.
- DB name:
db1. - Username:
user1.
-
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 s3-dataproc-ch.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- NAT gateway and route table for Yandex Data Processing.
- Security groups for the Yandex Data Processing and Managed Service for ClickHouse® clusters.
- Service account for the Yandex Data Processing cluster.
- Service account required to create buckets in Object Storage.
- Buckets for input and output data.
- Yandex Data Processing cluster.
- Managed Service for ClickHouse® cluster.
-
In the
s3-dataproc-ch.tffile, specify the following:folder_id: Cloud folder ID matching the one in your provider settings.input-bucket: Name of the input data bucket.output-bucket: Output data bucket name.dp_ssh_key: Absolute path to the public key for the Yandex Data Processing cluster. Learn more about connecting to a Yandex Data Processing host over SSH here.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
In this example, we use the following two CSV tables:
coords.csvwith vehicle geographic coordinates.sensors.csvwith information about speed and other vehicle operating parameters.
To prepare the test data:
-
Copy the contents of the sample files below and save them locally in CSV format:
-
coords.csv
vehicle_id,latitude,longitude,altitude iv9a94th6rztooxh5ur2,55.70329032,37.65472196,427.5 022wsiz48h2ljxuz04x8,56.96149325,38.46541766,423.6 a7fbbqjws4zqw85f6jue,54.99296663,36.79063999,426.2 l7731117m6r6on4m633n,55.34740545,37.13175678,422.5 6f9q6ienc4qfpdwd9nef,56.69752218,38.38871530,428.3 -
sensors.csv
vehicle_id,speed,battery_voltage,cabin_temperature,fuel_level iv9a94th6rztooxh5ur2,0.0,25.5,17,5 022wsiz48h2ljxuz04x8,55.5,54.5,21,22 a7fbbqjws4zqw85f6jue,80.6,22.1,19,73 l7731117m6r6on4m633n,40.9,76.0,25,23 6f9q6ienc4qfpdwd9nef,64.8,90.8,21,32
-
-
Create a folder named
csvin the input bucket and upload the new CSV files to it.
Process your data in Yandex Data Processing
Merge the data from the two tables into one and upload it in Parquet format to the bucket you previously created for processing results:
-
Prepare a script file:
-
Create a local file named
join-tables.pyand paste the following script to it:join-tables.py
from pyspark.sql import SparkSession # Creating a Spark session spark = SparkSession.builder.appName("JoinExample").getOrCreate() # Reading a table from coords.csv coords_df = spark.read.csv("s3a://<input_bucket_name>/csv/coords.csv", header=True) # Reading a table from sensors.csv sensors_df = spark.read.csv("s3a://<input_bucket_name>/csv/sensors.csv", header=True) # Joining tables by the vehicle_id column joined_df = coords_df.join(sensors_df, on="vehicle_id", how="inner") # Saving the joined table to a bucket in Parquet format joined_df.write.parquet("s3a://<output_bucket_name>/parquet/") -
In your script, specify the following:
- Name of the input bucket that stores the original CSV tables.
- Name of the output bucket where the Parquet file with the merged data will be saved.
-
In the input bucket, create a folder named
scriptsand upload thejoin-tables.pyfile to it.
-
-
Create a PySpark job by specifying the path to the script file in the Main python file field:
s3a://<input_bucket_name>/scripts/join-tables.py. -
Wait for the job to complete and check that the output bucket's
parquetfolder contains thepart-00000-***Parquet file.
Note
You can view the job logs and search data in them using Yandex Cloud Logging. For more information, see Working with logs.
Export your data to ClickHouse®
Transfer the joined table from Object Storage to ClickHouse®:
-
Prepare a script file:
-
Create a local file named
parquet-to-ch.pyand paste the following script to it:parquet-to-ch.py
from pyspark.sql import SparkSession # Creating a Spark session spark = SparkSession.builder.appName("ParquetClickhouse").getOrCreate() # Reading data from a Parquet file parquetFile = spark.read.parquet("s3a://<output_bucket_name>/parquet/*.parquet") # Specifying the port and ClickHouse® cluster parameters jdbcPort = 8443 jdbcHostname = "c-<cluster_ID>.rw.mdb.yandexcloud.net" jdbcDatabase = "db1" jdbcUrl = f"jdbc:clickhouse://{jdbcHostname}:{jdbcPort}/{jdbcDatabase}?ssl=true" # Transferring a table from a Parquet file to a ClickHouse® table named `measurements` parquetFile.write.format("jdbc") \ .mode("error") \ .option("url", jdbcUrl) \ .option("dbtable", "measurements") \ .option("createTableOptions", "ENGINE = MergeTree() ORDER BY vehicle_id") \ .option("user","user1") \ .option("password","<ClickHouse®_user_password>") \ .save() -
In your script, specify the following:
- Name of the bucket with the Parquet file.
- Managed Service for ClickHouse® cluster ID.
- ClickHouse® user password.
-
Upload the
parquet-to-ch.pyfile to the input data bucket’sscriptsfolder.
-
-
Create a PySpark job by specifying the path to the script file in the Main python file field:
s3a://<input_bucket_name>/scripts/parquet-to-ch.py. -
Wait for the job to complete and make sure the joined table has been moved to the cluster:
-
Connect to the
db1database in the Managed Service for ClickHouse® cluster asuser1. -
Run this query:
SELECT * FROM measurements;
If the data export is successful, the response will contain the joined table.
-
Delete the resources you created
Some resources incur charges. To avoid unnecessary expenses, delete the resources you no longer need:
-
Delete all objects from the buckets.
-
Delete other resources using the method matching their creation method:
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
