> ## 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: Inputs, Cost & CLI Example

> Running an ad hoc SQL query against Snowflake using explicit account, warehouse, database, and schema credentials. Includes inputs, outputs, and CLI examples.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=snowflake_run_query:{"query":"{{query}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                  | Type      | Required | Default  | Description                                                                                                                                                                                                     |
| --------------------- | --------- | -------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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={null}
  {
    "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."
      },
      "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `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": "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>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute snowflake_run_query --payload '{
  "query": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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