Skip to content

Commit 0f1b259

Browse files
fix: clarify transactions Javadoc — chunks are atomic individually, not across the full set
1 parent 3306f75 commit 0f1b259

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

src/main/java/dev/openfga/sdk/api/configuration/ClientWriteOptions.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,10 @@ public String getAuthorizationModelId() {
5959
/**
6060
* Sets whether transactions should be used when writing tuples.
6161
*
62-
* <p>When {@code true}, writes are sent as a single transactional request. When {@code false},
63-
* writes are split into chunks and sent as individual non-transactional requests, with chunk
64-
* size controlled by {@link #transactionChunkSize(int)}.
62+
* <p>When {@code true}, all writes and deletes are sent as a single atomic request — if any
63+
* tuple fails, the entire operation is rolled back. When {@code false}, tuples are split into
64+
* chunks and sent as separate requests, each chunk atomic on its own but with no atomicity
65+
* guarantee across the full set. Chunk size is controlled by {@link #transactionChunkSize(int)}.
6566
*
6667
* @param enabled {@code true} to enable transactions (default), {@code false} to disable them
6768
* @return this {@code ClientWriteOptions} instance for method chaining

0 commit comments

Comments
 (0)