UNPKG

1.84 kBSource Map (JSON)View Raw
1{"version":3,"sources":["../../src/metadata-args/IndexMetadataArgs.ts"],"names":[],"mappings":"","file":"IndexMetadataArgs.js","sourcesContent":["/**\n * Arguments for IndexMetadata class.\n */\nexport interface IndexMetadataArgs {\n\n /**\n * Class to which index is applied.\n */\n target: Function|string;\n\n /**\n * Index name.\n */\n name?: string;\n\n /**\n * Columns combination to be used as index.\n */\n columns?: ((object?: any) => (any[]|{ [key: string]: number }))|string[];\n\n /**\n * Indicates if index must be unique or not.\n */\n unique?: boolean;\n\n /**\n * The SPATIAL modifier indexes the entire column and does not allow indexed columns to contain NULL values.\n * Works only in MySQL.\n */\n spatial?: boolean;\n\n /**\n * The FULLTEXT modifier indexes the entire column and does not allow prefixing.\n * Works only in MySQL.\n */\n fulltext?: boolean;\n\n /**\n * Index filter condition.\n */\n where?: string;\n\n /**\n * Indicates if index must sync with database index.\n */\n synchronize?: boolean;\n\n /**\n * If true, the index only references documents with the specified field.\n * These indexes use less space but behave differently in some situations (particularly sorts).\n * This option is only supported for mongodb database.\n */\n sparse?: boolean;\n\n /**\n * Builds the index in the background so that building an index an does not block other database activities.\n * This option is only supported for mongodb database.\n */\n background?: boolean;\n\n /**\n * Specifies a time to live, in seconds.\n * This option is only supported for mongodb database.\n */\n expireAfterSeconds?: number;\n}\n"],"sourceRoot":".."}
\No newline at end of file