View as Markdown
PostgreSQL icon

PostgreSQL ACTION

Query SQL Database

Execute a SQL Query. See our docs to learn more about working with SQL in Pipedream.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PostgreSQL account once, then configure and run Query SQL Database from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "database-query-sql-database",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    postgresql: { authProvisionId: "apn_xxxxxxx" },
    db_type: "Database Type",
    sql: "Sql",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Query SQL Database inputs
Property Type Description
db_type Database Type string
Select the database type you need to query
Required
sql Sql sql
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
database-query-sql-database
Version
0.0.5
App
PostgreSQL
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes