Bigquery: Actions/run Query

Running an ad hoc GoogleSQL query over the BigQuery HTTPS API with OAuth or a service account.

Tool ID: bigquery_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(
  'bigquery_run_query',
  {
    "query": "software companies hiring engineers"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute bigquery_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"
    ],
    "jobId": "job_123"
  }
}

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

Input reference

Name	Type	Required	Default	Details
`payload.credentials`	`object`	No	—	—
`payload.query`	`string`	Yes	—	SQL query text to execute. Defaults to read-only SELECT or WITH statements; set write: true for a single mutating or DDL statement.
`payload.binds`	`array`	No	—	Optional positional bind values for parameterized SQL.
`payload.timeoutMs`	`integer`	No	`120000`	BigQuery statement timeout in milliseconds. Default 120000.
`payload.rowLimit`	`integer`	No	`5000`	Maximum number of rows to return. Default 5000.
`payload.write`	`boolean`	No	`false`	Explicitly opt into executing one non-read-only SQL statement. Required for INSERT, MERGE, UPDATE, DELETE, CREATE, ALTER, DROP, or other statements that may modify or overwrite customer data. Defaults false.
`payload.maximumBytesBilled`	`string`	No	—	Maximum bytes the BigQuery job may bill. Pattern: `^\d+$`.

Output reference

BigQuery query result.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.rows`	`array`	Yes	—	—
`result.data.rowCount`	`integer`	Yes	—	—
`result.data.limited`	`boolean`	Yes	—	—
`result.data.columns`	`array`	Yes	—	—
`result.data.jobId`	`string \| null`	Yes	—	—
`result.data.dataset`	`object`	No	—	—
`result.data.dataset.kind`	`"bigquery_query"`	Yes	—	—
`result.data.dataset.total_rows`	`integer`	Yes	—	—
`result.data.dataset.returned_limit`	`integer`	Yes	—	—
`result.data.dataset.offset`	`integer`	Yes	—	—
`result.data.dataset.page_size`	`integer`	Yes	—	—
`result.meta`	`record`	No	—	Additional response metadata (status, paging).

Deepline cost

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

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Bigquery: Actions/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