Plug Database Advanced icon

Plug Database Advanced

Run Plug Database commands over REST or Socket.

SQL → Cancel SQL

AI-generated

Summary

Send a cancel SQL command to the Plug database over either REST or a socket connection to stop an ongoing SQL execution by its execution ID or request ID.

Inputs

  • Channel — Select the communication channel ('REST' or 'Socket') through which to send the cancel command.
  • Input Mode — Choose between 'Guided' mode, which simplifies command input, or 'Advanced' mode to provide a raw JSON-RPC command object.
  • Execution ID — Specify the execution_id of the SQL execution to cancel (used in Guided mode).
  • Request ID — Specify the request_id of the SQL execution to cancel (used in Guided mode).
  • Raw JSON-RPC Command (required) — Provide a full JSON-RPC command object for canceling SQL execution when using Advanced mode (token injected automatically).
  • Additional Options — Configure optional parameters like timeout (ms), API version, and JSON metadata to include with the cancel command (used in Guided mode).
  • Socket Options — Configure buffering and stream pulling options if using the Socket channel.
  • Agent ID — Override the target Plug agent ID; defaults from the credential if empty.
  • Client Token — Override the Plug client token; defaults from the credential if empty.
  • Include Plug Metadata — Choose whether to include Plug-specific metadata in the output.

Output shape

a list of items representing the cancel command response from Plug, typically a single success or failure response object.

Output format depends on the Response Mode setting; can be aggregated JSON, raw JSON-RPC envelope, or chunked items for socket streams. The operation returns the response from Plug confirming whether the cancel request was accepted or rejected.

Links

Discussion