Skip to content

Structure

SQLDropIndex

An expression representing a DROP INDEX query. Used to delete indexes from tables.
struct SQLDropIndex

Overview

DROP INDEX IF EXISTS ON `table` CASCADE;

Not all dialects require or allow specifying the owning table of an index when dropping it, while others enforce doing so. There is no dialect functionality enabling a check for this at this time, so users must track for themselves whether or not to specify the table. At the time of this writing, the table must be specified for MySQL and must not be specified for other drivers.

See SQLDropIndexBuilder.

Topics

Initializers

Instance Properties

  • behavior
    A drop behavior.
  • ifExists
    If true, requests idempotent behavior (e.g. that no error be raised if the named index does not exist).
  • name
    The name of the index to drop.
  • owningObject
    The object (usually a table) on which the index exists.

Instance Methods

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

Relationships

Conforms To

See Also

Query Expressions

  • SQLAlterEnum
    An expression representing an ALTER TYPE query. Used to add new cases to enumeration types.
  • 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.
  • 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.