Struct IndexDef 

pub struct IndexDef {
    pub table: &'static str,
    pub name: &'static str,
    pub columns: &'static [IndexColumnDef],
    pub is_unique: bool,
    pub where_clause: Option<&'static str>,
    pub origin: IndexOrigin,
}

Const-friendly index definition

Examples

use drizzle_types::sqlite::ddl::{IndexDef, IndexColumnDef};

const COLS: &[IndexColumnDef] = &[
    IndexColumnDef::new("email"),
    IndexColumnDef::new("created_at"),
];

const IDX: IndexDef = IndexDef::new("users", "idx_users_email")
    .unique()
    .columns(COLS);

Fields

table: &'static str

Parent table name

name: &'static str

Index name

columns: &'static [IndexColumnDef]

Index columns

is_unique: bool

Is this a UNIQUE index?

where_clause: Option<&'static str>

Optional WHERE clause for partial indexes

origin: IndexOrigin

How the index was created

Implementations

impl IndexDef

pub const fn new(table: &'static str, name: &'static str) -> Self

Create a new index definition

pub const fn unique(self) -> Self

Set unique constraint

pub const fn columns(self, columns: &'static [IndexColumnDef]) -> Self

Set columns

pub const fn where_clause(self, clause: &'static str) -> Self

Set WHERE clause for partial index

pub const fn auto_origin(self) -> Self

Set origin to auto (for UNIQUE constraint indexes)

pub fn into_index(self) -> Index

Convert to runtime Index type

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 Default for IndexDef

fn default() -> Self

Returns the “default value” for a type.

impl From<IndexDef> for Index

fn from(def: IndexDef) -> Self

Converts to this type from the input type.

impl Hash for IndexDef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 Copy for IndexDef

impl Eq for IndexDef

impl StructuralPartialEq for IndexDef