Struct IndexColumn 

pub struct IndexColumn {
    pub name: String,
    pub expression: Option<Expr>,
    pub descending: bool,
    pub nulls: Option<NullsOrder>,
    pub collation: Option<String>,
    pub opclass: Option<String>,
}

One entry of an index: either a plain column or an expression, with optional ordering, null placement, collation, and operator class.

Examples

use tork_orm_core::IndexColumn;

let column = IndexColumn::new("created_at").desc().nulls_last();
assert!(column.descending);

Fields

name: String

The column name. Empty when this entry is an expression.

expression: Option<Expr>

A functional-index expression; when set, it is indexed instead of name.

descending: bool

Whether the entry is indexed in descending order.

nulls: Option<NullsOrder>

Where NULLs sort, if specified.

collation: Option<String>

A collation to index under (e.g. NOCASE).

opclass: Option<String>

A backend-specific operator class (e.g. gin_trgm_ops); Postgres-only.

Implementations

impl IndexColumn

pub fn new(name: impl Into<String>) -> Self

Builds an ascending index column over a named column.

pub fn expression(expression: Expr) -> Self

Builds a functional index entry over an expression, such as lower(email).

pub fn asc(self) -> Self

Marks the entry ascending (the default).

pub fn desc(self) -> Self

Marks the entry descending.

pub fn nulls_first(self) -> Self

Sorts NULLs first.

pub fn nulls_last(self) -> Self

Sorts NULLs last.

pub fn collate(self, collation: impl Into<String>) -> Self

Sets the collation to index under.

pub fn opclass(self, opclass: impl Into<String>) -> Self

Sets the column’s operator class (Postgres).

Trait Implementations

impl Clone for IndexColumn

fn clone(&self) -> IndexColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexColumn

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

Formats the value using the given formatter.