Index metadata contains all information about table's index.
Map of column names with order set. Used only by MongoDB driver.
Embedded metadata if this index was applied on embedded.
Entity metadata of the class to which this index is applied.
Specifies a time to live, in seconds. This option is only supported for mongodb database.
User specified column names.
User specified index name.
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.
The FULLTEXT modifier indexes the entire column and does not allow prefixing. Works only in MySQL.
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.
The SPATIAL modifier indexes the entire column and does not allow indexed columns to contain NULL values. Works only in MySQL.
Indicates if this index must be unique.
Final index name. If index name was given by a user then it stores normalized (by naming strategy) givenName. If index name was not given then its generated.
Indicates if this index must synchronize with database index.
Target class to which metadata is applied.
Index filter condition.
Builds some depend index properties. Must be called after all entity metadata's properties map, columns and relations are built.
Generated using TypeDoc