Struct IndexDef 

pub struct IndexDef { /* private fields */ }

Index definition

This struct represents an index definition for CREATE INDEX.

Note: The name and table fields are defined for future use in CREATE TABLE statements with inline index definitions, but are not yet used in the current backend implementations. The dead_code warning is allowed because this is part of the planned API.

Implementations

impl IndexDef

pub fn new<T, R>(name: T, table: R) -> Self

where T: IntoIden, R: Into<TableRef>,

Create a new index definition

pub fn column<C>(self, col: C) -> Self

where C: IntoIden,

Add a column to the index

pub fn columns<I, C>(self, cols: I) -> Self

where I: IntoIterator<Item = C>, C: IntoIden,

Add multiple columns to the index

pub fn unique(self, unique: bool) -> Self

Set UNIQUE attribute

pub fn where(self, expr: SimpleExpr) -> Self

Set WHERE clause for partial index

Trait Implementations

impl Clone for IndexDef

fn clone(&self) -> IndexDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDef

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

Formats the value using the given formatter.