Skip to main content
Module

x/typeorm/src/index.ts>IndexOptions

Forked from https://github.com/typeorm/typeorm
denolib/typeorm
Latest
interface IndexOptions
Re-export
import { type IndexOptions } from "https://deno.land/x/typeorm@v0.2.23-rc10/src/index.ts";

Describes all index options.

Properties

optional
unique: boolean

Indicates if this composite index must be unique or not.

optional
spatial: boolean

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

optional
fulltext: boolean

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

optional
where: string

Index filter condition.

optional
sparse: boolean

If true, the index only references documents with the specified field. These indexes use less space but behave differently in some situations (particularly sorts). This option is only supported for mongodb database.

optional
background: boolean

Builds the index in the background so that building an index an does not block other database activities. This option is only supported for mongodb database.

optional
expireAfterSeconds: number

Specifies a time to live, in seconds. This option is only supported for mongodb database.