Struct IndexSchema 

pub struct IndexSchema {
    pub name: String,
    pub root_page: i32,
    pub columns: Vec<String>,
    pub key_expressions: Vec<String>,
    pub key_sort_directions: Vec<SortDirection>,
    pub where_clause: Option<String>,
    pub is_unique: bool,
    pub key_collations: Vec<Option<String>>,
    pub conflict_action: Option<ConflictAction>,
}

Index metadata needed for codegen (index-scan SELECT).

Fields

name: String

Index name.

root_page: i32

Root page number.

columns: Vec<String>

Indexed column names (leftmost first).

This is populated only when every key term is a plain column reference. Expression indexes keep their executable term SQL in key_expressions and leave columns empty so planner fast paths do not accidentally treat them as simple column-lookup indexes.

key_expressions: Vec<String>

Executable SQL for each key term in storage order.

key_sort_directions: Vec<SortDirection>

Sort direction for each logical key term.

Empty means “all ASC” for legacy callers/tests that do not yet populate per-term ordering metadata.

where_clause: Option<String>

Optional partial-index predicate as SQL text.

is_unique: bool

Whether this index enforces a UNIQUE constraint.

key_collations: Vec<Option<String>>

Per-key-term collation sequences (e.g. NOCASE, RTRIM).

None means “use the default (BINARY) collation” for that position. Empty vec means “all BINARY” for legacy callers/tests.

conflict_action: Option<ConflictAction>

Conflict-resolution algorithm declared on the UNIQUE / PRIMARY KEY constraint backing this index via ON CONFLICT <algo>. None means the default (ABORT) unless overridden by a statement-level INSERT OR <algo>.

Implementations

impl IndexSchema

pub fn key_term_count(&self) -> usize

Number of logical key terms before the trailing rowid suffix.

pub fn key_term_sql(&self, key_pos: usize) -> Option<&str>

Return the SQL fragment for the key_posth key term.

pub fn key_term_descending(&self, key_pos: usize) -> bool

Whether the key_posth logical key term sorts descending.

pub fn key_term_collation(&self, key_pos: usize) -> Option<&str>

Return the collation sequence for the key_posth key term, if any.

pub fn supports_direct_column_lookup(&self) -> bool

Whether planner / lookup fast paths may safely treat this as a simple non-partial column index.

pub fn supports_replace_cleanup_meta(&self) -> bool

Whether REPLACE cleanup metadata can reconstruct the key from raw row payload columns alone.

pub fn key_label(&self) -> String

Human-readable key label for diagnostics / constraint errors.

Trait Implementations

impl Clone for IndexSchema

fn clone(&self) -> IndexSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexSchema

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

Formats the value using the given formatter.

impl Eq for IndexSchema

impl PartialEq for IndexSchema

fn eq(&self, other: &IndexSchema) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for IndexSchema