Customer DB: Query Customer Db

Running SQL against the tenant customer DB and returning structured rows.

Tool ID: query_customer_db

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(
  'query_customer_db',
  {
    "sql": "SELECT * FROM companies LIMIT 10"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute query_customer_db --input '{
  "sql": "SELECT * FROM companies LIMIT 10"
}' --json

Example response

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

{
  "command": "example",
  "row_count": 1,
  "row_count_returned": 123,
  "truncated": true,
  "columns": [
    {
      "name": "Example",
      "table_id": 1,
      "data_type_id": 1
    }
  ],
  "rows": [
    {}
  ]
}

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

Input reference

Query the workspace customer database through Deepline APIs and return structured rows. This is the agent-safe SQL surface: read permitted schemas, but write only schema-qualified customer-managed targets outside protected Deepline schemas. CREATE TABLE, INSERT, UPDATE, DELETE, ALTER, DROP, TRUNCATE, and CREATE INDEX require schema-qualified targets.

Name	Type	Required	Default	Details
`payload.sql`	`string`	Yes	—	One SQL statement for the workspace customer DB. Use SELECT/EXPLAIN/read-only WITH to inspect permitted schemas. Writes and DDL must target a schema-qualified customer-managed table or schema, for example CREATE TABLE analytics.agent_notes (…). Protected Deepline schemas are read-only, and unqualified CREATE TABLE blocked (…) is rejected. Minimum length: 1.
`payload.max_rows`	`integer`	No	—	Maximum rows to return in the response payload. Default 1000. This caps returned rows only; it does not restrict SQL shape, aggregates, GROUP BY, or CTE usage. Minimum: 1. Maximum: 1000.

Output reference

Name	Type	Required	Default	Details
`result.command`	`string`	Yes	—	—
`result.row_count`	`integer`	Yes	—	—
`result.row_count_returned`	`integer`	Yes	—	—
`result.truncated`	`boolean`	Yes	—	—
`result.columns`	`array`	Yes	—	—
`result.columns[].name`	`string`	Yes	—	—
`result.columns[].table_id`	`integer \| null`	Yes	—	—
`result.columns[].data_type_id`	`integer \| null`	Yes	—	—
`result.rows`	`array`	Yes	—	—
`result.dataset`	`object`	No	—	—
`result.dataset.kind`	`"customer_db_query"`	Yes	—	Allowed: `customer_db_query`.
`result.dataset.total_rows`	`integer`	Yes	—	—
`result.dataset.returned_limit`	`integer`	Yes	—	—
`result.dataset.offset`	`integer`	Yes	—	—
`result.dataset.page_size`	`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

Customer DB: Query Customer Db

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