Realtime Compute for Apache Flink:Manage StarRocks catalogs

Create a StarRocks catalog on the console

1. Log on to the Realtime Compute for Apache Flink console. Find the workspace you want to manage and click Console in the Actions column.

2. In the left-side navigation pane, click Catalogs.

3. On the Catalog List page, click Create Catalog. In the Create Catalog wizard, select StarRocks on the Built-in Catalog tab and click Next.

4. Configure the catalog parameters.

   Important

   StarRocks catalog configurations cannot be modified after creation. To change any setting, drop the existing catalog and create a new one.

   Parameter	Description	Required	Notes
   catalog name	Name of the StarRocks catalog.	Yes	Lowercase letters and digits only. Hyphens (-), underscores (_), and uppercase letters are not allowed.
   endpoint	Endpoint of a FrontEnd (FE) node.	Yes	Format: jdbc:mysql://ip:port. The default JDBC port is 9030.
   dbname	Default StarRocks database to connect to.	Yes	—
   username	Username for accessing StarRocks.	Yes	—
   password	Password for accessing StarRocks.	Yes	Use a variable instead of a plaintext password to avoid credential exposure. See Manage variables.

   

5. Click Confirm.

The catalog appears on the Catalog List page.

Create a StarRocks catalog using Flink SQL

In the SQL editor on the Scripts page, enter a CREATE CATALOG statement, select the statement, and click Run on the left side.

CREATE CATALOG <catalogname> WITH (
  'type' = 'starrocks',
  'endpoint' = '<ip>:<port>',
  'username' = '<userName>',
  'password' = '<password>',
  'dbname' = '<dbname>'
);

The configuration options differ depending on your VVR version.

Read data from a StarRocks table

INSERT INTO ${other_sink_table}
SELECT ...
FROM `${catalog_name}`.`${db_name}`.`${table_name}`

INSERT INTO ${other_sink_table}
SELECT ...
FROM `${catalog_name}`.`${db_name}`.`${table_name}`
    /*+
        OPTIONS('connector' = 'starrocks', 'jdbc-url' = 'jdbc:mysql://ip:port', 'scan-url' = 'ip:port')
    */

Write data to a StarRocks table

INSERT INTO `${catalog_name}`.`${db_name}`.`${table_name}`
SELECT ...
FROM ${other_source_table}

INSERT INTO `${catalog_name}`.`${db_name}`.`${table_name}`
    /*+
        OPTIONS('connector' = 'starrocks', 'jdbc-url' = 'jdbc:mysql://ip:port', 'load-url' = 'ip:port', 'sink.buffer-flush.interval-ms' = '5000', 'sink.properties.row_delimiter' = '\x02', 'sink.properties.column_separator' = '\x01')
    */
SELECT ...
FROM ${other_source_table}

Use CTAS or CDAS to write to StarRocks

CTAS (CREATE TABLE AS SELECT) and CDAS (CREATE DATABASE AS DATABASE) let you create StarRocks tables or databases from existing sources in a single statement.

USE CATALOG sr_catalog;

CREATE TABLE IF NOT EXISTS `${table_name}`
WITH (
  ...
) AS TABLE ${other_source_table};


CREATE DATABASE IF NOT EXISTS `${db_name}`
WITH (
  ...
) AS DATABASE ${other_source_database};

For a complete walkthrough, see Ingest data from MySQL to StarRocks with Flink.

Drop a StarRocks catalog on the console

1. Log on to the Realtime Compute for Apache Flink console. Find the workspace you want and click Console in the Actions column.

2. In the left-side navigation pane, click Catalogs.

3. On the Catalog List page, find the catalog and click Delete in the Actions column.

4. In the confirmation dialog, click Delete.

The catalog is removed from the Catalogs pane in the left-side navigation.

Drop a StarRocks catalog using Flink SQL

In the SQL editor on the Scripts page, enter the following statement, right-click it, and select Run.

DROP CATALOG `<catalog name>`;

Replace <catalog name> with the name of the catalog you want to drop.

After the statement runs, verify the catalog is removed by checking the Catalogs pane in the left-side navigation.