Struct CreateIndex 

pub struct CreateIndex {

    pub name: Option<ObjectName>,
    pub table_name: ObjectName,
    pub using: Option<IndexType>,
    pub columns: Vec<IndexColumn>,
    pub unique: bool,
    pub concurrently: bool,
    pub async: bool,
    pub if_not_exists: bool,
    pub include: Vec<Ident>,
    pub nulls_distinct: Option<bool>,
    pub with: Vec<Expr>,
    pub predicate: Option<Expr>,
    pub index_options: Vec<IndexOption>,
    pub alter_options: Vec<AlterTableOperation>,
    pub fulltext_or_spatial: Option<FullTextOrSpatialKind>,
}

CREATE INDEX statement.

Fields

name: Option<ObjectName>

index name

table_name: ObjectName

table name

using: Option<IndexType>

Index type used in the statement. Can also be found inside CreateIndex::index_options depending on the position of the option within the statement.

columns: Vec<IndexColumn>

columns included in the index

unique: bool

whether the index is unique

concurrently: bool

whether the index is created concurrently

async: bool

whether the index is created asynchronously (DSQL).

if_not_exists: bool

IF NOT EXISTS clause

include: Vec<Ident>

INCLUDE clause: https://www.postgresql.org/docs/current/sql-createindex.html

nulls_distinct: Option<bool>

NULLS DISTINCT / NOT DISTINCT clause: https://www.postgresql.org/docs/current/sql-createindex.html

with: Vec<Expr>

WITH clause: https://www.postgresql.org/docs/current/sql-createindex.html

predicate: Option<Expr>

WHERE clause: https://www.postgresql.org/docs/current/sql-createindex.html

index_options: Vec<IndexOption>

Index options: https://www.postgresql.org/docs/current/sql-createindex.html

alter_options: Vec<AlterTableOperation>

MySQL allows a subset of options normally used for ALTER TABLE:

• ALGORITHM
• LOCK

fulltext_or_spatial: Option<FullTextOrSpatialKind>

MySQL: when this index is a standalone CREATE FULLTEXT INDEX or CREATE SPATIAL INDEX, records which kind. None means a plain CREATE INDEX (or CREATE UNIQUE INDEX when unique is true).

Trait Implementations

impl Clone for CreateIndex

fn clone(&self) -> CreateIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CreateIndex

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

Formats the value using the given formatter.

impl Eq for CreateIndex

impl From<CreateIndex> for Statement

fn from(c: CreateIndex) -> Self

Converts to this type from the input type.

impl Hash for CreateIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CreateIndex

fn cmp(&self, other: &CreateIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CreateIndex

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CreateIndex

fn partial_cmp(&self, other: &CreateIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CreateIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for CreateIndex

fn span(&self) -> Span

Return the Span (the minimum and maximum Location) for this AST node, by recursively combining the spans of its children.

impl StructuralPartialEq for CreateIndex

impl Visit for CreateIndex

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

Visit this node with the provided Visitor.

impl VisitMut for CreateIndex

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>

Mutably visit this node with the provided VisitorMut.