Postgres: Run Query

Executing one parameterized SQL statement, including reads, mutations, and DDL, against a connected Postgres database.

Tool ID: postgres_run_query

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'postgres_run_query',
  {
    "query": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute postgres_run_query --input '{
  "query": "software companies hiring engineers"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "rows": [
      {}
    ],
    "rowCount": 123,
    "limited": true,
    "columns": [
      "example"
    ],
    "command": "example"
  },
  "meta": {
    "host": "api.example.com",
    "database": "example",
    "schema": "example",
    "rowLimit": 123,
    "timeoutMs": 123
  }
}

Use deepline tools get postgres_run_query --json for the latest machine-readable contract.

Input reference

Execute one parameterized SQL statement against the connected Postgres database. The database user controls permissions.

Name	Type	Required	Default	Details
`payload.query`	`string`	Yes	—	One SQL statement. Mutating and DDL statements execute directly using the connected database user and may change customer data.
`payload.binds`	`array`	No	—	Positional values for numbered Postgres SQL parameters.
`payload.timeoutMs`	`integer`	No	`120000`	Minimum: 1000. Maximum: 600000.
`payload.rowLimit`	`integer`	No	`5000`	Minimum: 1. Maximum: 100000.

Output reference

Postgres query result.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	—
`result.data.rows`	`array`	Yes	—	—
`result.data.rowCount`	`integer`	Yes	—	—
`result.data.limited`	`boolean`	Yes	—	—
`result.data.columns`	`array`	Yes	—	—
`result.data.command`	`string`	Yes	—	—
`result.meta`	`object`	Yes	—	—
`result.meta.host`	`string`	Yes	—	—
`result.meta.database`	`string`	Yes	—	—
`result.meta.schema`	`string`	Yes	—	—
`result.meta.rowLimit`	`integer`	Yes	—	—
`result.meta.timeoutMs`	`integer`	Yes	—	—

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Postgres: Run Query

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation