Skip to main content
StarRocks is an open-source, massively parallel processing (MPP) database. For details on how to get started with StarRocks, see the Quick start guide. The StarRocks stream load does not support sinking struct type.

​
Prerequisites

Before sinking data from RisingWave to StarRocks, please ensure the following:
  • The StarRocks database you want to sink to is accessible from RisingWave.
  • Ensure you have an upstream materialized view or source in RisingWave that you can sink data from.

​
Syntax

CREATE SINK [ IF NOT EXISTS ] sink_name
[FROM sink_from | AS select_query]
WITH (
   connector='starrocks',
   connector_parameter = 'value', ...
);

​
Parameters

All parameters are required unless specified otherwise.
Parameter namesDescription
starrocks.hostThe StarRocks host address.
starrocks.query_portThe port to the MySQL server of the StarRocks frontend.
starrocks.http_portThe port to the HTTP server of the StarRocks frontend.
starrocks.userThe user name used to access the StarRocks database.
starrocks.passwordThe password associated with the user.
starrocks.databaseThe StarRocks database where the target table is located
starrocks.tableThe StarRocks table you want to sink data to.
starrocks.partial_updateOptional. Set it to true to improve performance when you need to update many rows but only change a few columns in each row.
typeData format. Allowed formats:
  • append-only: Output data with insert operations.
  • upsert: Output data as a chagelog stream. In StarRocks, Primary Key table must be selected.
force_append_onlyIf true, forces the sink to be append-only, even if it cannot be.
primary_keyRequired if type is upsert. The primary key of the downstream table.
commit_checkpoint_intervalOptional. Commit every N checkpoints (N > 0). Default value is 10. The behavior of this field also depends on the sink_decouple setting:
  • If sink_decouple is true (the default), the default value of commit_checkpoint_interval is 10.
  • If sink_decouple is set to false, the default value of commit_checkpoint_interval is 1.
  • If sink_decouple is set to false and commit_checkpoint_interval is set to larger than 1, an error will occur.

​
Examples

Assume we have a materialized view, bhv_mv. 
CREATE SINK bhv_starrocks_sink
FROM bhv_mv WITH (
    connector = 'starrocks',
    type = 'append-only',
    starrocks.host = 'starrocks-fe',
    starrocks.mysqlport = '9030',
    starrocks.httpport = '8030',
    starrocks.user = 'users',
    starrocks.password = '123456',
    starrocks.database = 'demo',
    starrocks.table = 'demo_bhv_table',
    force_append_only='true'
);

​
Data type mapping

The following table shows the corresponding data type in RisingWave that should be specified when creating a sink. For details on native RisingWave data types, see Overview of data types.
StarRocks typeRisingWave type
BOOLEANBOOLEAN
SMALLINTSMALLINT
INTINTEGER
BIGINTBIGINT
FLOATREAL
DOUBLEDOUBLE
DECIMALDECIMAL
DATEDATE
VARCHARVARCHAR
No supportTIME
DATETIMETIMESTAMP WITHOUT TIME ZONE
No supportTIMESTAMP WITH TIME ZONE（Can be converted to timestamp in RisingWave then sinked into StarRocks ）
No supportINTERVAL
No supportSTRUCT
ARRAYARRAY
No supportBYTEA
JSONJSONB
BIGINTSERIAL
If a decimal value is out of bounds or represents inf, -inf, or nan, RisingWave will insert null values.
⌘I