Plug Database AdvancedInstall

Summary

Retrieve profile information about a Plug database agent by sending a JSON-RPC command over either REST or a socket connection, optionally customizing the request and output format.

Inputs

• Channel — Select the communication channel for the command, either REST or the Plug consumer socket.
• Input Mode — Choose between Guided mode for a simplified input or Advanced mode to send a full JSON-RPC command object.
• Response Mode — Determine how the Plug response is returned: Aggregated JSON, chunked items (for socket streams), or raw JSON-RPC envelope.
• Agent ID — Optional override for the target Plug agent ID; uses the default agent ID from credentials if empty.
• Client Token — Optional override for the Plug client token; uses the default client token from credentials if empty.
• Include Plug Metadata — Specify whether to include detailed Plug metadata (channel, agent, request, and socket information) in the output.
• Raw JSON-RPC Command (required) — (Advanced mode only) JSON text of the full JSON-RPC command to send to the Plug API; client token injection is automatic where supported.
• Additional Options — (Guided mode only) Options including timeout milliseconds, API version override, and an optional JSON object to merge into command metadata.
• Socket Options — (When using socket channel) Configure socket stream buffer sizes and stream pull window size to handle large or streaming results efficiently.

Output shape

a single JSON item or multiple items representing the agent profile data returned by the Plug database agent, depending on response mode and channel.

The output format adapts to the response mode setting: 'Aggregated JSON' returns rows as separate items if possible; 'Chunk Items' is optimized for streaming socket SQL responses; 'Raw JSON-RPC' returns the full JSON-RPC envelope for debugging. Metadata inclusion is controlled by the Include Plug Metadata input.

Links

• n8n community nodes installation guide