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

# Snowflake: Actions/run Query

> Run a SQL query against your Snowflake warehouse and get the result rows back. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Run a SQL query against your Snowflake warehouse and get the result rows back.

> [!NOTE]
>
> Tool ID: `snowflake_run_query`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

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

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute snowflake_run_query --input '{
  "query": "software companies hiring engineers"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "rows": [
      {}
    ],
    "rowCount": 123,
    "limited": true,
    "columns": [
      "example"
    ],
    "queryId": "query_123"
  }
}
```

Use `deepline describe snowflake_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` | Snowflake 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. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "",
    "properties": {
      "credentials": {
        "type": "object",
        "properties": {
          "account": {
            "type": "string",
            "description": "Snowflake account identifier."
          },
          "user": {
            "type": "string",
            "description": "Snowflake username."
          },
          "warehouse": {
            "type": "string",
            "description": "Warehouse to use for query execution."
          },
          "database": {
            "type": "string",
            "description": "Default database."
          },
          "schema": {
            "type": "string",
            "description": "Default schema."
          },
          "role": {
            "type": "string",
            "description": "Optional Snowflake role."
          },
          "password": {
            "type": "string",
            "description": "Password auth secret."
          },
          "private_key": {
            "type": "string",
            "description": "Private key auth secret."
          },
          "private_key_passphrase": {
            "type": "string",
            "description": "Optional private key passphrase."
          }
        },
        "required": [
          "account",
          "user",
          "warehouse",
          "database",
          "schema"
        ],
        "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.",
        "aliases": [
          "sql"
        ]
      },
      "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": "Snowflake 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
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Snowflake 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.queryId` | `string \| null` | Yes | — | — |
| `result.data.dataset` | `object` | No | — | — |
| `result.data.dataset.kind` | `"snowflake_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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Snowflake 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"
            }
          },
          "queryId": {
            "type": [
              "string",
              "null"
            ]
          },
          "dataset": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "snowflake_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",
          "queryId"
        ],
        "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

* [Snowflake provider guide](https://deepline.com/docs/providers/snowflake/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


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