Enum Statement 

pub enum Statement {
    AddColumn(AddColumn),
    AlterColumn(AlterColumn),
    AlterTable(AlterTable),
    AlterType(AlterType),
    CopyTable(CopyTable),
    CreateIndex(CreateIndex),
    CreateTable(CreateTable),
    CreateType(CreateType),
    DropColumn(DropColumn),
    DropTable(DropTable),
    DropIndex(DropIndex),
    Pragma(Pragma),
    Delete(Delete),
    Insert(Insert),
    Query(Query),
    Update(Update),
}

A SQL statement, covering both DDL (schema changes) and DML (data manipulation).

Variants

AddColumn(AddColumn)

Add a column to an existing table.

AlterColumn(AlterColumn)

Alter properties of an existing column.

AlterTable(AlterTable)

Alter an existing table (e.g. rename).

AlterType(AlterType)

Alter a type (e.g. ALTER TYPE ... ADD VALUE '...').

CopyTable(CopyTable)

Copy rows from one table to another.

CreateIndex(CreateIndex)

Create an index.

CreateTable(CreateTable)

Create a table.

CreateType(CreateType)

Create a type (e.g. CREATE TYPE ... AS ENUM (...)).

DropColumn(DropColumn)

Drop a column from an existing table.

DropTable(DropTable)

Drop a table.

DropIndex(DropIndex)

Drop an index.

Pragma(Pragma)

A SQLite PRAGMA statement.

Delete(Delete)

A DELETE statement.

Insert(Insert)

An INSERT statement.

Query(Query)

A SELECT query.

Update(Update)

An UPDATE statement.

Implementations

impl Statement

pub fn add_column(column: &Column, capability: &Capability) -> Self

Adds a column to a table.

impl Statement

pub fn alter_column( column: &Column, changes: AlterColumnChanges, capability: &Capability, ) -> Self

Alters a column.

impl Statement

pub fn alter_table_rename_to(table: &Table, new_name: &str) -> Self

Renames a table.

impl Statement

pub fn alter_type_add_value(type_name: &str, variant: &EnumVariant) -> Self

Creates an ALTER TYPE <name> ADD VALUE '<variant>' statement.

impl Statement

pub fn copy_table( source: Name, target: Name, columns: Vec<(Name, Name)>, ) -> Self

Creates a statement that copies rows from one table to another.

impl Statement

pub fn create_index(index: &Index) -> Self

Creates a CREATE INDEX statement from a schema [Index].

impl Statement

pub fn create_table(table: &Table, capability: &Capability) -> Self

Creates a CREATE TABLE statement from a schema [Table].

impl Statement

pub fn create_enum_type(ty: &TypeEnum) -> Self

Creates a CREATE TYPE ... AS ENUM (...) statement from a [TypeEnum].

impl Statement

pub fn drop_column(column: &Column) -> Self

Drops a column from a table.

This function does not add an IF EXISTS clause.

pub fn drop_column_if_exists(column: &Column) -> Self

Drops a column from a table if it exists.

This function does add an IF EXISTS clause.

impl Statement

pub fn drop_index(index: &Index) -> Self

Drops an index.

This function does not add an IF EXISTS clause.

pub fn drop_index_if_exists(index: &Index) -> Self

Drops a index if it exists.

This function does add an IF EXISTS clause.

impl Statement

pub fn drop_table(table: &Table) -> Self

Drops a table.

This function does not add an IF EXISTS clause.

pub fn drop_table_if_exists(table: &Table) -> Self

Drops a table if it exists.

This function does add an IF EXISTS clause.

impl Statement

pub fn pragma_enable_foreign_keys() -> Self

Sets PRAGMA foreign_keys = ON.

pub fn pragma_disable_foreign_keys() -> Self

Sets PRAGMA foreign_keys = OFF.

pub fn pragma(name: impl Into<String>, value: impl Into<String>) -> Self

Creates a PRAGMA statement with the given name and value.

impl Statement

pub fn is_update(&self) -> bool

Returns true if this is an Update statement.

pub fn returning_len(&self) -> Option<usize>

Returns the number of returned elements within the statement (if one exists).

Trait Implementations

impl Clone for Statement

fn clone(&self) -> Statement

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Statement

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<AddColumn> for Statement

fn from(value: AddColumn) -> Self

Converts to this type from the input type.

impl From<AlterColumn> for Statement

fn from(value: AlterColumn) -> Self

Converts to this type from the input type.

impl From<AlterTable> for Statement

fn from(value: AlterTable) -> Self

Converts to this type from the input type.

impl From<AlterType> for Statement

fn from(value: AlterType) -> Self

Converts to this type from the input type.

impl From<CopyTable> for Statement

fn from(value: CopyTable) -> Self

Converts to this type from the input type.

impl From<CreateIndex> for Statement

fn from(value: CreateIndex) -> Self

Converts to this type from the input type.

impl From<CreateTable> for Statement

fn from(value: CreateTable) -> Self

Converts to this type from the input type.

impl From<CreateType> for Statement

fn from(value: CreateType) -> Self

Converts to this type from the input type.

impl From<DropColumn> for Statement

fn from(value: DropColumn) -> Self

Converts to this type from the input type.

impl From<DropIndex> for Statement

fn from(value: DropIndex) -> Self

Converts to this type from the input type.

impl From<DropTable> for Statement

fn from(value: DropTable) -> Self

Converts to this type from the input type.

impl From<Pragma> for Statement

fn from(value: Pragma) -> Self

Converts to this type from the input type.

impl From<Statement> for Statement

fn from(value: Statement) -> Self

Converts to this type from the input type.