[Feature] Add StarRocks Driver Support #8454

EdwardArchive · 2025-12-05T10:49:16Z

Issue : #6839
Related PR : #8390 (priveus)

PR: StarRocks OLAP Connector (Read-Only)

What is StarRocks

https://www.starrocks.io/ is an open-source, high-performance OLAP database designed for real-time analytics. It provides a MySQL-compatible interface with columnar storage
and vectorized query execution, making it ideal for large-scale data analytics workloads.

Summary

Add StarRocks as an OLAP connector to directly query existing StarRocks tables. This is a read-only OLAP connector - Model Execution is not supported.

Changes

1. Backend - StarRocks Driver (`runtime/drivers/starrocks/`) - 5 files

File	Status	Changes
`starrocks.go`	Added	Connection logic, database field optional, OLAP interface only
`olap.go`	Added	Query execution with fully qualified table names
`information_schema.go`	Added	Table/column metadata retrieval with catalog support
`utils.go`	Added	Utility functions for StarRocks-specific SQL
`starrocks_test.go`	Added	Test cases for connection and queries

2. Backend - Query Dialect Support (`runtime/queries/`) - 14 files

File	Status	Changes
`column_cardinality.go`	Modified	Added StarRocks dialect with `approx_count_distinct()`
`column_null_count.go`	Modified	Added StarRocks dialect support
`column_desc_stats.go`	Modified	Added StarRocks with `percentile_approx()`, `stddev_samp()`
`column_time_range.go`	Modified	Added StarRocks dialect support
`column_time_grain.go`	Modified	Added StarRocks-specific time functions
`column_topk.go`	Modified	Added StarRocks dialect support
`column_rug_histogram.go`	Modified	Returns empty result for StarRocks
`column_numeric_histogram.go`	Modified	Returns empty result for StarRocks
`column_timeseries.go`	Modified	Returns empty result for StarRocks (no TEMP TABLE)
`table_head.go`	Modified	Added StarRocks to `supportedTableHeadDialects`
`table_cardinality.go`	Modified	Added StarRocks dialect support
`sqlutil.go`	Modified	Added StarRocks to dialect utilities
`resource_watermark.go`	Modified	Added StarRocks dialect support

Query Support Summary:

Query	Status	Notes
TableHead, TableColumns, TableCardinality	Full
ColumnCardinality, ColumnNullCount, ColumnTopK	Full
ColumnDescriptiveStatistics	Full	`percentile_approx()`, `stddev_samp()`
ColumnTimeRange, ColumnTimeGrain	Full	StarRocks-specific SQL
ColumnRugHistogram, ColumnNumericHistogram	Empty	Performance issues
ColumnTimeseries	Empty	TEMP TABLE not supported

3. Backend - Other (`runtime/`, `cli/`) - 2 files

File	Status	Changes
`runtime/drivers/olap.go`	Modified	StarRocks dialect registration
`cli/cmd/runtime/start.go`	Modified	StarRocks driver initialization

4. Frontend (`web-common/`, `web-local/`) - 8 files

File	Status	Changes
`web-common/src/features/sources/modal/yupSchemas.ts`	Modified	Database field optional (matches backend)
`web-common/src/features/sources/modal/constants.ts`	Modified	StarRocks connector constants
`web-common/src/features/sources/modal/icons.ts`	Modified	StarRocks icon import
`web-common/src/features/connectors/connectors-utils.ts`	Modified	StarRocks connector utilities
`web-common/src/features/connectors/connector-icon-mapping.ts`	Modified	StarRocks icon mapping
`web-common/src/components/icons/connectors/StarRocks.svelte`	Added	StarRocks icon component
`web-common/src/components/icons/connectors/StarRocksIcon.svelte`	Added	StarRocks icon variant
`web-local/src/routes/.../connector/starrocks/[name]/[database]/[schema]/[table]/+page.svelte`	Added	StarRocks table page
`web-local/src/routes/.../connector/starrocks/+page.ts`	Added	StarRocks connector page route

5. Documentation - 1 file

File	Status	Changes
`docs/docs/build/connectors/olap/starrocks.md`	Added	StarRocks OLAP connector documentation

StarRocks Naming Mapping

Rill API Parameter	StarRocks Concept	Example
`database`	Catalog	`default_catalog`, `iceberg_catalog`
`databaseSchema`	Database	`tpcds_100gb`, `my_database`
`table`	Table	`store_sales`, `customer`

Tested

Connection: default_catalog, external catalogs (Iceberg/Hive), DSN format
Table browsing: list tables, preview data, column metadata
Profiling: cardinality, null count, statistics, TopK, time range/grain
UI: connector modal, optional database field, table preview

Known Limitations

No Model Execution: Read-only OLAP connector only
No Histogram: Returns empty results due to performance issues
No Timeseries: Returns empty results (TEMP TABLE not supported)
MySQL Protocol: Uses StarRocks MySQL-compatible protocol (port 9030)
default_catalog on DSN : MySQL don't have Catalog

EdwardArchive · 2025-12-05T13:55:57Z

I just working on it find some edge case

- Add StarRocks support for ColumnRugHistogram with generate_series() - Add StarRocks support for ColumnNumericHistogram (FD & Diagnostic methods) - Add CTE-based ColumnTimeseries for StarRocks (no TEMP TABLE required) - Add helper functions: rangeNumbersEnd(), isNonNullFinite() for StarRocks - Handle reserved keywords (values, range) with backtick escaping

…alect

…ndling, connection timeouts, and error messages

EdwardArchive · 2025-12-07T13:15:04Z

@k-anshul
Hi, Can you help review this change so we can move it forward?

runtime/drivers/olap.go

runtime/queries/column_cardinality.go

runtime/queries/column_numeric_histogram.go

runtime/drivers/starrocks/olap.go

runtime/queries/column_time_range.go

runtime/metricsview/executor/executor_validate.go

runtime/drivers/starrocks/utils.go

EdwardArchive · 2025-12-08T07:45:25Z

Thank you for the Hard works!
I'll fixed it

k-anshul · 2025-12-08T09:16:33Z

Also tagging @ericpgreen2 for review on frontend changes.

- addressed multiple review comments - cleaned up import and minor issues

- Remove unused 'strings' import from starrocks.go - Fix undefined variable 't' in olap.go StarRocks case - Update date_trunc comment to reference validation location

…tarRocks dialect

…lorer - Fix build compilation errors - Ensure selected catalog (Database), schema (DatabaseSchema), and table are properly propagated when creating metrics from Data Explorer

EdwardArchive · 2025-12-09T01:43:10Z

Hi @k-anshul,

Thank you so much for taking the time to review my code — I really appreciate it, especially since it was likely during the weekend or early morning hours.

I've addressed all of your review comments. Please let me know if you have any questions or concerns.

Have a great day!

runtime/drivers/starrocks/information_schema.go

runtime/drivers/starrocks/olap.go

runtime/drivers/starrocks/starrocks.go

runtime/queries/column_desc_stats.go

runtime/queries/column_null_count.go

runtime/queries/column_numeric_histogram.go

runtime/metricsview/executor/executor_validate.go

k-anshul · 2025-12-09T06:45:31Z

Hey @EdwardArchive

Thanks for your work here. I added some more comments. Mostly should be minor.
Please also take a look at the failing checks.

EdwardArchive · 2025-12-09T10:19:02Z

Hey @EdwardArchive

Thanks for your work here. I added some more comments. Mostly should be minor. Please also take a look at the failing checks.

Hey @k-anshul
I'll take care of this. thanks again.

…d rug histograms + build check

…omponent

EdwardArchive · 2025-12-09T14:27:39Z

Hey @k-anshul,
I’ve made a number of the changes you suggested. Please review when you get a chance.

k-anshul · 2025-12-10T06:51:39Z

Hey @EdwardArchive

Please also fix the failing checks.

EdwardArchive · 2025-12-10T20:17:20Z

Hi sorry for late, I just fix the failing checks.

k-anshul · 2025-12-11T05:17:27Z

Hey

Thanks @EdwardArchive
The backend changes looks good to me. Please take a look at the failing test(TestConfigPropertiesValidate/both_dsn_and_host ) and Web code quality checks action.

Eric is going to take a look at UI changes as soon as he gets some bandwidth.

EdwardArchive · 2025-12-11T07:28:16Z

Hey @k-anshul

Thanks for the hard work again.
good, I'll wait for the Eric's review

Thanks again,
Have a great day!

ericpgreen2 · 2025-12-12T21:22:09Z

@lovincyrus, given your ownership of the connector forms, can you please do the first frontend reviews of this code? For now, I've removed myself as reviewer and tagged you. Once the PR has your sign-off, then please request a review from me and I'll do a final review. Thank you!

EdwardArchive added 2 commits December 3, 2025 19:58

only olap connector(not incloud model)

fbde1a6

fix : message "not available for dialect 'starrocks'" & starrocks icon

ad513a0

EdwardArchive mentioned this pull request Dec 5, 2025

Add StarRocks Driver Support #8390

Closed

EdwardArchive added 4 commits December 5, 2025 23:07

feat(starrocks): add support for resolving timestamps in StarRocks di…

692f7c6

…alect

feat(starrocks): enhance StarRocks connector with improved context ha…

4c09870

…ndling, connection timeouts, and error messages

feat(starrocks): add StarRocks form and error handling to AddDataForm

c47dbd9

Update docs

0a3dbc5

k-anshul requested changes Dec 8, 2025

View reviewed changes

k-anshul requested a review from ericpgreen2 December 8, 2025 09:16

EdwardArchive added 9 commits December 8, 2025 21:22

fix: update code based on PR review feedback

ed2301b

- addressed multiple review comments - cleaned up import and minor issues

fix: apply fixes from PR comments

ffdce1b

fix: resolve build errors

948fa2a

- Remove unused 'strings' import from starrocks.go - Fix undefined variable 't' in olap.go StarRocks case - Update date_trunc comment to reference validation location

fix: update reserved keyword handling and SQL name sanitization for S…

4de5c64

…tarRocks dialect

fix: improve dry run handling in Query method and simplify SQL min query

2987351

fix: correct safeName call in Druid maxSQL query

003001e

fix: use equality check instead of Before for StarRocks time range bins

ae95f12

fix: resolve build errors and metrics context propagation in Data Exp…

436fa8c

…lorer - Fix build compilation errors - Ensure selected catalog (Database), schema (DatabaseSchema), and table are properly propagated when creating metrics from Data Explorer

change test code and fix on AddStarRocksFrom

b83c569

EdwardArchive requested a review from k-anshul December 9, 2025 01:43

k-anshul requested changes Dec 9, 2025

View reviewed changes

EdwardArchive added 2 commits December 9, 2025 19:53

Apply minor fixes from code review comments

f4cd71f

Refactor: removed unused code as suggested by Git CI

0d75a03

EdwardArchive added 5 commits December 9, 2025 20:19

fix: Add only for the StarRocks compatibility by executor part

60c6614

fix change c.getDB to c.db

6cd5488

fix: simplify database connection retrieval in StarRocks driver

11db47c

fix: update column handling for StarRocks compatibility in numeric an…

193ba9c

…d rug histograms + build check

feat: enhance error handling and form structure in AddStarRocksForm c…

3bec873

…omponent

EdwardArchive requested a review from k-anshul December 9, 2025 14:26

fix the failing checks.

3f61433

fix the failing checks 2

cae1bdf

ericpgreen2 requested review from lovincyrus and removed request for ericpgreen2 December 12, 2025 21:22

[Feature] Add StarRocks Driver Support #8454

Are you sure you want to change the base?

[Feature] Add StarRocks Driver Support #8454

Uh oh!

Conversation

EdwardArchive commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR: StarRocks OLAP Connector (Read-Only)

What is StarRocks

Summary

Changes

1. Backend - StarRocks Driver (runtime/drivers/starrocks/) - 5 files

2. Backend - Query Dialect Support (runtime/queries/) - 14 files

3. Backend - Other (runtime/, cli/) - 2 files

4. Frontend (web-common/, web-local/) - 8 files

5. Documentation - 1 file

StarRocks Naming Mapping

Tested

Known Limitations

Uh oh!

EdwardArchive commented Dec 5, 2025

Uh oh!

EdwardArchive commented Dec 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

EdwardArchive commented Dec 8, 2025

Uh oh!

k-anshul commented Dec 8, 2025

Uh oh!

EdwardArchive commented Dec 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

k-anshul commented Dec 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

EdwardArchive commented Dec 9, 2025

Uh oh!

EdwardArchive commented Dec 9, 2025

Uh oh!

k-anshul commented Dec 10, 2025

Uh oh!

EdwardArchive commented Dec 10, 2025

Uh oh!

k-anshul commented Dec 11, 2025

Uh oh!

EdwardArchive commented Dec 11, 2025

Uh oh!

ericpgreen2 commented Dec 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

EdwardArchive commented Dec 5, 2025 •

edited

Loading

1. Backend - StarRocks Driver (`runtime/drivers/starrocks/`) - 5 files

2. Backend - Query Dialect Support (`runtime/queries/`) - 14 files

3. Backend - Other (`runtime/`, `cli/`) - 2 files

4. Frontend (`web-common/`, `web-local/`) - 8 files

k-anshul commented Dec 9, 2025 •

edited

Loading

ericpgreen2 commented Dec 12, 2025 •

edited

Loading