Skip to main content
Version: 2.3.0

StarRocks

StarRocks sink connector

Description

Used to send data to StarRocks. Both support streaming and batch mode. The internal implementation of StarRocks sink connector is cached and imported by stream load in batches.

Key features

Options

nametyperequireddefault value
node_urlslistyes-
usernamestringyes-
passwordstringyes-
databasestringyes-
tablestringyes-
labelPrefixstringno-
batch_max_rowslongno1024
batch_max_bytesintno5 1024 1024
batch_interval_msintno-
max_retriesintno-
retry_backoff_multiplier_msintno-
max_retry_backoff_msintno-
sink.properties.*starrocks stream load configno-

node_urls [list]

StarRocks cluster address, the format is ["fe_ip:fe_http_port", ...]

username [string]

StarRocks user username

password [string]

StarRocks user password

database [string]

The name of StarRocks database

table [string]

The name of StarRocks table

labelPrefix [string]

The prefix of StarRocks stream load label

batch_max_rows [long]

For batch writing, when the number of buffers reaches the number of batch_max_rows or the byte size of batch_max_bytes or the time reaches batch_interval_ms, the data will be flushed into the StarRocks

batch_max_bytes [int]

For batch writing, when the number of buffers reaches the number of batch_max_rows or the byte size of batch_max_bytes or the time reaches batch_interval_ms, the data will be flushed into the StarRocks

batch_interval_ms [int]

For batch writing, when the number of buffers reaches the number of batch_max_rows or the byte size of batch_max_bytes or the time reaches batch_interval_ms, the data will be flushed into the StarRocks

max_retries [int]

The number of retries to flush failed

retry_backoff_multiplier_ms [int]

Using as a multiplier for generating the next delay for backoff

max_retry_backoff_ms [int]

The amount of time to wait before attempting to retry a request to StarRocks

sink.properties.* [starrocks stream load config]

The parameter of the stream load data_desc The way to specify the parameter is to add the prefix sink.properties. to the original stream load parameter name For example, the way to specify strip_outer_array is: sink.properties.strip_outer_array

Supported import data formats

The supported formats include CSV and JSON. Default value: CSV

Example

Use JSON format to import data

sink {
StarRocks {
nodeUrls = ["e2e_starRocksdb:8030"]
username = root
password = ""
database = "test"
table = "e2e_table_sink"
batch_max_rows = 10
sink.properties.format = "JSON"
sink.properties.strip_outer_array = true
}
}

Use CSV format to import data

sink {
StarRocks {
nodeUrls = ["e2e_starRocksdb:8030"]
username = root
password = ""
database = "test"
table = "e2e_table_sink"
batch_max_rows = 10
sink.properties.format = "CSV"
sink.properties.column_separator = "\x01"
sink.properties.row_delimiter = "\x02"
}
}

Changelog

2.3.0 2022-12-30

  • Add StarRocks Sink Connector