Skip to content

[FLINK-40514][docs][pipeline-connector/doris] Align Doris pipeline connector option table with implementation - #4561

Merged
yuxiqian merged 1 commit into
apache:masterfrom
suntectec:FLINK-40514
Sep 28, 2026
Merged

yuxiqian merged 1 commit into
apache:masterfrom
suntectec:FLINK-40514

Conversation

@suntectec

Copy link
Copy Markdown
Contributor

What is the purpose of this pull request?

This is a docs-only fix for FLINK-40514. The Doris pipeline connector option table has drifted from the implementation in both the English and the Chinese docs, so users reading it would get the wrong types and defaults, and six supported options were not documented at all.

Brief change log

  • auto-redirect: documented as String, but declared as booleanType() in DorisDataSinkOptions. Corrected to Boolean.
  • charset-encoding: documented as Boolean with default false, but declared as stringType() with default "UTF-8". Corrected both the type and the default.
  • Removed the leftover Java string concatenation (\n" + ") that leaked into the English sink.ignore.update-before description.
  • Documented the six options declared in DorisDataSinkFactory#optionalOptions() but missing from the table: sink.enable-2pc, sink.check-interval, sink.buffer-size, sink.buffer-count, sink.label-prefix and sink.use-cache. The new rows are appended at the end of the sink.* group, and their descriptions are copied from the corresponding ConfigOption descriptions.
  • Updated both docs/content/docs/connectors/pipeline-connectors/doris.md and docs/content.zh/docs/connectors/pipeline-connectors/doris.md.

No code change is involved. Existing option descriptions were intentionally left untouched so that this change stays limited to the inaccuracies reported in the JIRA issue.

Verifying this change

This change is a trivial rework / code cleanup without any test coverage.

The tables were cross-checked against the code: every ConfigOption declared in DorisDataSinkOptions now appears in the option table of both documents, and the only remaining doc entries that have no ConfigOption counterpart are the pipeline-level type / name rows and the sink.properties.* / table.create.* prefix rows.

Documentation

  • Does this pull request introduce a new feature? (no)

Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Generated-by: Qoder 1.32.0

@github-actions github-actions Bot added the docs Improvements or additions to documentation label Sep 26, 2026

@yuxiqian yuxiqian left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you for the nice work!

@yuxiqian
yuxiqian merged commit 7963bea into apache:master Sep 28, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants