Struct Index 

pub struct Index {
    pub name: String,
    pub table: String,
    pub columns: Vec<String>,
    pub unique: bool,
    pub method: IndexMethod,
    pub where_clause: Option<CheckExpr>,
    pub include: Vec<String>,
    pub concurrently: bool,
    pub expressions: Vec<String>,
}

An index definition.

Fields

name: String

Index name.

table: String

Table the index belongs to.

columns: Vec<String>

Columns covered by the index.

unique: bool

Whether the index enforces uniqueness.

method: IndexMethod

Index method (Phase 4): btree, hash, gin, gist, brin

where_clause: Option<CheckExpr>

Partial index WHERE clause

include: Vec<String>

INCLUDE columns (covering index)

concurrently: bool

CREATE CONCURRENTLY

expressions: Vec<String>

Expression columns (e.g. (lower(email))) — if set, these replace columns

Implementations

impl Index

pub fn new( name: impl Into<String>, table: impl Into<String>, columns: Vec<String>, ) -> Self

Create a new index on the given columns.

pub fn expression( name: impl Into<String>, table: impl Into<String>, expressions: Vec<String>, ) -> Self

Create an expression index (e.g. CREATE INDEX ON t ((lower(email))))

pub fn unique(self) -> Self

Mark this index as UNIQUE.

pub fn using(self, method: IndexMethod) -> Self

Set index method (USING clause)

pub fn partial(self, expr: CheckExpr) -> Self

Create a partial index with WHERE clause

pub fn include(self, cols: Vec<String>) -> Self

Add INCLUDE columns (covering index)

pub fn concurrently(self) -> Self

Create index CONCURRENTLY

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.