fraci
    Preparing search index...

    Interface DrizzleFraciConfig<F, T, FraciColumn, Group, Cursor>

    Configuration for using fractional indexing with Drizzle ORM. This type defines the structure needed to integrate fractional indexing into a Drizzle ORM database schema, including the table, column, and grouping information.

    interface DrizzleFraciConfig<
        F extends AnyFraci = AnyFraci,
        T extends Table = Table,
        FraciColumn extends
            DrizzleFraciColumn<FractionalIndexOf<F>> = DrizzleFraciColumn<
            FractionalIndexOf<F>,
        >,
        Group extends Record<string, Column> = Record<string, Column>,
        Cursor extends Record<string, Column> = Record<string, Column>,
    > {
        column: FraciColumn;
        cursor: Cursor;
        fraci: F;
        group: Group;
        table: T;
    }

    Type Parameters

    • F extends AnyFraci = AnyFraci

      The fractional indexing utility type

    • T extends Table = Table

      The Drizzle table type

    • FraciColumn extends DrizzleFraciColumn<FractionalIndexOf<F>> = DrizzleFraciColumn<FractionalIndexOf<F>>

      The column type that stores fractional indices

    • Group extends Record<string, Column> = Record<string, Column>

      The record type for grouping columns

    • Cursor extends Record<string, Column> = Record<string, Column>

      The record type for cursor columns

    Index

    Properties

    column: FraciColumn

    The column that stores the fractional index. Must be branded with the fractional index type using $type<FractionalIndexOf<F>>().

    cursor: Cursor

    The columns that uniquely identify a row within a group.

    fraci: F

    A fraci instance.

    group: Group

    The columns that define the grouping context for the fractional index.

    table: T

    The table to which the fractional index belongs.