Struct Index 

pub struct Index {
    pub schema: Cow<'static, str>,
    pub table: Cow<'static, str>,
    pub name: Cow<'static, str>,
    pub name_explicit: bool,
    pub columns: Vec<IndexColumn>,
    pub is_unique: bool,
    pub where_clause: Option<Cow<'static, str>>,
    pub method: Option<Cow<'static, str>>,
    pub with: Option<Cow<'static, str>>,
    pub concurrently: bool,
}

An index, as stored in migration snapshots.

Fields

schema: Cow<'static, str>

Schema name

table: Cow<'static, str>

Parent table name

name: Cow<'static, str>

Index name

name_explicit: bool

Whether the index name was explicitly specified

columns: Vec<IndexColumn>

Columns included in the index

is_unique: bool

Is this a unique index?

where_clause: Option<Cow<'static, str>>

WHERE clause for partial indexes

method: Option<Cow<'static, str>>

Index method (btree, hash, etc.)

with: Option<Cow<'static, str>>

Storage parameters (WITH clause)

concurrently: bool

Create concurrently?

Implementations

impl Index

pub fn new( schema: impl Into<Cow<'static, str>>, table: impl Into<Cow<'static, str>>, name: impl Into<Cow<'static, str>>, columns: Vec<IndexColumn>, ) -> Self

Creates an index.

pub const fn unique(self) -> Self

Make this a unique index

pub const fn explicit_name(self) -> Self

Mark the name as explicitly specified

pub fn schema(&self) -> &str

Returns the schema name.

pub fn name(&self) -> &str

Returns the index name.

pub fn table(&self) -> &str

Returns the table name.

impl Index

pub fn create_index_sql(&self) -> String

Renders CREATE [UNIQUE] INDEX [CONCURRENTLY] ... ON table [USING method] (...), with WITH (...) and the partial index WHERE clause if set.

pub fn drop_index_sql(&self) -> String

Renders DROP INDEX ...;.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Self

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.

impl Default for Index

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Index

impl From<IndexDef> for Index

fn from(def: IndexDef) -> Self

Converts to this type from the input type.

impl PartialEq for Index

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Index