Skip to content

DOCS - clarify transactionalID and idempotent behavior#7821

Merged
guozhangwang merged 2 commits intoapache:trunkfrom
joel-hamill:DOCS-728
Feb 7, 2020
Merged

DOCS - clarify transactionalID and idempotent behavior#7821
guozhangwang merged 2 commits intoapache:trunkfrom
joel-hamill:DOCS-728

Conversation

@joel-hamill
Copy link
Copy Markdown
Contributor

@joel-hamill joel-hamill commented Dec 11, 2019

If transactional.id is set without setting enable.idempotence, the producer will set enable.idempotence to true implicitly. The docs should reflect this.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@joel-hamill
Copy link
Copy Markdown
Contributor Author

ping @guozhangwang

public static final String TRANSACTIONAL_ID_DOC = "The TransactionalId to use for transactional delivery. This enables reliability semantics which span multiple producer sessions since it allows the client to guarantee that transactions using the same TransactionalId have been completed prior to starting any new transactions. If no TransactionalId is provided, then the producer is limited to idempotent delivery. " +
"Note that <code>enable.idempotence</code> must be enabled if a TransactionalId is configured. " +
"If a TransactionalId is configured, <code>enable.idempotence</code> is implied. " +
"The default is <code>null</code>, which means transactions cannot be used. " +
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The default is <code>null</code> - I don't think this is clear enough, is it talking about the default for TransactionalId or the default for enable.idempotence?

Copy link
Copy Markdown
Contributor

@guozhangwang guozhangwang left a comment

Choose a reason for hiding this comment

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

Other than @WheresAlice 's comment this PR LGTM. Maybe we can just say ".. is implied as true. By default TransactionId is not configured, which means ..."

@joel-hamill
Copy link
Copy Markdown
Contributor Author

@WheresAlice @guozhangwang i have updated per feedback fa61ea0

@ghost
Copy link
Copy Markdown

ghost commented Jan 8, 2020

LGTM

@joel-hamill
Copy link
Copy Markdown
Contributor Author

ping @guozhangwang for merge

@guozhangwang guozhangwang merged commit 83e1a8d into apache:trunk Feb 7, 2020
ijuma added a commit to ijuma/kafka that referenced this pull request Apr 28, 2020
…t-for-generated-requests

* apache-github/trunk: (410 commits)
  KAFKA-8843: KIP-515: Zookeeper TLS support
  MINOR: Add missing quote for malformed line content (apache#8070)
  MINOR: Simplify KafkaProducerTest (apache#8044)
  KAFKA-9507; AdminClient should check for missing committed offsets (apache#8057)
  KAFKA-9519: Deprecate the --zookeeper flag in ConfigCommand (apache#8056)
  KAFKA-9509; Fixing flakiness of MirrorConnectorsIntegrationTest.testReplication (apache#8048)
  HOTFIX: Fix two test failures in JDK11 (apache#8063)
  DOCS - clarify transactionalID and idempotent behavior (apache#7821)
  MINOR: further InternalTopologyBuilder cleanup  (apache#8046)
  MINOR: Add timer for update limit offsets (apache#8047)
  HOTFIX: Fix spotsbug failure in Kafka examples (apache#8051)
  KAFKA-9447: Add new customized EOS model example (apache#8031)
  KAFKA-8164: Add support for retrying failed (apache#8019)
  HOTFIX: checkstyle for newly added unit test
  KAFKA-9261; Client should handle unavailable leader metadata (apache#7770)
  MINOR: Fix typos introduced in KIP-559 (apache#8042)
  MINOR: Fixing null handilg in ValueAndTimestampSerializer (apache#7679)
  KAFKA-9113: Clean up task management and state management (apache#7997)
  MINOR: fix checkstyle issue in ConsumerConfig.java (apache#8038)
  KAFKA-9491; Increment high watermark after full log truncation (apache#8037)
  ...
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