Snowflake · Schema

SessionParameters

Session parameters that should be set before executing the statement.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name	Type	Description
timezone	string	Time zone to use when executing the statement.
query_tag	string	Query tag that you want to associate with the SQL statement.
binary_output_format	string	Output format for binary values.
date_output_format	string	Output format for DATE values.
time_output_format	string	Output format for TIME values.
timestamp_output_format	string	Output format for TIMESTAMP values.
timestamp_ltz_output_format	string	Output format for TIMESTAMP_LTZ values.
timestamp_ntz_output_format	string	Output format for TIMESTAMP_NTZ values.
timestamp_tz_output_format	string	Output format for TIMESTAMP_TZ values.
multi_statement_count	integer	Number of statements to execute when using multi-statement capability. 0 implies variable number of statements. Negative numbers are not allowed.
client_result_chunk_size	integer	Maximum size of each set (chunk) of query results to download.
rows_per_resultset	integer	Maximum number of rows returned in a result set.
use_cached_result	boolean	Whether to use a previously-cached result set for a query whose result set is still in the cache.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SessionParameters",
  "title": "SessionParameters",
  "type": "object",
  "description": "Session parameters that should be set before executing the statement.",
  "properties": {
    "timezone": {
      "type": "string",
      "description": "Time zone to use when executing the statement.",
      "examples": [
        "america/los_angeles"
      ]
    },
    "query_tag": {
      "type": "string",
      "description": "Query tag that you want to associate with the SQL statement.",
      "examples": [
        "tag-1234"
      ]
    },
    "binary_output_format": {
      "type": "string",
      "description": "Output format for binary values.",
      "examples": [
        "HEX"
      ]
    },
    "date_output_format": {
      "type": "string",
      "description": "Output format for DATE values.",
      "examples": [
        "YYYY-MM-DD"
      ]
    },
    "time_output_format": {
      "type": "string",
      "description": "Output format for TIME values.",
      "examples": [
        "HH24:MI:SS.FF6"
      ]
    },
    "timestamp_output_format": {
      "type": "string",
      "description": "Output format for TIMESTAMP values.",
      "examples": [
        "YYYY-MM-DDTHH24:MI:SS.FF6"
      ]
    },
    "timestamp_ltz_output_format": {
      "type": "string",
      "description": "Output format for TIMESTAMP_LTZ values.",
      "examples": [
        "YYYY-MM-DDTHH24:MI:SS.FF6"
      ]
    },
    "timestamp_ntz_output_format": {
      "type": "string",
      "description": "Output format for TIMESTAMP_NTZ values.",
      "examples": [
        "YYYY-MM-DDTHH24:MI:SS.FF6"
      ]
    },
    "timestamp_tz_output_format": {
      "type": "string",
      "description": "Output format for TIMESTAMP_TZ values.",
      "examples": [
        "YYYY-MM-DDTHH24:MI:SS.FF6 TZHTZM"
      ]
    },
    "multi_statement_count": {
      "type": "integer",
      "description": "Number of statements to execute when using multi-statement capability. 0 implies variable number of statements. Negative numbers are not allowed.",
      "default": 1,
      "examples": [
        4
      ]
    },
    "client_result_chunk_size": {
      "type": "integer",
      "description": "Maximum size of each set (chunk) of query results to download.",
      "examples": [
        160
      ]
    },
    "rows_per_resultset": {
      "type": "integer",
      "description": "Maximum number of rows returned in a result set.",
      "examples": [
        10000
      ]
    },
    "use_cached_result": {
      "type": "boolean",
      "description": "Whether to use a previously-cached result set for a query whose result set is still in the cache.",
      "examples": [
        true
      ]
    }
  }
}