API 参考
    正在准备搜索索引...

    Database's table index stored in this class.

    索引

    构造函数

    • 参数

      返回 TableIndex

    属性

    "@instanceof": symbol
    columnNames: string[]

    Columns included in this index.

    isConcurrent: boolean

    Create the index using the CONCURRENTLY modifier Works only in postgres.

    isFulltext: boolean

    The FULLTEXT modifier indexes the entire column and does not allow prefixing. Works only in MySQL.

    isNullFiltered: boolean

    NULL_FILTERED indexes are particularly useful for indexing sparse columns, where most rows contain a NULL value. In these cases, the NULL_FILTERED index can be considerably smaller and more efficient to maintain than a normal index that includes NULL values.

    Works only in Spanner.

    isSpatial: boolean

    The SPATIAL modifier indexes the entire column and does not allow indexed columns to contain NULL values. Works only in MySQL.

    isUnique: boolean

    Indicates if this index is unique.

    name?: string

    Index name.

    parser?: string

    Fulltext parser. Works only in MySQL.

    where: string

    Index filter condition.

    方法

    • Creates a new copy of this index with exactly same properties.

      返回 TableIndex

    • Creates index from the index metadata object.

      参数

      • indexMetadata: IndexMetadata

      返回 TableIndex