Struct IndexMetadata 

pub struct IndexMetadata {
    pub index_id: u32,
    pub name: String,
    pub table: String,
    pub columns: Vec<String>,
    pub column_indices: Vec<usize>,
    pub unique: bool,
    pub method: Option<IndexMethod>,
    pub options: Vec<(String, String)>,
}

Metadata for an index in the catalog.

Contains the index ID, name, target table, columns, uniqueness flag, index method, and optional parameters.

Examples

use alopex_sql::catalog::IndexMetadata;
use alopex_sql::ast::ddl::IndexMethod;

// Create a B-tree index on a single column
let btree_idx = IndexMetadata::new(1, "idx_users_name", "users", vec!["name".into()])
    .with_column_indices(vec![1])
    .with_method(IndexMethod::BTree);

assert_eq!(btree_idx.index_id, 1);
assert_eq!(btree_idx.name, "idx_users_name");
assert_eq!(btree_idx.table, "users");
assert_eq!(btree_idx.columns, vec!["name"]);
assert!(!btree_idx.unique);

// Create a unique composite index
let unique_idx = IndexMetadata::new(2, "idx_orders_composite", "orders", vec!["user_id".into(), "order_date".into()])
    .with_column_indices(vec![0, 2])
    .with_unique(true);

assert!(unique_idx.unique);
assert_eq!(unique_idx.columns.len(), 2);

Fields

index_id: u32

Unique index ID assigned by the catalog.

name: String

Index name.

table: String

Target table name.

columns: Vec<String>

Target column names (supports composite indexes).

column_indices: Vec<usize>

Column indices within the table (for IndexStorage).

unique: bool

Whether this is a UNIQUE index.

method: Option<IndexMethod>

Index method (BTree, Hnsw, etc.).

options: Vec<(String, String)>

Index options (e.g., HNSW parameters: m, ef_construction).

Implementations

impl IndexMetadata

pub fn new( index_id: u32, name: impl Into<String>, table: impl Into<String>, columns: Vec<String>, ) -> Self

Create a new index metadata with the given ID, name, table, and columns.

The index defaults to non-unique, with no method specified, empty column_indices, and no options.

Note

column_indices should be set via with_column_indices() after creation, typically resolved by the Executor when the table schema is available.

pub fn with_column_indices(self, indices: Vec<usize>) -> Self

Set the column indices (positions within the table).

pub fn with_unique(self, unique: bool) -> Self

Set whether this is a UNIQUE index.

pub fn with_method(self, method: IndexMethod) -> Self

Set the index method.

pub fn with_option( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add an index option.

pub fn with_options(self, options: Vec<(String, String)>) -> Self

Set multiple options at once.

pub fn get_option(&self, key: &str) -> Option<&str>

Get an option value by key.

Returns None if the option doesn’t exist.

pub fn covers_column(&self, column: &str) -> bool

Check if this index covers the given column name.

pub fn is_single_column(&self) -> bool

Check if this is a single-column index.

pub fn first_column(&self) -> Option<&str>

Get the first (or only) column name.

Returns None if no columns are defined.

Trait Implementations

impl Clone for IndexMetadata

fn clone(&self) -> IndexMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexMetadata

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

Formats the value using the given formatter.

impl From<&IndexMetadata> for PersistedIndexMeta

fn from(value: &IndexMetadata) -> Self

Converts to this type from the input type.

impl From<PersistedIndexMeta> for IndexMetadata

fn from(value: PersistedIndexMeta) -> Self

Converts to this type from the input type.