Struct IndexMeta 

pub struct IndexMeta {
    pub name: Option<Cow<'static, str>>,
    pub columns: Vec<IndexColumn>,
    pub is_unique: bool,
    pub filter: Option<BoolExpr>,
    pub include: Vec<Cow<'static, str>>,
}

A declarative (possibly composite, partial, or expression) index.

Produced by crate::model_builder::EntityTypeBuilder::has_index and consumed by the migration engine. A filter turns the index into a partial index on PostgreSQL/SQLite; on MySQL a filtered unique index is emulated with a functional (CASE WHEN) unique index because MySQL has no partial indexes. Filtered non-unique indexes are skipped on MySQL.

Fields

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

Explicit index name. None → derived from table + key parts.

columns: Vec<IndexColumn>

Index key parts, in order.

is_unique: bool

Whether this is a UNIQUE index.

filter: Option<BoolExpr>

Optional partial-index predicate (WHERE <expr>).

include: Vec<Cow<'static, str>>

Included (non-key) columns (INCLUDE (...)); PostgreSQL only.

Implementations

impl IndexMeta

pub fn derive_name(&self, table: &str) -> String

Derives the default index name for table from its key parts.

Format: ix_<table>_<part1>_<part2>..., sanitized to identifier-safe characters and truncated to 64 characters (MySQL’s identifier limit).

Trait Implementations

impl Clone for IndexMeta

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 IndexMeta

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

Formats the value using the given formatter.

impl Default for IndexMeta

fn default() -> Self

Returns the “default value” for a type.