Struct IndexBuilder 

pub struct IndexBuilder<'a, T> { /* private fields */ }

Configures an index declared by EntityTypeBuilder::has_index or EntityTypeBuilder::has_index_expression.

Implementations

impl<T> IndexBuilder<'_, T>

pub fn is_unique(&mut self) -> &mut Self

Marks the index UNIQUE.

pub fn has_name(&mut self, name: &'static str) -> &mut Self

Sets an explicit index name (otherwise derived from table + columns).

pub fn has_filter(&mut self, filter: impl Into<BoolExpr>) -> &mut Self

Turns the index into a partial index with the given predicate.

Applied as ... WHERE <predicate> on PostgreSQL/SQLite. MySQL has no partial indexes: a filtered unique index is emulated with a functional CASE WHEN unique index, and a filtered non-unique index is skipped with a warning comment.

pub fn include(&mut self, columns: &'static [&'static str]) -> &mut Self

Adds non-key included columns (INCLUDE (...)).

Supported by PostgreSQL; MySQL/SQLite emit a warning comment and create the index without the include list.