Remy Reference/agent/queryExternalDatabase

queryExternalDatabase

Execute a SQL query against an external database connected to the workspace.

mindstudio.queryExternalDatabase({ query, outputFormat }) → Result

Execute a SQL query against an external database connected to the workspace.

Parameters

connectionId

string

Database connection ID configured in the workspace

query

string

RequiredSQL query to execute (supports variable interpolation)

outputFormat

string

RequiredOutput format for the result variable

jsoncsv

Call from a method

import { mindstudio } from '@mindstudio-ai/agent';

const result = await mindstudio.queryExternalDatabase({
  query: /* ... */,
  outputFormat: /* ... */
});