docs: index hints

lib/dialects/abstract/query-generator.js

@@ -16,7 +16,7 @@ const BelongsToMany = require('../../associations/belongs-to-many');
 const HasMany = require('../../associations/has-many');
 const HasMany = require('../../associations/has-many');
 const Op = require('../../operators');
 const Op = require('../../operators');
 const sequelizeError = require('../../errors');
 const sequelizeError = require('../../errors');
-const { IndexHints } = require('../../index-hints');
+const IndexHints = require('../../index-hints');
 
 
 const QuoteHelper = require('./query-generator/helpers/quote');
 const QuoteHelper = require('./query-generator/helpers/quote');
 
 

lib/index-hints.js

@@ -7,7 +7,7 @@
  * @property FORCE
  * @property FORCE
  * @property IGNORE
  * @property IGNORE
  */
  */
-exports.IndexHints = { // eslint-disable-line
+const IndexHints = module.exports = { // eslint-disable-line
   USE: 'USE',
   USE: 'USE',
   FORCE: 'FORCE',
   FORCE: 'FORCE',
   IGNORE: 'IGNORE'
   IGNORE: 'IGNORE'

lib/sequelize.js

@@ -15,6 +15,7 @@ const QueryInterface = require('./query-interface');
 const Transaction = require('./transaction');
 const Transaction = require('./transaction');
 const QueryTypes = require('./query-types');
 const QueryTypes = require('./query-types');
 const TableHints = require('./table-hints');
 const TableHints = require('./table-hints');
+const IndexHints = require('./index-hints');
 const sequelizeErrors = require('./errors');
 const sequelizeErrors = require('./errors');
 const Promise = require('./promise');
 const Promise = require('./promise');
 const Hooks = require('./hooks');
 const Hooks = require('./hooks');
@@ -1228,6 +1229,12 @@ Sequelize.Promise = Promise;
 Sequelize.TableHints = TableHints;
 Sequelize.TableHints = TableHints;
 
 
 /**
 /**
+ * Available index hints to be used for querying data in mysql for index hints
+ * @see {@link IndexHints}
+ */
+Sequelize.IndexHints = IndexHints;
+
+/**
  * A reference to the sequelize transaction class. Use this to access isolationLevels and types when creating a transaction
  * A reference to the sequelize transaction class. Use this to access isolationLevels and types when creating a transaction
  * @see {@link Transaction}
  * @see {@link Transaction}
  * @see {@link Sequelize.transaction}
  * @see {@link Sequelize.transaction}

test/unit/dialects/mysql/query-generator.test.js

@@ -6,7 +6,7 @@ const chai = require('chai'),
   dialect = Support.getTestDialect(),
   dialect = Support.getTestDialect(),
   _ = require('lodash'),
   _ = require('lodash'),
   Op = require('../../../../lib/operators'),
   Op = require('../../../../lib/operators'),
-  { IndexHints } = require('../../../../lib/index-hints'),
+  IndexHints = require('../../../../lib/index-hints'),
   QueryGenerator = require('../../../../lib/dialects/mysql/query-generator');
   QueryGenerator = require('../../../../lib/dialects/mysql/query-generator');
 
 
 if (dialect === 'mysql') {
 if (dialect === 'mysql') {