Skip to main content

Crate use_pg_index

Crate use_pg_index 

Source
Expand description

§use-pg-index

PostgreSQL index primitives for RustUse.

This crate provides index names, access-method labels, index columns, expression labels, predicate labels, and flag metadata. It does not generate or execute SQL.

§Example

use use_pg_index::{PgIndex, PgIndexColumn, PgIndexFlags, PgIndexMethod, PgIndexName};

let index = PgIndex::new(PgIndexName::new("users_email_idx")?)
    .with_method(PgIndexMethod::Btree)
    .with_columns(vec![PgIndexColumn::new("email")?])
    .with_flags(PgIndexFlags::default().unique(true));

assert_eq!(index.method(), PgIndexMethod::Btree);
assert_eq!(index.columns().len(), 1);
assert!(index.flags().is_unique());

Structs§

PgIndex
PostgreSQL index metadata without SQL generation or execution.
PgIndexColumn
PostgreSQL index column label.
PgIndexExpression
PostgreSQL index expression label.
PgIndexFlags
PostgreSQL index flag metadata.
PgIndexName
PostgreSQL index name primitive.

Enums§

PgIndexError
Error returned when PostgreSQL index metadata is invalid.
PgIndexMethod
PostgreSQL index access methods.