mysql1 0.16.3

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 83

mysql1 #

A MySQL driver for the Dart programming language. Works on Flutter and on the server.

This library aims to provide an easy to use interface to MySQL. mysql1 originated as a fork of the SQLJocky driver.

Usage #

Connect to the database

var settings = new ConnectionSettings(
  host: 'localhost', 
  port: 3306,
  user: 'bob',
  password: 'wibble',
  db: 'mydb'
);
var conn = await MySqlConnection.connect(settings);

Execute a query with parameters:

var userId = 1;
var results = await conn.query('select name, email from users where id = ?', [userId]);

Use the results:

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

Insert some data

var result = await conn.query('insert into users (name, email, age) values (?, ?, ?)', ['Bob', 'bob@bob.com', 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}");

Execute a query with multiple sets of parameters:

var results = await query.queryMulti(
    'insert into users (name, email, age) values (?, ?, ?)',
    [['Bob', 'bob@bob.com', 25],
    ['Bill', 'bill@bill.com', 26],
    ['Joe', 'joe@joe.com', 37]]);

Changelog #

v0.16.3 #

28 Nov 2018

  • Improve docs
  • Breaking: Test for correct query parameter count on the client side
  • Breaking: Tidy up old field by name access code
  • Tidy up Field class

v0.16.2 #

23 Oct 2018

  • Make Field a concrete class
  • Breaking: Don't export mysql.constants. These are internal.

v0.16.1 #

23 Oct 2018

  • Simplify example

v0.16.0 #

  • Breaking: Validate that all DateTime values passed to and returned from query and queryMulti are UTC.

v0.15.2 #

  • Add types to query and queryMulti interface. This makes the package easier to use with implicit-dynamic: false

v0.15.1 #

  • Documentation updates

v0.15.0 #

  • Publish first version post-fork

SQLJockey historical changelog #

v0.14.5 #

  • Fix package references

v0.14.3 #

  • Merged in Kevin Moore's PR from original SQLJockey

v0.14.1 #

  • Fix the changelog formatting, so you can actually see what changed in v0.14.0

v0.14.0 #

  • Requires Dart 1.11
  • Use newer logging library
  • Use async/await in library code and examples.
  • Fix bug with closing prepared queries, where it sometimes tried to close a query which was in use.
  • Don't throw an error if username is null.
  • Fix bug in blobs, where it was trying to decode binary blobs as UTF-8 strings.
  • Close connections and return them to the pool when a connection times out on the server.

v0.13.0 #

  • Fixes an issue with executeMulti being broken.
  • Fixes an issue with query failing if the first field in a SELECT is an empty string

v0.12.0 #

  • Breaking change: ConnectionPool.close() has been renamed to ConnectionPool.closeConnectionsNow. It is a dangerous method to call as it closes all connections even if they are in the middle of an operation. ConnectionPool.closeConnectionsWhenNotInUse has been added, which is much safer.
  • Fixed an issue with closing prepared queries which caused connections to remain open.

v0.11.0 #

  • Added support for packets larger than 16 MB. ConnectionPool's constructor has a new parameter, 'maxPacketSize', which specifies the maximum packet size in bytes. Using packets larger than 16 MB is not currently particularly optimised.
  • Fixed some issues with authentication. In particular, errors should now be thrown when you try to connect to a server which is using an old or unsupported authentication protocol.

v0.10.0 #

  • Added SSL connections. Pass 'useSSL: true' to ConnectionPool constructor. If server doesn't support SSL, connection will continue unsecured. You can check if the connections are secure by calling pool.getConnection().then((cnx) {print(cnx.usingSSL); cnx.release();});

v0.9.0 #

  • Added ConnectionPool.getConnection() which returns a RetainedConnection. Useful if you need to keep a specific connection around (for example, if you need to lock tables).

v0.8.3 #

  • Fixed connection retention error in Query.executeMulti

v0.8.1 #

  • Can now access fields by name.

v0.8.0 #

  • Breaking change: Results no longer has a 'stream' property - it now implements Stream itself. As a result, it also no longer has a 'rows' property, or a 'toResultsList()' method - you can use 'toList()' to convert it into a list instead.

v0.7.0 #

  • Rewritten some connection handling code to make it more robust, and so that it handles stream operations such as 'first' correctly (i.e. without hanging forever).
  • Updated spec for Dart 1.0

v0.6.2 #

  • Support for latest SDK (removal of dart:utf8 library)

v0.6.1 #

  • Support for latest SDK

v0.6.0 #

  • Change prepared statement syntax. Values must now be passed into the execute() method in an array. This change was made because otherwise prepared statements couldn't be used asynchronously correctly - if you used the same prepared query object for multiple queries 'at the same time', the wrong values could get used.

v0.5.8 #

  • Handle errors in the utils package properly
  • Pre-emptively fixed some errors, wrote more tests.

v0.5.7 #

  • Fixed error with large fields.

v0.5.6 #

  • Hopefully full unicode support
  • Fixed problem with null values in prepared queries.

v0.5.5 #

  • Some initial changes for better unicode handling.

v0.5.4 #

  • Blobs and Texts which are bigger than 250 characters now work.

v0.5.3 #

  • Make ConnectionPool and Transaction implement QueriableConnection
  • Improved tests.

v0.5.2 #

  • Fix for new SDK

v0.5.1 #

  • Made an internal class private

v0.5.0 #

  • Breaking change: Now uses streams to return results.

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.

example/example.dart

import 'dart:async';

import 'package:mysql1/mysql1.dart';

Future main() async {
  // Open a connection (testdb should already exist)
  final conn = await MySqlConnection.connect(new ConnectionSettings(
      host: 'localhost', port: 3306, user: 'root', db: 'testdb'));

  // Create a table
  await conn.query(
      'CREATE TABLE users (id int NOT NULL AUTO_INCREMENT PRIMARY KEY, name varchar(255), email varchar(255), age int)');

  // Insert some data
  var result = await conn.query(
      'insert into users (name, email, age) values (?, ?, ?)',
      ['Bob', 'bob@bob.com', 25]);
  print("Inserted row id=${result.insertId}");

  // Query the database using a parameterized query
  var results = await conn
      .query('select name, email from users where id = ?', [result.insertId]);
  for (var row in results) {
    print('Name: ${row[0]}, email: ${row[1]}');
  }

  // Finally, close the connection
  await conn.close();
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  mysql1: ^0.16.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter packages get

Alternatively, your editor might support pub get or flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:mysql1/mysql1.dart';
  
Version Uploaded Documentation Archive
0.16.3 Nov 28, 2018 Go to the documentation of mysql1 0.16.3 Download mysql1 0.16.3 archive
0.16.2 Oct 23, 2018 Go to the documentation of mysql1 0.16.2 Download mysql1 0.16.2 archive
0.16.1 Oct 23, 2018 Go to the documentation of mysql1 0.16.1 Download mysql1 0.16.1 archive
0.16.0 Oct 23, 2018 Go to the documentation of mysql1 0.16.0 Download mysql1 0.16.0 archive
0.15.2 Sep 4, 2018 Go to the documentation of mysql1 0.15.2 Download mysql1 0.15.2 archive
0.15.1 Sep 3, 2018 Go to the documentation of mysql1 0.15.1 Download mysql1 0.15.1 archive
0.15.0 Sep 3, 2018 Go to the documentation of mysql1 0.15.0 Download mysql1 0.15.0 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
84
Health:
Code health derived from static analysis. [more]
71
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
83
Learn more about scoring.

We analyzed this package on Mar 6, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14

Platforms

Detected platforms: Flutter, other

Primary library: package:mysql1/mysql1.dart with components: io.

Health suggestions

Fix lib/src/buffer.dart. (-18.58 points)

Analysis of lib/src/buffer.dart reported 41 hints, including:

line 9 col 1: Prefer using /// for doc comments.

line 29 col 3: Prefer using /// for doc comments.

line 38 col 3: Prefer using /// for doc comments.

line 48 col 3: Prefer using /// for doc comments.

line 53 col 3: Prefer using /// for doc comments.

Fix lib/src/handlers/handler.dart. (-2.96 points)

Analysis of lib/src/handlers/handler.dart reported 6 hints, including:

line 17 col 1: Prefer using /// for doc comments.

line 34 col 7: Don't explicitly initialize variables to null.

line 40 col 1: Prefer using /// for doc comments.

line 52 col 3: Prefer using /// for doc comments.

line 57 col 3: Prefer using /// for doc comments.

Fix lib/src/single_connection.dart. (-2.48 points)

Analysis of lib/src/single_connection.dart reported 5 hints:

line 283 col 7: Future results in async function bodies must be awaited or marked unawaited using package:pedantic.

line 293 col 34: Use isNotEmpty instead of length

line 316 col 7: Future results in async function bodies must be awaited or marked unawaited using package:pedantic.

line 320 col 7: Future results in async function bodies must be awaited or marked unawaited using package:pedantic.

line 428 col 3: Prefer using /// for doc comments.

Fix additional 9 files with analysis or formatting issues. (-7.99 points)

Additional issues in the following files:

  • lib/src/buffered_socket.dart (3 hints)
  • lib/src/auth/handshake_handler.dart (2 hints)
  • lib/src/mysql_exception.dart (2 hints)
  • lib/src/mysql_protocol_error.dart (2 hints)
  • lib/src/prepared_statements/binary_data_packet.dart (2 hints)
  • lib/src/results/results_impl.dart (2 hints)
  • lib/src/blob.dart (1 hint)
  • lib/src/mysql_client_error.dart (1 hint)
  • lib/src/results/row.dart (1 hint)

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
collection ^1.1.3 1.14.11
crypto >=0.9.2 <3.0.0 2.0.6
logging >=0.11.1 <0.12.0 0.11.3+2
pool ^1.3.6 1.4.0
Transitive dependencies
async 2.0.8
charcode 1.1.2
convert 2.1.1
path 1.6.2
stack_trace 1.9.3
typed_data 1.1.6
Dev dependencies
mockito ^3.0.0
options_file
test ^1.3.0