Snowflake · Schema

CancelStatus

Status returned when a statement cancellation is requested.

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name	Type	Description
code	string	Status code for the cancellation.
sqlState	string	SQL state code.
message	string	Message describing the cancellation status.
statementHandle	string	Handle of the canceled statement.
statementStatusUrl	string	URL for checking the status of the canceled statement.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CancelStatus",
  "title": "CancelStatus",
  "type": "object",
  "description": "Status returned when a statement cancellation is requested.",
  "properties": {
    "code": {
      "type": "string",
      "description": "Status code for the cancellation.",
      "example": "example_value"
    },
    "sqlState": {
      "type": "string",
      "description": "SQL state code.",
      "example": "example_value"
    },
    "message": {
      "type": "string",
      "description": "Message describing the cancellation status.",
      "examples": [
        "successfully canceled"
      ]
    },
    "statementHandle": {
      "type": "string",
      "format": "uuid",
      "description": "Handle of the canceled statement.",
      "examples": [
        "536fad38-b564-4dc5-9892-a4543504df6c"
      ]
    },
    "statementStatusUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL for checking the status of the canceled statement.",
      "example": "https://www.example.com"
    }
  },
  "required": [
    "statementHandle"
  ]
}