Skip to content

Add optional cursor to DeleteRelationships for resumable batched deletion #174

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

Merged
josephschorr merged 1 commit into from
Sep 10, 2026
Merged

Add optional cursor to DeleteRelationships for resumable batched deletion #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions authzed/api/v1/permission_service.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,17 @@ message DeleteRelationshipsRequest {
(validate.rules).message.required = false,
(buf.validate.field).required = false
];

// optional_cursor, if specified, indicates the cursor after which deletion should resume. It is used to
// continue a batched, partial deletion where a previous call left off, by passing back the
// after_result_cursor returned on the previous DeleteRelationshipsResponse.
//
// A cursor allows a large deletion to be performed as a series of calls without re-examining the
// relationships already deleted by earlier calls. It therefore requires optional_limit and
// optional_allow_partial_deletions to be set, and is only supported by datastores whose deletion can be
// ordered and resumed; datastores that do not support cursored deletion will return an error if a cursor
// is provided.
Cursor optional_cursor = 6;
}

message DeleteRelationshipsResponse {
Expand All @@ -456,6 +467,13 @@ message DeleteRelationshipsResponse {

// relationships_deleted_count is the number of relationships that were deleted.
uint64 relationships_deleted_count = 3;

// after_result_cursor holds a cursor that can be used to resume the deletion after the relationships
// deleted by this call, by supplying it as the optional_cursor on a subsequent DeleteRelationshipsRequest.
//
// It is populated only when deletion_progress is DELETION_PROGRESS_PARTIAL and the datastore supports
// cursored deletion; it is unset once DELETION_PROGRESS_COMPLETE is returned.
Cursor after_result_cursor = 4;
}

// CheckPermissionRequest issues a check on whether a subject has a permission
Expand Down
8 changes: 8 additions & 0 deletions docs/apidocs.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1525,6 +1525,10 @@
"optionalTransactionMetadata": {
"type": "object",
"description": "optional_transaction_metadata is an optional field that can be used to store metadata about the transaction.\nIf specified, this metadata will be supplied in the WatchResponse for the deletions associated with\nthis transaction."
},
"optionalCursor": {
"$ref": "#/definitions/v1.Cursor",
"description": "optional_cursor, if specified, indicates the cursor after which deletion should resume. It is used to\ncontinue a batched, partial deletion where a previous call left off, by passing back the\nafter_result_cursor returned on the previous DeleteRelationshipsResponse.\n\nA cursor allows a large deletion to be performed as a series of calls without re-examining the\nrelationships already deleted by earlier calls. It therefore requires optional_limit and\noptional_allow_partial_deletions to be set, and is only supported by datastores whose deletion can be\nordered and resumed; datastores that do not support cursored deletion will return an error if a cursor\nis provided."
}
},
"description": "DeleteRelationshipsRequest specifies which Relationships should be deleted,\nrequesting the delete of *ALL* relationships that match the specified\nfilters. If the optional_preconditions parameter is included, all of the\nspecified preconditions must also be satisfied before the delete will be\nexecuted."
Expand All @@ -1544,6 +1548,10 @@
"type": "string",
"format": "uint64",
"description": "relationships_deleted_count is the number of relationships that were deleted."
},
"afterResultCursor": {
"$ref": "#/definitions/v1.Cursor",
"description": "after_result_cursor holds a cursor that can be used to resume the deletion after the relationships\ndeleted by this call, by supplying it as the optional_cursor on a subsequent DeleteRelationshipsRequest.\n\nIt is populated only when deletion_progress is DELETION_PROGRESS_PARTIAL and the datastore supports\ncursored deletion; it is unset once DELETION_PROGRESS_COMPLETE is returned."
}
}
},
Expand Down
Loading