Struct datamodel_renderer::datamodel::IndexDefinition

pub struct IndexDefinition<'a>(/* private fields */);

Defines an index in a model block.

Implementations

impl<'a> IndexDefinition<'a>

pub fn index(fields: impl Iterator<Item = IndexFieldInput<'a>>) -> Self

A normal index, defined as @@index.

pub fn unique(fields: impl Iterator<Item = IndexFieldInput<'a>>) -> Self

A unique constraint, defined as @@unique.

pub fn fulltext(fields: impl Iterator<Item = IndexFieldInput<'a>>) -> Self

A fulltext index, defined as @@fulltext.

pub fn name(&mut self, name: impl Into<Cow<'a, str>>)

The client name of the index, defined as the name argument inside the attribute.

pub fn map(&mut self, map: impl Into<Cow<'a, str>>)

The constraint name in the database, defined as the map argument inside the attribute.

pub fn clustered(&mut self, clustered: bool)

Defines the clustered argument inside the attribute.

pub fn index_type(&mut self, index_type: impl Into<Cow<'a, str>>)

Defines the type argument inside the attribute.

Trait Implementations

impl<'a> Debug for IndexDefinition<'a>

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

Formats the value using the given formatter.

impl<'a> Display for IndexDefinition<'a>

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

Formats the value using the given formatter.