diff --git a/README.md b/README.md index 7fc61c7..727ef2d 100644 --- a/README.md +++ b/README.md @@ -176,12 +176,16 @@ Atomically bulk deletes all relationships matching the provided filters, with op - `resourceFilter` - The filter to apply to the resource part of the relationships. The resourceFilter.Type is required; all other fields are optional. - `optionalSubjectFilter` (optional) - An optional additional filter for the subject part of the relationships. - `optionalPreconditions` (optional) - An optional list of preconditions that must be satisfied for the operation to commit. +- `allowPartialDeletions` (optional) - If true and a limit is specified, will delete matching found relationships up to the count specified in limit, and no more. +- `limit` (optional) if non-zero, specifies the limit on the number of relationships to be deleted. If there are more matching relationships found to be deleted than the limit specified here, + the deletion call will fail with an error to prevent partial deletion. If partial deletion is needed, specify below that partial deletion is allowed. Partial deletions can be used + in a loop to delete large amounts of relationships in a *non-transactional* manner. - `deadline` (optional) - An optional deadline for the call. The operation will be cancelled if the deadline is reached. - `cancellationToken` (optional) - An optional token for cancelling the call. **Returns** -- A task representing the asynchronous operation, with a `ZedToken?` indicating the version of the data after the delete operation. +- DeleteRelationshipsResponse object that contains a ZedToken representing the point of deletion and an indicator of deletion progress ### CheckPermissionAsync diff --git a/SpiceDb/SpiceDb.csproj b/SpiceDb/SpiceDb.csproj index e217ce8..b1b67cf 100644 --- a/SpiceDb/SpiceDb.csproj +++ b/SpiceDb/SpiceDb.csproj @@ -15,7 +15,7 @@ logo.png LICENSE.txt README.md - 1.5.1 + 1.5.2