cancel_blob_gc()
relationalai.api
cancel_blob_gc()Use api.cancel_blob_gc() to request cancellation of a running Blob GC pass when an exceptional operational situation requires it.
Requires the app_admin application role.
Parameters
Section titled “Parameters”This procedure does not take any parameters.
Returns
Section titled “Returns”STRING
The procedure returns one of the following messages immediately after you submit the cancellation request:
| Outcome | Returned message |
|---|---|
| Cancellation requested | Blob GC cancellation requested successfully. |
| Cancellation requested for a specific engine | Blob GC cancellation requested successfully on engine <engine_name>. |
| No Blob GC pass running | No Blob GC pass is currently running. |
| Cancellation failed | Error cancelling Blob GC: <reason> |
| Cancellation failed for a specific engine | Error cancelling Blob GC on engine <engine_name>: <reason> |
The engine name appears only when the response includes one.
Example
Section titled “Example”Request cancellation of the current Blob GC pass:
CALL relationalai.api.cancel_blob_gc();Cancellation completes asynchronously after you call the procedure, unless you receive an error message indicating that cancellation failed or that no Blob GC pass is currently running.