[Docs][Connector-V2] Improve Doris Iceberg StarRocks Paimon and Clickhouse connector docs - #2
Draft
DanielCarter-stack wants to merge 352 commits into
Draft
[Docs][Connector-V2] Improve Doris Iceberg StarRocks Paimon and Clickhouse connector docs#2DanielCarter-stack wants to merge 352 commits into
DanielCarter-stack wants to merge 352 commits into
Conversation
apache#11212) Co-authored-by: xuepeng <58297137+chl-wxp@users.noreply.github.com>
…he#11258) Co-authored-by: DanielLeens <DanielLeens@users.noreply.github.com>
Co-authored-by: DanielLeens <DanielLeens@users.noreply.github.com>
Co-authored-by: DanielLeens <DanielLeens@users.noreply.github.com>
Co-authored-by: DanielLeens <DanielLeens@users.noreply.github.com>
Co-authored-by: Shenghang <shenghang@apache.org> Co-authored-by: DanielCarter-stack <254644355+DanielCarter-stack@users.noreply.github.com> Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
…1284) Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com> Co-authored-by: Shenghang <shenghang@apache.org>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…nRule (apache#11225) Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…che#11292) Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
…11293) Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Signed-off-by: goutamadwant <workwithgoutam@gmail.com>
…10990) Co-authored-by: zengyi <zengyi@chinatelecom.cn>
…ink with multi-mapping support (apache#11413) Co-authored-by: ljx <17703949750@163.com> Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com> Co-authored-by: kl1l <Kayson.J.Liu@newegg.com> Co-authored-by: Cursor <cursoragent@cursor.com>
…me/delete (apache#11680) Co-authored-by: danielnadean <254814112+danielnadean@users.noreply.github.com> Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
Co-authored-by: zhangshenghang <zhangshenghang@users.noreply.github.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
…nal connector docs (apache#11699) Co-authored-by: DanielCarter-stack <DanielCarter-stack@users.noreply.github.com>
Co-authored-by: Srijan Singh <Srijan.Singh1@ibm.com>
Co-authored-by: danielnadean <254814112+danielnadean@users.noreply.github.com>
…beat slack (apache#11645) Co-authored-by: DanielLeens <vsantonastaso.dev@gmail.com>
Co-authored-by: DanielCarter-stack <danielcarter-stack@users.noreply.github.com>
…house connector docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the user-facing documentation for five V2 connectors: Doris, Iceberg, StarRocks, Paimon, and Clickhouse. Both the English (
docs/en) and Chinese (docs/zh) sources and sinks are updated.Highlights
Doris
### Case-Sensitive Configurationheading in the sink docs (both en/zh) that was swallowing the next heading inside the previous code block.Requiredflags forschema_save_modeanddata_save_modein the sink options table — both are factory-required, both were markedno.save_mode_create_templateplaceholder from the deprecated${table_name}to the canonical${table}, and documenttable_nameas the deprecated alias.default-databaseandmulti_table_sink_replicaoptions to the sink options table.needs_unsupported_type_castingto mention its catalog-pre-processing effect.database,table,doris.batch.size, andcase_sensitiveto the sourceBase configurationtable.Data Type Mapping.Multiple tablesection and add three new e2e-backed examples to the zh sink: CDC + Zeta timer flush, Custom SQL +save_mode_create_template, and Direct To BE + 2PC +table.identifier.Iceberg
[x] [support multiple table read]to the source feature list.[x] [exactly-once]to the sink feature list (sink relies onIcebergFilesCommittertwo-phase commit).catalog_name/namespacedefaults todefaultin both source and sink.table/table_listas mutually exclusive.table_list(namespace, query, snapshot/stream options).query(the literaltablerequirement was misleading).:→=syntax bug in the AWS S3 Tables REST catalog example in both en and zh.yes/no→是/否).Query Filter on a Single TableandQuery Filter per Table in table_list.StarRocks
[ ] [定时刷新]→[x] [定时刷新](Zeta supports timer flush and the rest of the zh page documents it).batch_max_rows/batch_max_bytestypes:batch_max_rowsisint(notlong),batch_max_bytesislong(notint), in both en and zh.table/table_listas mutually exclusive in source docs (en/zh).Paimon
[x] [parallelism](Paimon source supports parallel source splits) and[x] [support multiple table read]to the source feature list.databaserow from Required是/Yesto否/No(factory treats it as optional).paimon.hadoop.conftype label from[string]to[Map].## Changelogheading to## Reading Paimon Changelog(source) and## Changelog Producer(sink) so it no longer collides with the<ChangeLog />footer.multi_table_sink_replicaoption to the sink docs (en/zh).Clickhouse
hocon) and SQL tags (sql) to the multi-table sink example in both en and zh.parallelismcapability row to the en sink feature list (the connector uses the standard parallel sink writer).databaseoption to the source options table for the case where neithertable_listnorsqlspecifies one.Files touched
docs/en/connectors/source/{Clickhouse,Doris,Iceberg,Paimon,StarRocks}.mddocs/en/connectors/sink/{Clickhouse,Doris,Iceberg,Paimon,StarRocks}.mddocs/zh/connectors/source/{Clickhouse,Doris,Iceberg,Paimon,StarRocks}.mddocs/zh/connectors/sink/{Clickhouse,Doris,Iceberg,Paimon,StarRocks}.md20 files changed, 648 insertions(+), 177 deletions(-)