sqljocky 0.4.2

A MySQL connector

SQLJocky

This is a MySQL connector for the Dart programming language. It isn't finished, but should work for most normal use. Expect this code to change though, possibly massively, in the near future.

News

• v0.4.1: Major refactoring so that only the parts of sqljocky which are supposed to be exposed are.
• v0.4.0: Support for M4.
• v0.3.0: Support for M3. Bit fields are now numbers, not lists. Dates now use the DateTime class instead of the Date class. Use new IO classes.
• v0.2.0: Support for the new SDK.
• v0.1.3: SQLJocky now uses a connection pooling model, so the API has changed somewhat.

Usage

Create a connection pool:

var pool = new ConnectionPool(host: 'localhost', port: 3306, user: 'bob', password: 'wibble', db: 'stuff', max: 5);

Execute a query:

pool.query('select name, email from users').then((result) {...});

Use the results:

for (row in result) {
	print('Name: ${row[0]}, email: ${row[1]}');
}

Prepare a query:

pool.prepare('insert into users (name, email, age) values (?, ?, ?)').then((query) {...});

Execute the query:

query.execute(['Bob', '[e-mail]', 25]).then((result) {...});

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}");

Execute a query with multiple sets of parameters:

query.executeMulti([['Bob', '[e-mail]', 25],
		['Bill', '[e-mail]', 26],
		['Joe', '[e-mail]', 37]]).then((results) {...}); 

Use the list of results:

for (result in results) {
	print("New user's id: ${result.insertId}");
}

Use a transaction:

pool.startTransaction().then((trans) {
	trans.query('...').then((result) {
		trans.commit().then(() {...});
	});
});

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.

Licence

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.

Includes some hashing code from the closure library, which contains its own copyright notice.

The Name

It is named after Jocky Wilson, the late, great darts player. (Hence the lack of an 'e' in Jocky.)

Things to do

• Better handling of various data types, especially BLOBs, which behave differently when using straight queries and prepared queries.
• Implement the rest of mysql's commands
• Improve performance where possible
• More unit testing
• More integration tests
• DartDoc
• More Example code
• Refactor everything a few times, when I think of a nicer way of doing things, or the Dart language changes
• Use idiomatic dart where possible
• Geometry type
• Decimal type should probably use a bigdecimal type of some sort
• MySQL 4 types (old decimal, anything else?)
• Test against multiple mysql versions
• A logo.