From 692c07ba74c7a7b578419bc6dd6225ded4d73e7a Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Wed, 14 Sep 2016 21:59:18 -0400 Subject: [PATCH] Make docs a little less confusing by removing an internal class --- API.md | 53 ------- docs/index.html | 399 ------------------------------------------------ lib/Driver.js | 6 +- 3 files changed, 5 insertions(+), 453 deletions(-) diff --git a/API.md b/API.md index 8c5d836..2fc0bb5 100644 --- a/API.md +++ b/API.md @@ -1,58 +1,5 @@ -# limit - -Set the limit clause - -**Parameters** - -- `sql` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** SQL statement to modify -- `limit` **[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of rows to fetch -- `offset` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** Number of rows to skip - -Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Modified SQL statement - -# quoteTable - -Quote database table name, and set prefix - -**Parameters** - -- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Table name to quote - -Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Quoted table name - -# quoteIdentifiers - -Use the driver's escape character to quote identifiers - -**Parameters** - -- `str` **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** String or array of strings to quote identifiers - -Returns **([String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) \| [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array))** Quoted identifier(s) - -# truncate - -Generate SQL to truncate the passed table - -**Parameters** - -- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Table to truncate - -Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Truncation SQL - -# insertBatch - -Generate SQL to insert a group of rows - -**Parameters** - -- `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert to -- `data` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The array of object containing data to insert - -Returns **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Query and data to insert - # NodeQuery Class for connection management diff --git a/docs/index.html b/docs/index.html index d05d60e..7110b98 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,56 +24,6 @@