Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix default value of poll.interval.ms in MongoDB connector docs #6068

Merged
merged 1 commit into from
Jan 2, 2025

Conversation

DominiQN
Copy link

@DominiQN DominiQN commented Dec 24, 2024

The default value of poll.interval.ms is incorrectly documented as 1000ms in some parts of the documentation.

According to the source code and description, the correct default value is 500ms.

public static final Field POLL_INTERVAL_MS = Field.create("poll.interval.ms")
.withDisplayName("Poll interval (ms)")
.withType(Type.LONG)
.withGroup(Field.createGroupEntry(Field.Group.ADVANCED, 17))
.withWidth(Width.SHORT)
.withImportance(Importance.MEDIUM)
.withDescription("Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms.")
.withDefault(DEFAULT_POLL_INTERVAL_MILLIS)
.withValidation(Field::isPositiveInteger);

public static final long DEFAULT_POLL_INTERVAL_MILLIS = 500;

image

@mfvitale
Copy link
Member

mfvitale commented Jan 2, 2025

Hi @DominiQN thanks for spotting this. Can you please prefix your commit with [docs]?

…ocumentation

The default value of `poll.interval.ms` is incorrectly documented as 1000ms in some parts of the documentation.
According to the source code (https://github.com/debezium/debezium/blob/6246808308200ae9877f25f3a04e378578def98c/debezium-core/src/main/java/io/debezium/config/CommonConnectorConfig.java#L642-L650), the correct default value is 500ms.
@DominiQN
Copy link
Author

DominiQN commented Jan 2, 2025

Hi @mfvitale, I’ve updated the commit message. Thank you!

@mfvitale mfvitale merged commit b1665bd into debezium:3.0 Jan 2, 2025
@mfvitale
Copy link
Member

mfvitale commented Jan 2, 2025

@DominiQN, applied. Thanks!

@DominiQN DominiQN deleted the patch-1 branch January 3, 2025 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants