> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bigquery: Actions/run Query

> Running an ad hoc GoogleSQL query over the BigQuery HTTPS API with OAuth or a service account. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

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

<Info>
  Tool ID: `bigquery_run_query`
</Info>

## 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.

```ts theme={null}
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

```bash theme={null}
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.

```json theme={null}
{
  "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+$`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "",
    "properties": {
      "credentials": {
        "type": "object",
        "properties": {
          "project_id": {
            "type": "string",
            "description": "Billing project ID."
          },
          "dataset": {
            "type": "string",
            "description": "Default dataset."
          },
          "location": {
            "type": "string",
            "description": "BigQuery job location."
          },
          "service_account_json": {
            "type": "string",
            "description": "Google service-account key JSON. Parsed only in memory."
          }
        },
        "required": [
          "service_account_json"
        ],
        "additionalProperties": false
      },
      "query": {
        "type": "string",
        "description": "SQL query text to execute. Defaults to read-only SELECT or WITH statements; set write: true for a single mutating or DDL statement."
      },
      "binds": {
        "type": "array",
        "description": "Optional positional bind values for parameterized SQL.",
        "items": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "timeoutMs": {
        "type": "integer",
        "description": "BigQuery statement timeout in milliseconds. Default 120000.",
        "default": 120000
      },
      "rowLimit": {
        "type": "integer",
        "description": "Maximum number of rows to return. Default 5000.",
        "default": 5000
      },
      "write": {
        "type": "boolean",
        "description": "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.",
        "default": false
      },
      "maximumBytesBilled": {
        "type": "string",
        "description": "Maximum bytes the BigQuery job may bill.",
        "pattern": "^\\d+$"
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "BigQuery query result.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "rows": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            }
          },
          "rowCount": {
            "type": "integer"
          },
          "limited": {
            "type": "boolean"
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "jobId": {
            "type": [
              "string",
              "null"
            ]
          },
          "dataset": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "bigquery_query"
              },
              "total_rows": {
                "type": "integer"
              },
              "returned_limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "page_size": {
                "type": "integer"
              }
            },
            "required": [
              "kind",
              "total_rows",
              "returned_limit",
              "offset",
              "page_size"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "rows",
          "rowCount",
          "limited",
          "columns",
          "jobId"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Bigquery provider guide](/docs/providers/bigquery/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.