fix(types): add index hints (#10815)

types/index.d.ts

@@ -3,6 +3,7 @@ import Deferrable = require('./lib/deferrable');
 import Op = require('./lib/operators');
 import QueryTypes = require('./lib/query-types');
 import TableHints = require('./lib/table-hints');
+import IndexHints = require('./lib/index-hints');
 import Utils = require('./lib/utils');
 
 export * from './lib/sequelize';
@@ -15,5 +16,5 @@ export * from './lib/errors';
 export { BaseError as Error } from './lib/errors';
 export { useInflection } from './lib/utils';
 export { Promise } from './lib/promise';
-export { Utils, QueryTypes, Op, TableHints, DataTypes, Deferrable };
+export { Utils, QueryTypes, Op, TableHints, IndexHints, DataTypes, Deferrable };
 export { Validator as validator } from './lib/utils/validator-extras';

types/lib/index-hints.d.ts

+/**
+ * Available index hints to be used for querying data in mysql for index hints.
+ */
+declare enum IndexHints {
+  USE = 'USE',
+  FORCE = 'FORCE',
+  IGNORE = 'IGNORE'
+}
+
+export = IndexHints;

types/lib/model.d.ts

@@ -20,6 +20,7 @@ import { QueryOptions } from './query-interface';
 import { Config, Options, Sequelize, SyncOptions } from './sequelize';
 import { Transaction } from './transaction';
 import { Col, Fn, Literal, Where } from './utils';
+import { IndexHints } from '..';
 
 export interface Logging {
   /**
@@ -432,12 +433,24 @@ export type FindAttributeOptions =
       include: (string | ProjectionAlias)[];
     };
 
+export interface IndexHint {
+  type: IndexHints;
+  value: string[];
+}
+
+export interface IndexHintable {
+  /**
+   * MySQL only.
+   */
+  indexHints?: IndexHint[];
+}
+
 /**
  * Options that are passed to any model creating a SELECT query
  *
  * A hash of options to describe the scope of the search
  */
-export interface FindOptions extends QueryOptions, Filterable, Projectable, Paranoid {
+export interface FindOptions extends QueryOptions, Filterable, Projectable, Paranoid, IndexHintable {
   /**
    * A list of associations to eagerly load using a left join. Supported is either
    * `{ include: [ Model1, Model2, ...]}`, `{ include: [{ model: Model1, as: 'Alias' }]}` or

types/test/index-hints.ts

+import { User } from 'models/User';
+import { IndexHints } from '..';
+
+User.findAll({
+  indexHints: [{
+    type: IndexHints.FORCE,
+    value: ['some_index'],
+  }],
+})