Skip to content

Commit

Permalink
Extend write consistency factor text, reapply on client vs lower factor
Browse files Browse the repository at this point in the history
  • Loading branch information
timvisee committed Jul 8, 2024
1 parent ad6630b commit ee1b305
Showing 1 changed file with 13 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -951,8 +951,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 @@ -1068,7 +1071,14 @@ await client.CreateCollectionAsync(
);
```

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
dead and will automatically be recovered again once available to ensure data
consistency.

### Read consistency

Expand Down

0 comments on commit ee1b305

Please sign in to comment.