forked from typeorm/typeorm
/
TableIndexOptions.ts
48 lines (39 loc) · 1009 Bytes
/
TableIndexOptions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/**
* Database's table index options.
*/
export interface TableIndexOptions {
// -------------------------------------------------------------------------
// Public Properties
// -------------------------------------------------------------------------
/**
* Constraint name.
*/
name?: string;
/**
* Columns included in this index.
*/
columnNames: string[];
/**
* Indicates if this index is unique.
*/
isUnique?: boolean;
/**
* The SPATIAL modifier indexes the entire column and does not allow indexed columns to contain NULL values.
* Works only in MySQL.
*/
isSpatial?: boolean;
/**
* The FULLTEXT modifier indexes the entire column and does not allow prefixing.
* Supported only in MySQL & SAP HANA.
*/
isFulltext?: boolean;
/**
* Fulltext parser.
* Works only in MySQL.
*/
parser?: string;
/**
* Index filter condition.
*/
where?: string;
}