Merge pull request #62 from kevmoo/tweaks

Tweaks

Author: jamesots

.gitignore

@@ -5,6 +5,8 @@ connection.options
 *.iml
 examples
 docs
+.packages
+.pub
 packages
 pubspec.lock
 *~

README.md

@@ -17,70 +17,116 @@ Usage
 
 Create a connection pool:
 
-	var pool = new ConnectionPool(host: 'localhost', port: 3306, user: 'bob', password: 'wibble', db: 'stuff', max: 5);
+```dart
+var pool = new ConnectionPool(
+    host: 'localhost', port: 3306,
+    user: 'bob', password: 'wibble',
+    db: 'stuff', max: 5);
+```
 
 Execute a query:
 
-	var results = await pool.query('select name, email from users');
+```dart
+var results = await pool.query('select name, email from users');
+```
 
 Use the results: (*Note: forEach is asynchronous.*)
 
-	results.forEach((row) {
-		print('Name: ${row[0]}, email: ${row[1]}');
-	});
-	
+```dart
+results.forEach((row) {
+  print('Name: ${row[0]}, email: ${row[1]}');
+});
+```
+
 Or access the fields by name:
 
-	results.forEach((row) {
-		print('Name: ${row.name}, email: ${row.email}');
-	});
+```dart
+results.forEach((row) {
+  print('Name: ${row.name}, email: ${row.email}');
+});
+```
 
 Prepare a query:
 
-	var query = await pool.prepare('insert into users (name, email, age) values (?, ?, ?)');
+```dart
+var query = await pool.prepare(
+  'insert into users (name, email, age) values (?, ?, ?)');
+```
 
 Execute the query:
 
-	var result = await query.execute(['Bob', '[email protected]', 25]);
+```dart
+var result = await query.execute(['Bob', '[email protected]', 25]);
+```
 
 An insert query's results will be empty, but will have an id if there was an auto-increment column in the table:
 
-	print("New user's id: ${result.insertId}");
+```dart
+print("New user's id: ${result.insertId}");
+```
 
 Execute a query with multiple sets of parameters:
 
-	var results = await query.executeMulti([['Bob', '[email protected]', 25],
-			['Bill', '[email protected]', 26],
-			['Joe', '[email protected]', 37]]);
-			
+```dart
+var results = await query.executeMulti([['Bob', '[email protected]', 25],
+    ['Bill', '[email protected]', 26],
+    ['Joe', '[email protected]', 37]]);
+```
+
 Use the list of results:
 
-	for (result in results) {
-		print("New user's id: ${result.insertId}");
-	}
+```dart
+for (result in results) {
+  print("New user's id: ${result.insertId}");
+}
+```
 
 Use a transaction:
 
-	var trans = await pool.startTransaction();
-	var result = await trans.query('...');
-	await trans.commit();
+```dart
+var trans = await pool.startTransaction();
+var result = await trans.query('...');
+await trans.commit();
+```
 
 Development
 -----------
 
 To run the examples and tests, you'll need to create a 'connection.options' file by
 copying 'connection.options.example' and modifying the settings.
 
+You can use Docker to create a temporary mysql instance for testing:
+
+```
+docker run --name mysql_test -d -P \
+   -e MYSQL_ROOT_PASSWORD=root \
+   -e MYSQL_USER=test \
+   -e MYSQL_PASSWORD=test \
+   -e MYSQL_DATABASE=test \
+   mysql
+```
+
+This will create and run a Docker container with the name `mysql_test`.
+
+You can determine the exposed port by running
+
+```
+docker port mysql_test
+```
+
+*Note: depending on your Docker configuration, you will likely have to change
+the host IP address.*
+
 Licence
 -------
 
-It is released under the GPL, because it uses a modified part of mysql's include/mysql_com.h in constants.dart, 
+It is released under the GPL, because it uses a modified part of mysql's include/mysql_com.h in constants.dart,
 which is licensed under the GPL. I would prefer to release it under the BSD Licence, but there you go.
 
 The Name
 --------
 
-It is named after [Jocky Wilson](http://en.wikipedia.org/wiki/Jocky_Wilson), the late, great 
+It is named after [Jocky Wilson](http://en.wikipedia.org/wiki/Jocky_Wilson), the late, great
 darts player. (Hence the lack of an 'e' in Jocky.)
 
 Things to do
@@ -99,4 +145,3 @@ necessary to support anything else?
 * Decimal type should probably use a bigdecimal type of some sort
 * MySQL 4 types (old decimal, anything else?)
 * Test against multiple mysql versions
-

test/speed_test.dart renamed to benchmark/speed_test.dart

@@ -1,53 +1,52 @@
+import 'dart:async';
+
+import 'package:logging/logging.dart';
+import 'package:options_file/options_file.dart';
 import 'package:sqljocky/sqljocky.dart';
 import 'package:sqljocky/utils.dart';
-import 'package:options_file/options_file.dart';
-import 'package:logging/logging.dart';
-
-import 'dart:async';
 
 class SpeedTest {
   static const SIMPLE_INSERTS = 200;
   static const PREPARED_INSERTS = 200;
   static const POOL_SIZE = 1;
-  
+
   ConnectionPool pool;
   Logger log;
-  
-  SpeedTest(this.pool) :
-    log = new Logger("Speed");
-  
+
+  SpeedTest(this.pool) : log = new Logger("Speed");
+
   Future run() async {
     await dropTables();
     await createTables();
     await insertSimpleData();
     await insertPreparedData();
     await pool.closeConnectionsWhenNotInUse();
   }
-  
+
   Future dropTables() {
     log.fine("dropping tables");
     var dropper = new TableDropper(pool, ['pets', 'people']);
     return dropper.dropTables();
   }
-  
+
   Future createTables() {
     log.fine("creating tables");
-    var querier = new QueryRunner(pool, ['create table people (id integer not null auto_increment, '
-                                        'name varchar(255), '
-                                        'age integer, '
-                                        'primary key (id))',
-                                        
-                                        'create table pets (id integer not null auto_increment, '
-                                        'name varchar(255), '
-                                        'species varchar(255), '
-                                        'owner_id integer, '
-                                        'primary key (id),'
-                                        'foreign key (owner_id) references people (id))'
-                                        ]);
+    var querier = new QueryRunner(pool, [
+      'create table people (id integer not null auto_increment, '
+          'name varchar(255), '
+          'age integer, '
+          'primary key (id))',
+      'create table pets (id integer not null auto_increment, '
+          'name varchar(255), '
+          'species varchar(255), '
+          'owner_id integer, '
+          'primary key (id),'
+          'foreign key (owner_id) references people (id))'
+    ]);
     log.fine("executing queries");
     return querier.executeQueries();
   }
-  
+
   Future insertSimpleData() async {
     log.fine("inserting simple data");
     var sw = new Stopwatch()..start();
@@ -59,7 +58,7 @@ class SpeedTest {
     logTime("simple insertions", sw);
     log.fine("inserted");
   }
-  
+
   Future insertPreparedData() async {
     log.fine("inserting prepared data");
     var sw = new Stopwatch()..start();
@@ -72,10 +71,10 @@ class SpeedTest {
     logTime("prepared insertions", sw);
     log.fine("inserted");
   }
-  
+
   void logTime(String operation, Stopwatch sw) {
     var time = sw.elapsedMicroseconds;
-    var seconds = time/1000000;
+    var seconds = time / 1000000;
     log.fine("$operation took: ${seconds}s");
   }
 }
@@ -92,7 +91,7 @@ main() async {
 
   var log = new Logger("Speed");
   log.level = Level.ALL;
-  
+
   var options = new OptionsFile('connection.options');
   var user = options.getString('user');
   var password = options.getString('password');
@@ -102,13 +101,13 @@ main() async {
 
   // create a connection
   log.fine("opening connection");
-  var pool = new ConnectionPool(host: host, port: port, user: user,
-      password: password, db: db, max: SpeedTest.POOL_SIZE);
+  var pool =
+      new ConnectionPool(host: host, port: port, user: user, password: password, db: db, max: SpeedTest.POOL_SIZE);
   log.fine("connection open");
 
   var stopwatch = new Stopwatch()..start();
   await new SpeedTest(pool).run();
   var time = stopwatch.elapsedMicroseconds;
-  var seconds = time/1000000;
+  var seconds = time / 1000000;
   log.fine("Time taken: ${seconds}s");
-}
+}

example/example.dart

@@ -11,9 +11,9 @@ import 'dart:async';
 
 class Example {
   ConnectionPool pool;
-  
+
   Example(this.pool);
-  
+
   Future run() async {
     // drop the tables if they already exist
     await dropTables();
@@ -32,49 +32,50 @@ class Example {
     var dropper = new TableDropper(pool, ['pets', 'people']);
     return dropper.dropTables();
   }
-  
+
   Future createTables() {
     print("creating tables");
-    var querier = new QueryRunner(pool, ['create table people (id integer not null auto_increment, '
-                                        'name varchar(255), '
-                                        'age integer, '
-                                        'primary key (id))',
-                                        
-                                        'create table pets (id integer not null auto_increment, '
-                                        'name varchar(255), '
-                                        'species text, '
-                                        'owner_id integer, '
-                                        'primary key (id),'
-                                        'foreign key (owner_id) references people (id))'
-                                        ]);
+    var querier = new QueryRunner(pool, [
+      'create table people (id integer not null auto_increment, '
+          'name varchar(255), '
+          'age integer, '
+          'primary key (id))',
+      'create table pets (id integer not null auto_increment, '
+          'name varchar(255), '
+          'species text, '
+          'owner_id integer, '
+          'primary key (id),'
+          'foreign key (owner_id) references people (id))'
+    ]);
     print("executing queries");
     return querier.executeQueries();
   }
-  
+
   Future addData() async {
     var query = await pool.prepare("insert into people (name, age) values (?, ?)");
     print("prepared query 1");
     var parameters = [
-        ["Dave", 15],
-        ["John", 16],
-        ["Mavis", 93]
-      ];
-    var results = await query.executeMulti(parameters);
+      ["Dave", 15],
+      ["John", 16],
+      ["Mavis", 93]
+    ];
+    await query.executeMulti(parameters);
 
     print("executed query 1");
     query = await pool.prepare("insert into pets (name, species, owner_id) values (?, ?, ?)");
 
     print("prepared query 2");
     parameters = [
-        ["Rover", "Dog", 1],
-        ["Daisy", "Cow", 2],
-        ["Spot", "Dog", 2]];
+      ["Rover", "Dog", 1],
+      ["Daisy", "Cow", 2],
+      ["Spot", "Dog", 2]
+    ];
 //          ["Spot", "D\u0000og", 2]];
-    results = await query.executeMulti(parameters);
+    await query.executeMulti(parameters);
 
     print("executed query 2");
   }
-  
+
   Future readData() async {
     print("querying");
     var result = await pool.query('select p.id, p.name, p.age, t.name, t.species '
@@ -101,7 +102,7 @@ main() async {
 
   // create a connection
   print("opening connection");
-  var pool = new ConnectionPool(host: host, port: port, user: user, password: password, db: db, max:1);
+  var pool = new ConnectionPool(host: host, port: port, user: user, password: password, db: db, max: 1);
   print("connection open");
   // create an example class
   var example = new Example(pool);