Skip to content

Structure

SQLAlterEnum

An expression representing an ALTER TYPE query. Used to add new cases to enumeration types.
struct SQLAlterEnum

Overview

ALTER TYPE "name" ADD VALUE 'value';

This expression does not check whether the current dialect supports separate enumeration types; users should take care not to use it with incompatible drivers.

See SQLAlterEnumBuilder.

Note

Despite both its name and the query it represents, this expression can neither perform arbitrary enum alterations, nor represent the full range of possible ALTER TYPE queries, even in dialects which support them in the first place. This would probably have been better named something like SQLAddEnumCase.

Topics

Instance Properties

  • name
    The name of the type to alter.
  • value
    A new enumeration value to add to an existing type.

Instance Methods

  • serialize(to:)
    Invoked when a request is made to serialize the expression to raw SQL.

Relationships

Conforms To

See Also

Query Expressions

  • SQLAlterTable
    An expression representing an ALTER TABLE query. Used to modify the structure of existing tables.
  • SQLCreateEnum
    An expression representing a CREATE TYPE query. Used to create enumeration types.
  • SQLCreateIndex
    An expression representing a CREATE INDEX query. Used to add indexes over columns to an existing table.
  • SQLCreateTable
    An expression representing a CREATE TABLE query. Used to create new tables.
  • SQLCreateTrigger
    An expression representing a CREATE TRIGGER query. Used to create new triggers for actions on a table.
  • SQLDelete
    An expression representing a CREATE TRIGGER query. Used to remove rows from a table.
  • SQLDropEnum
    An expression representing a DROP TYPE query. Used to delete enumeration types.
  • SQLDropIndex
    An expression representing a DROP INDEX query. Used to delete indexes from tables.
  • SQLDropTable
    An expression representing a DROP TABLE query. Used to delete entire tables.
  • SQLDropTrigger
    An expression representing a DROP TRIGGER query. Used to delete triggers.
  • SQLInsert
    An expression representing an INSERT query. Used to add new rows to a table.
  • SQLSelect
    An expression representing a SELECT query. Used to retrieve rows and expression results from a database.
  • SQLUnion
    An expression representing two or more SELECT queries joined by UNION clauses. Used to merge the results of multiple queries into a single result set.
  • SQLUpdate
    An expression representing an UPDATE query. Used to modify existing rows in a single table.