From 145007797b8b90d4dc05f43b9e8fee0e8574fd9e Mon Sep 17 00:00:00 2001 From: "Timothy J. Warren" Date: Mon, 27 Oct 2014 15:47:22 -0400 Subject: [PATCH] Update docs --- README.md | 3 +- docs/index.html | 3 +- docs/module-query-builder.html | 218 ++++++++++++++++++++++++++++++++- docs/query-builder.js.html | 1 + 4 files changed, 219 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0801b1a..b9ab5fd 100755 --- a/README.md +++ b/README.md @@ -15,9 +15,10 @@ A node query builder for various SQL databases, based on CodeIgniter's query bui .from('bar') .where('x', 3) .orWhere('y', 2) + .join('baz', 'baz.boo = bar.foo', 'left') .orderBy('x') .limit(2, 3) - .get(function(err, result) { + .get(function(/* Adapter dependent arguments */) { // Database module result handling }); diff --git a/docs/index.html b/docs/index.html index 3880e43..327a709 100644 --- a/docs/index.html +++ b/docs/index.html @@ -104,9 +104,10 @@ query.select('foo') .from('bar') .where('x', 3) .orWhere('y', 2) + .join('baz', 'baz.boo = bar.foo', 'left') .orderBy('x') .limit(2, 3) - .get(function(err, result) { + .get(function(/* Adapter dependent arguments */) { // Database module result handling }); diff --git a/docs/module-query-builder.html b/docs/module-query-builder.html index f2f8cbf..ac4aeeb 100644 --- a/docs/module-query-builder.html +++ b/docs/module-query-builder.html @@ -745,7 +745,7 @@ @@ -944,7 +944,7 @@ @@ -1145,7 +1145,7 @@ @@ -1336,7 +1336,7 @@ @@ -5581,6 +5581,216 @@ prefixed with 'OR NOT'

+ + + + +
+

<inner> delete(table, where, callback)

+ + +
+
+ + +
+

Run the generated delete query

+
+ + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeArgumentDescription
table + + +String + + + + + + + + + +

The table to insert into

where + + +Object + + + + + + <optional>
+ + + + + +

Where clause for delete statement

callback + + +function + + + + + + + + + +

Callback for handling response from the database

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + +
Source:
+
+ +
+ + + + + + + +
+ + + + + + + + + + + +
Returns:
+ + +
+

void

+
+ + + + + + +
diff --git a/docs/query-builder.js.html b/docs/query-builder.js.html index 6e27721..9949fed 100644 --- a/docs/query-builder.js.html +++ b/docs/query-builder.js.html @@ -867,6 +867,7 @@ var QueryBuilder = function(driver, adapter) { /** * Run the generated delete query * + * @method delete * @param {String} table - The table to insert into * @param {Object} [where] - Where clause for delete statement * @param {Function} callback - Callback for handling response from the database