Plug Database icon

Plug Database

Run Plug Database commands over REST or Socket.

SQL → Cancel SQL

AI-generated

Summary

Sends a sql.cancel JSON-RPC command to cancel a SQL execution identified by its execution ID, request ID, or both. Use Guided mode to provide those identifiers, or Advanced mode to supply the full JSON-RPC command.

Inputs

  • Channel — Select REST or Socket transport; defaults to REST.
  • Input Mode — Select Guided mode (default) to enter cancellation identifiers, or Advanced mode to provide a raw JSON-RPC command.
  • Execution ID — Guided mode: optional execution_id for the SQL execution to cancel.
  • Request ID — Guided mode: optional request_id for the SQL request to cancel.
  • Raw JSON-RPC Command (required) — Advanced mode: a JSON-RPC command object. The node injects the resolved client token where supported.
  • Agent ID — Optional target Plug agent override; otherwise uses the credential default.
  • Client Token — Optional Plug client token override; otherwise uses the credential default.
  • Include Plug Metadata — Defaults to true; controls whether output includes a __plug object with channel, agent, request, and socket metadata.
  • Additional Options — Guided mode options include timeout (default 15000 ms), API version (default 2.8), optional RPC metadata JSON, server timings, and maximum parallel input items (default 0, sequential).
  • Socket Options — Socket channel options control stream buffer limits, pull window size, relay fast path, and server timings.
  • Response Mode — Select the output shape; defaults to Aggregated JSON. Other options are Aggregated Single Item, Chunk Items, or Raw JSON-RPC.

Output shape

One or more n8n items containing the normalized JSON-RPC response; optionally includes __plug metadata.

Exact item shape depends on the response mode and server response. The UI exposes the four response modes for this operation, but cancellation is described as a command and the source excerpt does not establish a cancellation-specific response schema. Raw JSON-RPC returns the normalized RPC envelope.

Links

Discussion