Skip to main content
interface AlterTableRequest
action: string;
options?: Record<string, string>;
table_name: string;
value: string;
action options? table_name value
action: string

Modification operation to be applied.

options?: Record<string, string>

Optional parameters.

table_name: string

Table on which the operation will be performed, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table or view.

value: string

The value of the modification, depending on action. For example, if action is add_column, this would be the column name; while the column’s definition would be covered by the column_type, column_properties, column_default_value, and add_column_expression in options. If action is ttl, it would be the number of minutes for the new TTL. If action is refresh, this field would be blank.