Struct IndexDef 

pub struct IndexDef {
    pub name: IndexName,
    pub columns: Vec<ColumnName>,
    pub unique: bool,
}

A named index on one or more columns of a table.

Index names follow the convention ix_{table}__{columns} (double underscore separator). When unique is true the index also enforces a uniqueness constraint, equivalent to a UNIQUE constraint but expressed as an index.

IndexDef is the normalized form produced from inline "index" declarations on columns. You rarely construct this directly; use the "index" field on a ColumnDef in your model JSON and let the planner normalize it.

Fields

name: IndexName

The index name, conventionally ix_{table}__{columns}.

columns: Vec<ColumnName>

The ordered list of columns included in the index.

unique: bool

When true, the index enforces uniqueness across the listed columns.

Trait Implementations

impl Clone for IndexDef

fn clone(&self) -> IndexDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for IndexDef

impl JsonSchema for IndexDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for IndexDef

fn eq(&self, other: &IndexDef) -> 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 Serialize for IndexDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for IndexDef