Member Junction
    Preparing search index...

    Interface IndexOptions

    Options for generating index DDL.

    interface IndexOptions {
        columns: string[];
        includeColumns?: string[];
        indexName: string;
        method?: string;
        schema: string;
        tableName: string;
        unique?: boolean;
        where?: string;
    }
    Index

    Properties

    columns includeColumns? indexName method? schema tableName unique? where?

    Properties

    columns: string[]

    Columns to index

    includeColumns?: string[]

    INCLUDE columns (SQL Server covering index)

    indexName: string

    Index name

    method?: string

    Index method (btree, gin, gist, hash — PostgreSQL specific, ignored for SQL Server)

    schema: string

    Schema name

    tableName: string

    Table name

    unique?: boolean

    Whether this is a unique index

    where?: string

    WHERE clause for partial indexes (PostgreSQL only)

    Settings

    Member Visibility

    On This Page

    Properties