From b6d9faf00861e7f805fce82dfca151cc54eb24ae Mon Sep 17 00:00:00 2001 From: Timothy J Warren Date: Fri, 18 Nov 2016 22:15:56 -0500 Subject: [PATCH] Update docs, changelog, and readme --- API.md | 27 +++----- CHANGELOG.md | 6 +- README.md | 13 +--- docs/index.html | 169 +++++++++++++++++------------------------------- 4 files changed, 74 insertions(+), 141 deletions(-) diff --git a/API.md b/API.md index 2fc0bb5..4fd79c7 100644 --- a/API.md +++ b/API.md @@ -61,10 +61,9 @@ Run an arbitrary sql query. Run as a prepared statement. **Parameters** - `sql` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The sql to execute -- `params` **\[[array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The query parameters -- `callback` **\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Optional callback +- `params` **\[[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)]** The query parameters -Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** Returns a promise if no callback is supplied +Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Promise with result of query ## resetQuery @@ -79,7 +78,6 @@ Empties the selected database table **Parameters** - `table` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the name of the table to truncate -- `callback` **\[[function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Optional callback Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** Returns a promise if no callback is supplied @@ -405,7 +403,6 @@ Get the results of the compiled query - `table` **\[[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)]** The table to select from - `limit` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** A limit for the query - `offset` **\[[Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)]** An offset for the query -- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** A callback for receiving the result **Examples** @@ -414,11 +411,11 @@ query.get('table_name').then(promiseCallback); // Get all the rows in the table ``` ```javascript -query.get('table_name', 5, callback); // Get 5 rows from the table +query.get('table_name', 5); // Get 5 rows from the table ``` ```javascript -query.get(callback); // Get the results of a query generated with other methods +query.get(); // Get the results of a query generated with other methods ``` Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned @@ -431,9 +428,8 @@ Run the generated insert query - `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into - `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method -- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database -Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned +Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned ## insertBatch @@ -443,20 +439,15 @@ Insert multiple sets of rows at a time - `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into - `data` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** The array of objects containing data rows to insert -- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling database response **Examples** -```javascript -query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}], callbackFunction); -``` - ```javascript query.insertBatch('foo',[{id:1,val:'bar'},{id:2,val:'baz'}]) .then(promiseCallback); ``` -Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned +Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned ## update @@ -466,9 +457,8 @@ Run the generated update query - `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into - `data` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Data to insert, if not already added with the 'set' method -- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database -Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned +Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned ## delete @@ -478,9 +468,8 @@ Run the generated delete query - `table` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** The table to insert into - `where` **\[[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)]** Where clause for delete statement -- `callback` **\[[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)]** Callback for handling response from the database -Returns **(void | [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise))** If no callback is passed, a promise is returned +Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** If no callback is passed, a promise is returned ## getCompiledSelect diff --git a/CHANGELOG.md b/CHANGELOG.md index 94b7191..321bae3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +# 5.0.0 +* Re-added firebird as a database +* Replaced all callback interfaces with promises + ## 4.0.0 * Changed connection setup to just use a config object - the appropriate adapter object is created by the library. * Removed mysql adapter, as mysql2 is very similar and does proper prepared statements @@ -11,4 +15,4 @@ * Added back tests for `node-firebird` adapter. Using this adapter with promises is not currently supported. ## 3.1.0 -* Added support for promises on query execution methods \ No newline at end of file +* Added support for promises on query execution methods diff --git a/README.md b/README.md index 7b89667..0d514c2 100755 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ A node query builder for various SQL databases, based on [CodeIgniter](http://ww ### Supported databases +* Firebird (via `node-firebird`) * Mysql (via `mysql2`) * PostgreSQL (via `pg`) * Sqlite (via `dblite`) @@ -38,18 +39,8 @@ const nodeQuery = require('ci-node-query')({ // Get the query builder const query = nodeQuery.getQuery(); -query.select('foo') - .from('bar') - .where('x', 3) - .orWhere({y: 2}) - .join('baz', 'baz.boo = bar.foo', 'left') - .orderBy('x', 'DESC') - .limit(2, 3) - .get(function(err, result) { - // Handle Results Here - }); - // As of version 3.1.0, you can also get promises +// Version 5.0.0 removes all callback interfaces const queryPromise = query.select('foo') .from('bar') .where('x', 3) diff --git a/docs/index.html b/docs/index.html index 7110b98..6431149 100644 --- a/docs/index.html +++ b/docs/index.html @@ -364,10 +364,12 @@
+

NodeQuery

+
@@ -464,19 +466,19 @@ 
let nodeQuery = require('ci-node-query')({
-	driver: 'mysql',
-	connection: {
-		host: 'localhost',
-		user: 'root',
-		password: '',
-		database: 'mysql'
+	driver: 'mysql',
+	connection: {
+		host: 'localhost',
+		user: 'root',
+		password: '',
+		database: 'mysql'
 	}
 });
let nodeQuery = require('ci-node-query')({
-	driver: 'sqlite',
-	connection: ':memory:'
+	driver: 'sqlite',
+	connection: ':memory:'
 });
@@ -558,10 +560,12 @@
+

QueryBuilder

+
@@ -626,7 +630,7 @@
▸ - query(sql, [params], [callback]) + query(sql, [params])
@@ -2906,10 +2888,10 @@ prefixed with 'OR NOT'

query.get('table_name').then(promiseCallback); // Get all the rows in the table
- 
query.get('table_name', 5, callback); // Get 5 rows from the table
+ 
query.get('table_name', 5); // Get 5 rows from the table
- 
query.get(callback); // Get the results of a query generated with other methods
+ 
query.get(); // Get the results of a query generated with other methods
@@ -2927,7 +2909,7 @@ prefixed with 'OR NOT'

▸ - insert(table, [data], [callback]) + insert(table, [data])