foxhound 2.0.8 → 2.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "foxhound",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "A Database Query generation library.",
   "main": "source/FoxHound.js",
   "scripts": {

package/source/FoxHound.js

@@ -852,6 +852,19 @@ var FoxHound = function()
 				enumerable: true
 			});
 
+		/**
+		 * Query
+		 *
+		 * @property query
+		 * @type Object
+		 */
+		Object.defineProperty(tmpNewFoxHoundObject, 'indexHints',
+			{
+				get: function() { return _Parameters.indexHints; },
+				set: function(pHints) { _Parameters.indexHints = pHints; },
+				enumerable: true,
+			});
+
 		/**
 		 * Result
 		 *

package/source/Parameters.js

@@ -78,7 +78,12 @@ var FoxHoundQueryParameters = (
 				parameters: {}
 			}
 		*/
-		
+
+		indexHints: false,
+		/*
+			['IndexName1', 'IndexName2'] // A list of index names to hint to the underlying provider, if supported
+		 */
+
 		// Who is making the query
 		userID: 0,
 
@@ -93,4 +98,4 @@ var FoxHoundQueryParameters = (
 		*/
 });
 
-module.exports = FoxHoundQueryParameters;
+module.exports = FoxHoundQueryParameters;

package/source/dialects/MicrosoftSQL/FoxHound-Dialect-MSSQL.js

@@ -355,7 +355,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 	*
 	* @method: generateLimit
 	* @param: {Object} pParameters SQL Query Parameters
-	* @return: {String} Returns the table name clause
+	* @return: {String} Returns the table limit clause
 	*/
 	var generateLimit = function(pParameters)
 	{
@@ -380,6 +380,23 @@ var FoxHoundDialectMSSQL = function(pFable)
 		return tmpLimit;
 	};
 
+	/**
+	* Generate the an index hinting clause
+	*
+	* @method: generateIndexHints
+	* @param: {Object} pParameters SQL Query Parameters
+	* @return: {String} Returns the table index hint clause
+	*/
+	var generateIndexHints = function(pParameters)
+	{
+		if (!Array.isArray(pParameters.indexHints) || pParameters.indexHints.length < 1)
+		{
+			return '';
+		}
+
+		return ` WITH(INDEX(${pParameters.indexHints.join(',')}))`
+	};
+
 	/**
 	* Generate the join clause
 	*
@@ -909,6 +926,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 		var tmpJoin = generateJoins(pParameters);
 		var tmpOrderBy = generateOrderBy(pParameters);
 		var tmpLimit = generateLimit(pParameters);
+		var tmpIndexHints = generateIndexHints(pParameters);
 		const tmpOptDistinct = pParameters.distinct ? ' DISTINCT' : '';
 
 		if (pParameters.queryOverride)
@@ -916,7 +934,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 			try
 			{
 				var tmpQueryTemplate = _Fable.Utility.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, Join:tmpJoin, OrderBy:tmpOrderBy, Limit:tmpLimit, Distinct: tmpOptDistinct, _Params: pParameters});
+				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, Join:tmpJoin, OrderBy:tmpOrderBy, Limit:tmpLimit, IndexHints: tmpIndexHints, Distinct: tmpOptDistinct, _Params: pParameters});
 			}
 			catch (pError)
 			{
@@ -926,7 +944,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 			}
 		}
 
-		return `SELECT${tmpOptDistinct}${tmpFieldList} FROM${tmpTableName}${tmpJoin}${tmpWhere}${tmpOrderBy}${tmpLimit};`;
+		return `SELECT${tmpOptDistinct}${tmpFieldList} FROM${tmpTableName}${tmpIndexHints}${tmpJoin}${tmpWhere}${tmpOrderBy}${tmpLimit};`;
 	};
 
 	var Update = function(pParameters)
@@ -989,6 +1007,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 		var tmpTableName = generateTableName(pParameters);
 		var tmpJoin = generateJoins(pParameters);
 		var tmpWhere = generateWhere(pParameters);
+		var tmpIndexHints = generateIndexHints(pParameters);
 		// here, we ignore the distinct keyword if no fields have been specified and
 		if (pParameters.distinct && tmpFieldList.length < 1)
 		{
@@ -1001,7 +1020,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 			try
 			{
 				var tmpQueryTemplate = _Fable.Utility.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', Limit:'', Distinct: tmpOptDistinct, _Params: pParameters});
+				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', IndexHints: tmpIndexHints, Limit:'', Distinct: tmpOptDistinct, _Params: pParameters});
 			}
 			catch (pError)
 			{
@@ -1011,7 +1030,7 @@ var FoxHoundDialectMSSQL = function(pFable)
 			}
 		}
 
-		return `SELECT COUNT(${tmpOptDistinct}${tmpFieldList || '*'}) AS Row_Count FROM${tmpTableName}${tmpJoin}${tmpWhere};`;
+		return `SELECT COUNT(${tmpOptDistinct}${tmpFieldList || '*'}) AS Row_Count FROM${tmpTableName}${tmpIndexHints}${tmpJoin}${tmpWhere};`;
 	};
 
 	var tmpDialect = ({

package/source/dialects/MySQL/FoxHound-Dialect-MySQL.js

@@ -296,7 +296,7 @@ var FoxHoundDialectMySQL = function(pFable)
 	*
 	* @method: generateLimit
 	* @param: {Object} pParameters SQL Query Parameters
-	* @return: {String} Returns the table name clause
+	* @return: {String} Returns the table limit clause
 	*/
 	var generateLimit = function(pParameters)
 	{
@@ -317,6 +317,23 @@ var FoxHoundDialectMySQL = function(pFable)
 		return tmpLimit;
 	};
 
+	/**
+	* Generate the use index clause
+	*
+	* @method: generateIndexHints
+	* @param: {Object} pParameters SQL Query Parameters
+	* @return: {String} Returns the table limit clause
+	*/
+	var generateIndexHints = function(pParameters)
+	{
+		if (!Array.isArray(pParameters.indexHints) || pParameters.indexHints.length < 1)
+		{
+			return '';
+		}
+
+		return ` USE INDEX (${pParameters.indexHints.join(',')})`;
+	};
+
 	/**
 	* Generate the join clause
 	*
@@ -827,6 +844,7 @@ var FoxHoundDialectMySQL = function(pFable)
 		var tmpJoin = generateJoins(pParameters);
 		var tmpOrderBy = generateOrderBy(pParameters);
 		var tmpLimit = generateLimit(pParameters);
+		var tmpIndexHints = generateIndexHints(pParameters);
 		const tmpOptDistinct = pParameters.distinct ? ' DISTINCT' : '';
 
 		if (pParameters.queryOverride)
@@ -834,7 +852,7 @@ var FoxHoundDialectMySQL = function(pFable)
 			try
 			{
 				var tmpQueryTemplate = _Fable.Utility.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, Join:tmpJoin, OrderBy:tmpOrderBy, Limit:tmpLimit, Distinct: tmpOptDistinct, _Params: pParameters});
+				return tmpQueryTemplate({FieldList:tmpFieldList, TableName:tmpTableName, Where:tmpWhere, Join:tmpJoin, OrderBy:tmpOrderBy, Limit:tmpLimit, IndexHints: tmpIndexHints, Distinct: tmpOptDistinct, _Params: pParameters});
 			}
 			catch (pError)
 			{
@@ -844,7 +862,7 @@ var FoxHoundDialectMySQL = function(pFable)
 			}
 		}
 
-		return `SELECT${tmpOptDistinct}${tmpFieldList} FROM${tmpTableName}${tmpJoin}${tmpWhere}${tmpOrderBy}${tmpLimit};`;
+		return `SELECT${tmpOptDistinct}${tmpFieldList} FROM${tmpTableName}${tmpIndexHints}${tmpJoin}${tmpWhere}${tmpOrderBy}${tmpLimit};`;
 	};
 
 	var Update = function(pParameters)
@@ -907,6 +925,7 @@ var FoxHoundDialectMySQL = function(pFable)
 		var tmpTableName = generateTableName(pParameters);
 		var tmpJoin = generateJoins(pParameters);
 		var tmpWhere = generateWhere(pParameters);
+		var tmpIndexHints = generateIndexHints(pParameters);
 		// here, we ignore the distinct keyword if no fields have been specified and
 		if (pParameters.distinct && tmpFieldList.length < 1)
 		{
@@ -919,7 +938,7 @@ var FoxHoundDialectMySQL = function(pFable)
 			try
 			{
 				var tmpQueryTemplate = _Fable.Utility.template(pParameters.queryOverride);
-				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', Limit:'', Distinct: tmpOptDistinct, _Params: pParameters});
+				return tmpQueryTemplate({FieldList:[], TableName:tmpTableName, Where:tmpWhere, OrderBy:'', Limit:'', IndexHints: tmpIndexHints, Distinct: tmpOptDistinct, _Params: pParameters});
 			}
 			catch (pError)
 			{
@@ -929,7 +948,7 @@ var FoxHoundDialectMySQL = function(pFable)
 			}
 		}
 
-		return `SELECT COUNT(${tmpOptDistinct}${tmpFieldList || '*'}) AS RowCount FROM${tmpTableName}${tmpJoin}${tmpWhere};`;
+		return `SELECT COUNT(${tmpOptDistinct}${tmpFieldList || '*'}) AS RowCount FROM${tmpTableName}${tmpIndexHints}${tmpJoin}${tmpWhere};`;
 	};
 
 	var tmpDialect = ({

package/test/FoxHound-Dialect-MySQL_tests.js

@@ -124,6 +124,22 @@ suite
 					}
 				);
 				test
+				(
+					'Read Query with Index Hints',
+					function()
+					{
+						var tmpQuery = libFoxHound.new(_Fable).setDialect('MySQL').setScope('Animal');
+						tmpQuery.addSort({Column:'Cost',Direction:'Descending'});
+						tmpQuery.indexHints = ['AnimalIndex_1', 'AnimalIndex_2'];
+						// Build the query
+						tmpQuery.buildReadQuery();
+						// This is the query generated by the MySQL dialect
+						_Fable.log.trace('Simple Select Query', tmpQuery.query);
+						Expect(tmpQuery.query.body)
+							.to.equal('SELECT `Animal`.* FROM `Animal` USE INDEX (AnimalIndex_1,AnimalIndex_2) ORDER BY Cost DESC;');
+					}
+				);
+				test
 				(
 					'Read Query with Distinct',
 					function()
@@ -244,14 +260,15 @@ suite
 							.setDataElements(['Name', 'Age', 'Cost'])
 							.setSort([{Column:'Age',Direction:'Ascending'},{Column:'Cost',Direction:'Descending'}])
 							.setFilter({Column:'Age',Operator:'=',Value:'15',Connector:'AND',Parameter:'Age'});
+						tmpQuery.indexHints = ['AnimalIndex_1', 'AnimalIndex_2'];
 						tmpQuery.parameters.CustomFields = 'Name, Age * 5, Cost';
-						tmpQuery.parameters.queryOverride = 'SELECT <%= _Params.CustomFields %> FROM <%= TableName %> <%= Where %> <%= Limit %>;';
+						tmpQuery.parameters.queryOverride = 'SELECT <%= _Params.CustomFields %> FROM <%= TableName %><%= IndexHints %> <%= Where %> <%= Limit %>;';
 						// Build the query
 						tmpQuery.buildReadQuery();
 						// This is the query generated by the MySQL dialect
 						_Fable.log.trace('Custom Select Query', tmpQuery.query);
 						Expect(tmpQuery.query.body)
-							.to.equal('SELECT Name, Age * 5, Cost FROM  `Animal`  WHERE Age = :Age_w0  LIMIT 0, 10;');
+							.to.equal('SELECT Name, Age * 5, Cost FROM  `Animal` USE INDEX (AnimalIndex_1,AnimalIndex_2)  WHERE Age = :Age_w0  LIMIT 0, 10;');
 					}
 				);
 				test
@@ -303,13 +320,14 @@ suite
 							.setDialect('MySQL')
 							.setScope('Animal')
 							.setFilter({Column:'Age',Operator:'=',Value:'15',Connector:'AND',Parameter:'Age'});
-						tmpQuery.parameters.queryOverride = 'SELECT COUNT(*) AS RowCount FROM <%= TableName %> <%= Where %>;';
+						tmpQuery.indexHints = ['AnimalIndex_1', 'AnimalIndex_2'];
+						tmpQuery.parameters.queryOverride = 'SELECT COUNT(*) AS RowCount FROM <%= TableName %><%= IndexHints %> <%= Where %>;';
 						// Build the query
 						tmpQuery.buildCountQuery();
 						// This is the query generated by the MySQL dialect
 						_Fable.log.trace('Custom Count Query', tmpQuery.query);
 						Expect(tmpQuery.query.body)
-							.to.equal('SELECT COUNT(*) AS RowCount FROM  `Animal`  WHERE Age = :Age_w0;');
+							.to.equal('SELECT COUNT(*) AS RowCount FROM  `Animal` USE INDEX (AnimalIndex_1,AnimalIndex_2)  WHERE Age = :Age_w0;');
 					}
 				);
 				test

package/test/Foxhound-Dialect-MSSQL_tests.js

@@ -126,6 +126,22 @@ suite
 					}
 				);
 				test
+				(
+					'Read Query with Index Hinting',
+					function()
+					{
+						var tmpQuery = libFoxHound.new(_Fable).setDialect('MSSQL').setScope('Animal');
+						tmpQuery.addSort({Column:'Cost',Direction:'Descending'});
+						tmpQuery.indexHints = ['AnimalIndex_1'];
+						// Build the query
+						tmpQuery.buildReadQuery();
+						// This is the query generated by the MSSQL dialect
+						_Fable.log.trace('Simple Select Query', tmpQuery.query);
+						Expect(tmpQuery.query.body)
+							.to.equal('SELECT Animal.* FROM Animal WITH(INDEX(AnimalIndex_1)) ORDER BY Cost DESC;');
+					}
+				);
+				test
 				(
 					'Read Query with Distinct',
 					function()
@@ -301,7 +317,7 @@ suite
 							.setDialect('MSSQL')
 							.setScope('Animal')
 							.setFilter({Column:'Age',Operator:'=',Value:'15',Connector:'AND',Parameter:'Age'});
-						tmpQuery.parameters.queryOverride = 'SELECT COUNT(*) AS RowCount FROM <%= TableName %> <%= Where %>;';
+						tmpQuery.parameters.queryOverride = 'SELECT COUNT(*) AS RowCount FROM <%= TableName %><%= IndexHints %> <%= Where %>;';
 						// Build the query
 						tmpQuery.buildCountQuery();
 						// This is the query generated by the MSSQL dialect
@@ -311,6 +327,25 @@ suite
 					}
 				);
 				test
+				(
+					'Custom Count Query with Index Hinting',
+					function()
+					{
+						var tmpQuery = libFoxHound.new(_Fable)
+							.setDialect('MSSQL')
+							.setScope('Animal')
+							.setFilter({Column:'Age',Operator:'=',Value:'15',Connector:'AND',Parameter:'Age'});
+						tmpQuery.indexHints = ['AnimalIndex_1'];
+						tmpQuery.parameters.queryOverride = 'SELECT COUNT(*) AS RowCount FROM <%= TableName %><%= IndexHints %> <%= Where %>;';
+						// Build the query
+						tmpQuery.buildCountQuery();
+						// This is the query generated by the MSSQL dialect
+						_Fable.log.trace('Custom Count Query', tmpQuery.query);
+						Expect(tmpQuery.query.body)
+							.to.equal('SELECT COUNT(*) AS RowCount FROM  Animal WITH(INDEX(AnimalIndex_1))  WHERE Age = @Age_w0;');
+					}
+				);
+				test
 				(
 					'Custom Count Query with Custom Parameters',
 					function()
@@ -390,13 +425,14 @@ suite
 						var tmpQuery = libFoxHound.new(_Fable)
 							.setDialect('MSSQL')
 							.setScope('Animal');
+						tmpQuery.indexHints = ['AnimalIndex_1'];
 
 						// Build the query
 						tmpQuery.buildCountQuery();
 						// This is the query generated by the MSSQL dialect
 						_Fable.log.trace('Count Query', tmpQuery.query);
 						Expect(tmpQuery.query.body)
-							.to.equal('SELECT COUNT(*) AS Row_Count FROM Animal;');
+							.to.equal('SELECT COUNT(*) AS Row_Count FROM Animal WITH(INDEX(AnimalIndex_1));');
 					}
 				);
 				test