Snowflake · Schema

EventTable

A Snowflake event table

Data LakesData SharingData WarehousingDatabaseSQL

Properties

Name	Type	Description
name	string	Name of the event table
cluster_by	array	Cluster key column(s) or expression
data_retention_time_in_days	integer	number of days to retain the old version of deleted/updated data
max_data_extension_time_in_days	integer	Maximum number of days to extend data retention beyond the retention period to prevent a stream becoming stale.
change_tracking	boolean	True if change tracking is enabled, allowing streams and CHANGES to be used on the entity.
default_ddl_collation	string	Collation that is used for all the new columns created by the DDL statements (if not specified)
comment	string	user comment associated to an object in the dictionary
created_on	string	Date and time when the event table was created.
database_name	string	Database in which the event table is stored
schema_name	string	Schema in which the event table is stored
owner	string	Role that owns the event table
owner_role_type	string	The type of role that owns the event table
rows	integer	Number of rows in the table.
bytes	integer	Number of bytes that will be scanned if the entire table is scanned in a query.Note that this number may be different than the number of actual physical bytes stored on-disk for the table
automatic_clustering	boolean	If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table.
search_optimization	boolean	If ON, the table has the search optimization service enabled
search_optimization_progress	integer	Percentage of the table that has been optimized for search
search_optimization_bytes	integer	Number of additional bytes of storage that the search optimization service consumes for this table
columns	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/EventTable",
  "title": "EventTable",
  "type": "object",
  "description": "A Snowflake event table",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the event table",
      "example": "Example Title"
    },
    "cluster_by": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Cluster key column(s) or expression",
      "example": []
    },
    "data_retention_time_in_days": {
      "type": "integer",
      "description": "number of days to retain the old version of deleted/updated data",
      "example": 10
    },
    "max_data_extension_time_in_days": {
      "type": "integer",
      "description": "Maximum number of days to extend data retention beyond the retention period to prevent a stream becoming stale.",
      "example": 10
    },
    "change_tracking": {
      "type": "boolean",
      "description": "True if change tracking is enabled, allowing streams and CHANGES to be used on the entity.",
      "example": true
    },
    "default_ddl_collation": {
      "type": "string",
      "description": "Collation that is used for all the new columns created by the DDL statements (if not specified)",
      "example": "example_value"
    },
    "comment": {
      "type": "string",
      "description": "user comment associated to an object in the dictionary",
      "example": "example_value"
    },
    "created_on": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "Date and time when the event table was created.",
      "example": "2026-01-15T10:30:00Z"
    },
    "database_name": {
      "type": "string",
      "readOnly": true,
      "description": "Database in which the event table is stored",
      "example": "example_value"
    },
    "schema_name": {
      "type": "string",
      "readOnly": true,
      "description": "Schema in which the event table is stored",
      "example": "example_value"
    },
    "owner": {
      "type": "string",
      "readOnly": true,
      "description": "Role that owns the event table",
      "example": "example_value"
    },
    "owner_role_type": {
      "type": "string",
      "readOnly": true,
      "description": "The type of role that owns the event table",
      "example": "example_value"
    },
    "rows": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "Number of rows in the table.",
      "example": 10
    },
    "bytes": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "Number of bytes that will be scanned if the entire table is scanned in a query.Note that this number may be different than the number of actual physical bytes stored on-disk for the table",
      "example": 10
    },
    "automatic_clustering": {
      "type": "boolean",
      "readOnly": true,
      "description": "If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table.",
      "example": true
    },
    "search_optimization": {
      "type": "boolean",
      "readOnly": true,
      "description": "If ON, the table has the search optimization service enabled",
      "example": true
    },
    "search_optimization_progress": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "Percentage of the table that has been optimized for search",
      "example": 10
    },
    "search_optimization_bytes": {
      "type": "integer",
      "format": "int64",
      "readOnly": true,
      "description": "Number of additional bytes of storage that the search optimization service consumes for this table",
      "example": 10
    },
    "columns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EventTableColumn"
      },
      "readOnly": true,
      "example": []
    }
  },
  "required": [
    "name"
  ]
}