Skip to content

[FLINK-20979][elasticsearch] Fix docs: use '-1' to disable bulk-flush options#140

Open
jlalwani-amazon wants to merge 1 commit into
apache:mainfrom
jlalwani-amazon:flink-20979-fix-docs
Open

[FLINK-20979][elasticsearch] Fix docs: use '-1' to disable bulk-flush options#140
jlalwani-amazon wants to merge 1 commit into
apache:mainfrom
jlalwani-amazon:flink-20979-fix-docs

Conversation

@jlalwani-amazon
Copy link
Copy Markdown
Contributor

What is the purpose of the change

Fix incorrect documentation for sink.bulk-flush.max-actions, sink.bulk-flush.max-size, and sink.bulk-flush.interval. The docs state that '0' disables these options, but the code validates maxActions == -1 || maxActions >= 1 — so '0' is invalid and '-1' is the correct disable value.

JIRA: FLINK-20979

Brief change log

  • Replace '0' with '-1' in the disable description for bulk-flush options (English and Chinese docs)

Does this pull request potentially affect one of the following parts?

  • Dependencies: no
  • The public API: no
  • The serializers: no
  • The runtime per-record code paths: no
  • Anything that affects deployment or recovery: no

… options

The documentation incorrectly states that '0' disables
sink.bulk-flush.max-actions, sink.bulk-flush.max-size, and
sink.bulk-flush.interval. The code validates maxActions == -1 || maxActions >= 1,
so '0' is actually invalid and '-1' is the correct disable value.

Updated both English and Chinese docs.
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented Apr 28, 2026

Thanks for opening this pull request! Please check out our contributing guidelines. (https://flink.apache.org/contributing/how-to-contribute.html)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant