Skip to main content
Module

x/typeorm/src/index.ts>EntitySchemaIndexOptions

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

Properties

optional
name: string

Index name.

optional
columns: ((object?: any) => (any[] | { [key: string]: number; })) | string[]

Index column names.

optional
synchronize: boolean

Indicates if index must sync with database index.

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
unique: boolean

Indicates if this 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.