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.

Sign up for GitHub

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

Extend write consistency factor text, reapply on client vs lower factor #1013

Merged
merged 2 commits into from
Jan 28, 2025
Merged

Extend write consistency factor text, reapply on client vs lower factor #1013

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2f8ec6
Extend write consistency factor text, reapply on client vs lower factor
timvisee Jul 8, 2024
7ad4e50
Update qdrant-landing/content/documentation/guides/distributed_deploy…
timvisee Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions qdrant-landing/content/documentation/guides/distributed_deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1033,8 +1033,11 @@ Qdrant provides a few options to control consistency guarantees:

### Write consistency factor

The `write_consistency_factor` represents the number of replicas that must acknowledge a write operation before responding to the client. It is set to one by default.
It can be configured at the collection's creation time.
The `write_consistency_factor` represents the number of replicas that must acknowledge a write operation before responding to the client. It is set to 1 by default.
It can be configured at the collection's creation or when updating the
collection parameters.

This value can range from 1 to the number of replicas you have for each shard.

```http
PUT /collections/{collection_name}
Expand Down Expand Up @@ -1165,7 +1168,14 @@ client.CreateCollection(context.Background(), &qdrant.CreateCollection{
})
```

Write operations will fail if the number of active replicas is less than the `write_consistency_factor`.
Write operations will fail if the number of active replicas is less than the
`write_consistency_factor`. In this case, the client is expected to send the
operation again to ensure a consistent state is reached.

Setting the `write_consistency_factor` to a lower value may allow accepting
writes even if there are unresponsive nodes. Unresponsive nodes are marked as
davidmyriel marked this conversation as resolved.
Show resolved Hide resolved
dead and will automatically be recovered once available to ensure data
consistency.

The configuration of the `write_consistency_factor` is important for adjusting the cluster's behavior when some nodes go offline due to restarts, upgrades, or failures.

Expand Down