office_spirit_mysql@v0.2.5

MySQL and MariaDB driver for Deno. Tested on: MySQL 5.6, 5.7, 8.0, MariaDB 5.5, 10.0, 10.2, 10.5, 10.7.

Features:

Prepared statements.
Binary protocol. Query parameters are sent separately from text query.
Sane connections pooling. Connections are reset after usage (locks are freed).
Pool for connections to multiple servers.
Streaming BLOBs and Deno.Readers.
Custom handler for LOCAL INFILE.
Advanced transactions manager: regular, readonly, distributed (2-phase commit), savepoints.
Made with CPU and RAM efficiency in mind.

Basic example:

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example1.ts~)' > /tmp/example1.ts
// deno run --allow-env --allow-net /tmp/example1.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.query("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.query("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        for await (const row of await conn.query("SELECT * FROM t_log"))
        {	console.log(row);
        }
    }
);

await pool.onEnd();
await pool.closeIdle();

Connections pool

Connections to database servers are managed by MyPool object.

MyPool.constructor(options?: MyPoolOptions|Dsn|string)

Options are:

interface MyPoolOptions
{	dsn?: Dsn|string;
    maxConns?: number;
    onLoadFile?: (filename: string) => Promise<(Deno.Reader & Deno.Closer) | undefined>;
    xaInfoTables?: {dsn: Dsn|string, table: string}[];
}

dsn - Default Data Source Name for this pool, that will be used if the DSN is not specified when requesting a new connection.
maxConns - Limit to number of simultaneous connections in this pool. When reached pool.haveSlots() returns false, and new connection requests will wait. Default value: 250.
onLoadFile - Handler for LOAD DATA LOCAL INFILE query.
xaInfoTables - You can provide tables (that you need to create), that will improve distributed transactions management (optional).

Options can be given just as DSN string, or a Dsn object, that contains parsed DSN string.

Data Source Name is specified in URL format, with “mysql://” protocol.

Format: mysql://user:password@host:port/schema?param1=value1&param2=value2#INITIAL_SQL Or: mysql://user:password@localhost/path/to/named.pipe/schema

Example: mysql://root@localhost/ Or: mysql://root:hello@[::1]/?keepAliveTimeout=10000&foundRows

Possible parameters:

keepAliveTimeout (number, default 10000) milliseconds - each connection will persist for this period of time, before termination, so it can be reused when someone else asks for the same connection
keepAliveMax (number, default Infinity) - how many times at most to recycle each connection
maxColumnLen (number, default 10MiB) bytes - if a column was longer, it’s value is skipped, and it will be returned as NULL (this doesn’t apply to conn.makeLastColumnReader() - see below)
foundRows (boolean, default false) - if present, will use “found rows” instead of “affected rows” in resultsets (see here how CLIENT_FOUND_ROWS flag affects result of Row_count() function)
ignoreSpace (boolean, default false) - if present, parser on server side can ignore spaces before ‘(’ in built-in function names (see description here)
multiStatements (boolean, default false) - if present, SQL can contain multiple statements separated with ‘;’, so you can upload dumps, but SQL injection attacks become more risky

Connections

A new connection from connections pool can be asked with pool.forConn() function:

MyPool.forConn<T>(callback: (conn: MyConn) => Promise<T>, dsn?: Dsn|string): Promise<T>

If dsn is not provided, the default DSN of the pool will be used. You can ask connections to different servers.

The requested connection will be available in the provided callback, and when it completes, this connection will return back to the pool.

Connection state is reset before returning to the pool. This means that incomplete transaction will be rolled back, and all kind of locks will be cleared. Then this connection can be idle in the pool for at most keepAliveTimeout milliseconds, and if nobody was interested in it during this period, it will be terminated. If somebody killed a connection while it was idle in the pool, and you asked to use this connection again, the first query on this connection can fail. If this happens, another connection will be tried, and your query will be reissued. This process is transparent to you.

In the beginning of callback, conn may be not connected to the server. It will connect on first requested query.

Cross-server sessions

If you want to deal with multiple simultaneous connections, you can call pool.session() to start a cross-server session.

MyPool.session<T>(callback: (session: MySession) => Promise<T>): Promise<T>

During this session you can call session.conn() to get a connection. At the end of callback all the connections will return to the pool, if they didn’t before.

MySession.conn(dsn?: Dsn|string, fresh=false): MyConn

MySession.conn() returns the connection object (MyConn) immediately, but actual connection will be established on first SQL query.

With true second argument, always new connection is returned. Otherwise, if there’s already an active connection to the same DSN in this session, it will be picked up.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example2.ts~)' > /tmp/example2.ts
// deno run --allow-env --allow-net /tmp/example2.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root@localhost');

pool.session
(	async session =>
    {	const conn1 = session.conn(); // default DSN
        const conn2 = session.conn(); // the same object
        const conn3 = session.conn(undefined, true); // another connection to default DSN
        const conn4 = session.conn('mysql://tests@localhost'); // connection to different DSN

        console.log(conn1 == conn2); // prints true
        console.log(conn2 != conn3); // prints true

        const connId2 = conn2.queryCol("SELECT Connection_id()").first();
        const connId3 = conn3.queryCol("SELECT Connection_id()").first();
        const connId4 = conn4.queryCol("SELECT Connection_id()").first();

        console.log(await Promise.all([connId2, connId3, connId4])); // prints 3 different connection ids
    }
);

await pool.onEnd();
await pool.closeIdle();

At the end of callback all active connections will be returned to the pool. However you can call conn.end() to free a connection earlier.

Making queries

To run a query that doesn’t return rows, use execute():

MyConn.execute(sql: SqlSource, params?: Params): Promise<Resultsets>

This method executes it’s query and discards returned rows. Returned Resultsets object contains lastInsertId, affectedRows, and more such information about the query. If there were multiple resultsets, it will contain only information about the last one.

To run a query, and read it’s rows, use one of the following methods:

MyConn.query(sql: SqlSource, params?: Params): ResultsetsPromise
MyConn.queryMap(sql: SqlSource, params?: Params): ResultsetsPromise
MyConn.queryArr(sql: SqlSource, params?: Params): ResultsetsPromise
MyConn.queryCol(sql: SqlSource, params?: Params): ResultsetsPromise

query* methods return ResultsetsPromise which is subclass of Promise<Resultsets>. Awaiting it gives you Resultsets object. Iterating over Resultsets yields rows.

If your query didn’t return rows (query like INSERT), then these methods work exactly as execute(), so zero rows will be yielded, and resultsets.columns will be empty array, and resultsets.lastInsertId and resultsets.affectedRows will show relevant information.

If there’re rows, you need to iterate them to the end, before you can execute another query. You can read all the rows with Resultsets.all() or ResultsetsPromise.all().

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example3.ts~)' > /tmp/example3.ts
// deno run --allow-env --allow-net /tmp/example3.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        // use ResultsetsPromise.all()
        console.log(await conn.query("SELECT * FROM t_log").all());

        // use Resultsets.all()
        const res = await conn.query("SELECT * FROM t_log");
        console.log(res.columns);
        console.log(await res.all());
    }
);

await pool.onEnd();
await pool.closeIdle();

If your query returns single row, you can read it with Resultsets.first() or ResultsetsPromise.first(). It returns the first row itself, not an array of rows. And it skips all further rows, if they exist.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example4.ts~)' > /tmp/example4.ts
// deno run --allow-env --allow-net /tmp/example4.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        // use ResultsetsPromise.first()
        console.log(await conn.query("SELECT Count(*) FROM t_log").first());

        // use Resultsets.first()
        const res = await conn.query("SELECT Count(*) FROM t_log");
        console.log(res.columns);
        console.log(await res.first());
    }
);

await pool.onEnd();
await pool.closeIdle();

You can iterate the resultset with for await loop, or you can call ResultsetsPromise.forEach() or Resultsets.forEach() method.

ResultsetsPromise.forEach<T>(callback: (row: any) => T|Promise<T>): Promise<T|undefined>

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example5.ts~)' > /tmp/example5.ts
// deno run --allow-env --allow-net /tmp/example5.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        // for await loop
        for await (const row of await conn.query("SELECT * FROM t_log"))
        {	console.log(row);
        }

        // ResultsetsPromise.forEach()
        await conn.query("SELECT * FROM t_log").forEach
        (	row =>
            {	console.log(row);
            }
        );
    }
);

await pool.onEnd();
await pool.closeIdle();

MyConn.query() method iterates over rows as Javascript default objects with fields.
MyConn.queryMap() method iterates over rows as Map objects.
MyConn.queryArr() method iterates over rows as Arrays with column values without column names.
MyConn.queryCol() method iterates over first column values of each row.

For example, using queryCol().first() you can get the result of SELECT Count(*) as a single number value:

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example6.ts~)' > /tmp/example6.ts
// deno run --allow-env --allow-net /tmp/example6.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        const count = await conn.queryCol("SELECT Count(*) FROM t_log").first();
        console.log(count); // prints 3
    }
);

await pool.onEnd();
await pool.closeIdle();

Here is the complete definition of query functions:

MyConn.execute(sql: SqlSource, params?: Params): Promise<Resultsets<void>> {...}
MyConn.query<ColumnType=ColumnValue>(sql: SqlSource, params?: Params): ResultsetsPromise<Record<string, ColumnType>> {...}
MyConn.queryMap<ColumnType=ColumnValue>(sql: SqlSource, params?: Params): ResultsetsPromise<Map<string, ColumnType>> {...}
MyConn.queryArr<ColumnType=ColumnValue>(sql: SqlSource, params?: Params): ResultsetsPromise<ColumnType[]> {...}
MyConn.queryCol<ColumnType=ColumnValue>(sql: SqlSource, params?: Params): ResultsetsPromise<ColumnType> {...}

type SqlSource = string | Uint8Array | Deno.Reader&Deno.Seeker | Deno.Reader&{readonly size: number} | ToSqlBytes;
type Params = any[] | Record<string, any> | null;
class ResultsetsPromise<Row> extends Promise<Resultsets<Row>> {...}
type ColumnValue = bigint | Date | Uint8Array | JsonNode;
type JsonNode = null | boolean | number | string | JsonNode[] | {[member: string]: JsonNode};

By default query*() functions produce rows where each column is of ColumnValue type.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example7.ts~)' > /tmp/example7.ts
// deno run --allow-env --allow-net /tmp/example7.ts

import {MyPool, ColumnValue} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        const row = await conn.query("SELECT * FROM t_log WHERE id=1").first();
        if (row)
        {	// The type of `row` here is `Record<string, ColumnValue>`
            let message = '';
            // Remember that the `message` column can also be null
            if (typeof(row.message) == 'string') // Without this check, the error will be: Type 'ColumnValue' is not assignable to type 'string'
            {	message = row.message;
            }
            console.log(message); // Prints 'Message 1'
        }
    }
);

await pool.onEnd();
await pool.closeIdle();

If you’re sure about column types, you can override the column type with any (or something else), so each column value will be assumed to have this type.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example8.ts~)' > /tmp/example8.ts
// deno run --allow-env --allow-net /tmp/example8.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text)");
        await conn.execute("INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3')");

        // Use query<any>()
        const row = await conn.query<any>("SELECT * FROM t_log WHERE id=1").first();
        if (row)
        {	// The type of `row` here is `Record<string, any>`
            const message: string = row.message;
            console.log(message); // Prints 'Message 1'
        }
    }
);

await pool.onEnd();
await pool.closeIdle();

Type conversions

When rows are read, MySQL values are converted to matching Javascript types.

NULL → null
bit → boolean
integer, mediumint, smallint, tinyint, year → number
bigint → either number or bigint
float, double → number
date, datetime, timestamp → Date
time → number of seconds
char, varchar, tinytext, smalltext, text, mediumtext, longtext → string
binary, varbinary, tinyblob, smallblob, blob, mediumblob, longblob → Uint8Array
json → is deserialized

Type conversions from Javascript to MySQL happen when you pass parameters to SQL queries.

null, undefined, function, symbol → NULL
boolean → 0 or 1
number → integer or double
bigint → bigint
string → char
Uint8Array or other typed array → binary
Deno.Reader → binary
Date → datetime
others → char representing JSON serialized value

Query parameters

Positional parameters

You can use ? placeholders in SQL query strings, and supply array of parameters to be substituted in place of them. This library doesn’t parse the provided SQL string, but uses MySQL built-in functionality, so the parameters are substituted on MySQL side. Placeholders can appear only in places where expressions are allowed.

MySQL supports up to 2**16-1 = 65535 placeholders.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example9.ts~)' > /tmp/example9.ts
// deno run --allow-env --allow-net /tmp/example9.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, `time` timestamp, message text)");
        await conn.execute("INSERT INTO t_log SET `time`=Now(), message='Message 1'");

        const row = await conn.query("SELECT `time` + INTERVAL ? DAY AS 'time', message FROM t_log WHERE id=?", [3, 1]).first();
        console.log(row);
    }
);

await pool.onEnd();
await pool.closeIdle();

Named parameters

For named parameters you can use @name placeholders, and this library uses MySQL session variables to send parameters data. To execute such query, another pre-query is sent to the server, like SET @days=?, @id=?. Parameter names will override session variables with the same names.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example10.ts~)' > /tmp/example10.ts
// deno run --allow-env --allow-net /tmp/example10.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, `time` timestamp, message text)");
        await conn.execute("INSERT INTO t_log SET `time`=Now(), message='Message 1'");

        const row = await conn.query("SELECT `time` + INTERVAL @days DAY AS 'time', message FROM t_log WHERE id=@`id`", {days: 3, id: 1}).first();
        console.log(row);
    }
);

await pool.onEnd();
await pool.closeIdle();

Using external SQL generators

Another option for parameters substitution is to use libraries that generate SQL.

Any library that produces SQL queries is alright if it takes into consideration the very important conn.noBackslashEscapes flag. Remember that the value of this flag can change during server session, if user executes a query like SET sql_mode='no_backslash_escapes'.

Query functions (execute(), query() and the such) can receive SQL queries in several forms:

type SqlSource = string | Uint8Array | Deno.Reader&Deno.Seeker | Deno.Reader&{readonly size: number} | ToSqlBytes;

As string, Uint8Array, Deno.Reader or ToSqlBytes.

Internally strings will be converted to Uint8Array anyway, so if your SQL generator can produce Uint8Array, it’s prefered option.

The most optimal performance will be achieved if using ToSqlBytes type. This type exists especially for external SQL generators, to let them add SQL queries right into the internal buffer.

interface ToSqlBytes
{	toSqlBytesWithParamsBackslashAndBuffer(putParamsTo: any[]|undefined, noBackslashEscapes: boolean, buffer: Uint8Array): Uint8Array;
}

Any external SQL generator can implement this function. This library will call it with 3 parameters:

putParamsTo - If an array is passed, the generator is welcome to convert some parameters to ?-placeholders, and to put the actual value to this array.
noBackslashEscapes - This library will pass the correct value for this flag, and the generator is kindly asked to respect this value.
buffer - The generator can use this buffer to store the resulting query, in case the buffer is big enough. If the generator decides not to use this buffer, it can allocate it’s own buffer, and return it. If it uses the passed in buffer, it must return a subarray of it.

Example:

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example11.ts~)' > /tmp/example11.ts
// deno run --allow-env --allow-net /tmp/example11.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

// 1. Define the generator

const encoder = new TextEncoder;

/**	Generates SELECT query for demonstrational purposes only
 **/
class SqlSelectGenerator
{	constructor(private table: string, private idValue: number)
    {
    }

    toSqlBytesWithParamsBackslashAndBuffer(putParamsTo: any[]|undefined, noBackslashEscapes: boolean, buffer: Uint8Array)
    {	let sql;
        if (putParamsTo)
        {	putParamsTo.push(this.idValue);
            sql = `SELECT * FROM ${this.table} WHERE id = ?`;
        }
        else
        {	sql = `SELECT * FROM ${this.table} WHERE id = ${this.idValue}`;
        }
        const {read, written} = encoder.encodeInto(sql, buffer);
        if (read == sql.length)
        {	return buffer.subarray(0, written);
        }
        return encoder.encode(sql);
    }
}

// 2. Use the generator

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.query("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, `time` timestamp, message text)");
        await conn.query("INSERT INTO t_log SET `time`=Now(), message='message'");

        const rows = await conn.query<any>(new SqlSelectGenerator('t_log', 1), []).all();
        console.log(rows);
    }
);

await pool.onEnd();
await pool.closeIdle();

There’re the following external libraries that implement toSqlBytesWithParamsBackslashAndBuffer() to optimally support x/office_spirit_mysql:

x/polysql - Earlier this library was part of this project.

If you know about another such libraries, or create one, please let me know, and i’ll add them to the list.

MySQL binary protocol

All you need to know about it, is that not all queries can be run in the MySQL binary protocol.

Please, see here what query types can run in the Binary protocol.

This library uses Text protocol, if params are undefined in conn.execute() or conn.query*() functions. If the params argument is specified, even if it’s an empty array, the Binary protocol is used.

If the params is an empty array, and the first argument (sqlSource) implements ToSqlBytes interface, then this empty array will be passed to sqlSource.toSqlBytesWithParamsBackslashAndBuffer() as the first argument, so the SQL generator can send parameters to the server through binary protocol (see above about “Using external SQL generators”).

Reading long BLOBs

This library tries to have everything needed in real life usage. It’s possible to read long data without storing it in memory.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example12.ts~)' > /tmp/example12.ts
// deno run --allow-env --allow-net /tmp/example12.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';
import {copy} from 'https://deno.land/std@0.117.0/streams/conversion.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.query("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, `time` timestamp, message text)");
        await conn.query("INSERT INTO t_log SET `time`=Now(), message='long long message'");

        const row = await conn.makeLastColumnReader<any>("SELECT `time`, message FROM t_log WHERE id=1");
        await copy(row!.message, Deno.stdout);
    }
);

await pool.onEnd();
await pool.closeIdle();

Writing long BLOBS

Query parameter values can be of various types, including Deno.Reader. If some parameter is Deno.Reader, the parameter value will be read from this reader (without storing the whole BLOB in memory).

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example13.ts~)' > /tmp/example13.ts
// deno run --allow-env --allow-net /tmp/example13.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';
import {copy} from 'https://deno.land/std@0.117.0/streams/conversion.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	await conn.execute("CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, `time` timestamp, message text)");

        const file = await Deno.open('/etc/passwd', {read: true});
        try
        {	// Write the file to db
            await conn.execute("INSERT INTO t_log SET `time`=Now(), message=?", [file]);
        }
        finally
        {	file.close();
        }

        // Read the contents back from db
        const row = await conn.makeLastColumnReader<any>("SELECT `time`, message FROM t_log WHERE id=1");
        await copy(row!.message, Deno.stdout);
    }
);

await pool.onEnd();
await pool.closeIdle();

Importing big dumps

Functions like MyConn.execute(), MyConn.query(), etc. allow to provide SQL query in several forms, including Deno.Reader.

MyConn.query(sql: SqlSource, params?: object|null): ResultsetsPromise;

type SqlSource = string | Uint8Array | Deno.Reader&Deno.Seeker | Deno.Reader&{readonly size: number} | ToSqlBytes;

This allows to read SQL from files.

// To download and run this example:
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example14.ts~)' > /tmp/example14.ts
// DSN='mysql://root:hello@localhost/tests?multiStatements' deno run --allow-env --allow-net /tmp/example14.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

// Don't forget `?multiStatements`
const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests?multiStatements');

pool.forConn
(	async conn =>
    {	const filename = await Deno.makeTempFile();
        try
        {	await Deno.writeTextFile
            (	filename,
                `	CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, c_time timestamp, message text);

                    INSERT INTO t_log SET c_time=Now(), message='long long message';
                `
            );

            const file = await Deno.open(filename, {read: true});
            try
            {	await conn.execute(file);
            }
            finally
            {	file.close();
            }

            console.log(await conn.query("SELECT c_time, message FROM t_log").all());
        }
        finally
        {	await Deno.remove(filename);
        }
    }
);

await pool.onEnd();
await pool.closeIdle();

Prepared statements

Function conn.forQuery() prepares an SQL statement, that you can execute multiple times, each time with different parameters.

forQuery<T>(sql: SqlSource, callback: (prepared: Resultsets) => Promise<T>): Promise<T>

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example15.ts~)' > /tmp/example15.ts
// deno run --allow-env --allow-net /tmp/example15.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

pool.forConn
(	async conn =>
    {	// CREATE TABLE
        await conn.query("CREATE TEMPORARY TABLE t_messages (id integer PRIMARY KEY AUTO_INCREMENT, message text)");

        // INSERT
        await conn.forQuery
        (	"INSERT INTO t_messages SET message=?",
            async prepared =>
            {	for (let i=1; i<=3; i++)
                {	await prepared.exec(['Message '+i]);
                }
            }
        );

        // SELECT
        console.log(await conn.query("SELECT * FROM t_messages").all());
    }
);

await pool.onEnd();
await pool.closeIdle();

LOAD DATA LOCAL INFILE

If this feature is enabled on your server, you can register a custom handler that will take LOAD DATA LOCAL INFILE requests.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example16.ts~)' > /tmp/example16.ts
// deno run --allow-env --allow-net /tmp/example16.ts

import {MyPool, sql} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';
import {dirname} from "https://deno.land/std@0.117.0/path/mod.ts";

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

// Set handler for LOAD DATA LOCAL INFILE queries
const ALLOWED_DIRS = ['/tmp'];
pool.options
(	{	onLoadFile(filename: string)
        {	if (ALLOWED_DIRS.includes(dirname(filename)))
            {	return Deno.open(filename, {read: true});
            }
            else
            {	return Promise.resolve(undefined);
            }
        }
    }
);

// Download some public example CSV file from github
const data = await fetch('https://raw.githubusercontent.com/lukes/ISO-3166-Countries-with-Regional-Codes/master/all/all.csv');
const filename = await Deno.makeTempFile();
await Deno.writeTextFile(filename, await data.text());

// Create temporary table, load the data to it, and then select it back
pool.forConn
(	async conn =>
    {	// CREATE TABLE
        await conn.execute
        (	`	CREATE TEMPORARY TABLE t_countries
                (	country_code char(2) CHARACTER SET latin1 NOT NULL PRIMARY KEY,
                    country_name varchar(128) NOT NULL
                )
            `
        );

        // SQL-quote filename, because `LOAD DATA LOCAL INFILE` doesn't accept parameters
        const filenameSql = await conn.queryCol("SELECT Quote(?)", [filename]).first();

        // LOAD DATA
        const res = await conn.execute
        (	`	LOAD DATA LOCAL INFILE ${filenameSql}
                INTO TABLE t_countries
                FIELDS TERMINATED BY ','
                ENCLOSED BY '"'
                IGNORE 1 LINES
                (@name, @code)
                SET
                    country_code = @code,
                    country_name = @name
            `
        );
        console.log(res.statusInfo);

        // SELECT
        console.log(await conn.query("SELECT * FROM t_countries LIMIT 3").all());
    }
);

await pool.onEnd();
await pool.closeIdle();

Connection status

MyConn object has several status variables:

conn.serverVersion: string - remote server version, as it reports (for example my server reports “8.0.25-0ubuntu0.21.04.1”).
conn.connectionId: number - thread ID of the connection, that SHOW PROCESSLIST shows.
conn.autocommit: boolean - true if the connection is currently in autocommit mode. Queries like SET autocommit=0 will affect this flag.
conn.inTrx: boolean - true if a transaction was started. Queries like START TRANSACTION and ROLLBACK will affect this flag.
conn.inTrxReadonly: boolean - true if a readonly transaction was started. Queries like START TRANSACTION READ ONLY and ROLLBACK will affect this flag.
conn.noBackslashEscapes: boolean - true, if the server is configured not to use backslash escapes in string literals. Queries like SET sql_mode='NO_BACKSLASH_ESCAPES' will affect this flag.
conn.schema: string - if your server version supports change schema notifications, this will be current default schema (database) name. Queries like USE new_schema will affect this value. With old servers this will always remain empty string.

Initially these variables can be empty. They are set after actual connection to the server, that happens after issuing the first query. Or you can call await conn.connect().

Resultsets

conn.execute(), and conn.query*() methods all return Resultsets object, that contains information about your query result. Also this object allows to iterate over rows that the query returned.

If your query returned multiple resultsets, conn.execute() skips them, and returns only the status of the last one.

conn.query*() functions don’t skip resultsets, and await resultsets.nextResultset() will advance to the next result, and return true. If there are no more resultsets, await resultsets.nextResultset() returns false. And you must read or discard all the resultsets before being able to issue next queries.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example17.ts~)' > /tmp/example17.ts
// deno run --allow-env --allow-net /tmp/example17.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests?multiStatements');

pool.forConn
(	async conn =>
    {	const resultsets = await conn.query
        (	`	CREATE TEMPORARY TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, message text);

                INSERT INTO t_log (message) VALUES ('Message 1'), ('Message 2'), ('Message 3');

                SELECT * FROM t_log;
            `
        );

        console.log(resultsets.affectedRows); // prints 0

        await resultsets.nextResultset();
        console.log(resultsets.affectedRows); // prints 3

        await resultsets.nextResultset();
        console.log(resultsets.columns.length); // prints 2

        for await (const row of resultsets)
        {	console.log(row);
        }
    }
);

await pool.onEnd();
await pool.closeIdle();

Resultsets object has the following properties and methods:

Resultsets.lastInsertId: number|bigint - In INSERT queries this is last generated AUTO_INCREMENT ID
Resultsets.affectedRows: number|bigint - In modifying queries, like INSERT, UPDATE and DELETE this shows how many rows were affected by the query
Resultsets.foundRows: number|bigint - If “foundRows” connection attribute is set, will ask the server to report about “found rows” (matched by the WHERE clause), instead of affected, and “affectedRows” will not be used. See this page for more information.
Resultsets.warnings: number - Number of warnings produced by the last query. To see the warning messages you can use SHOW WARNINGS query.
Resultsets.statusInfo: string - Human-readable information about last query result, if sent by server.
Resultsets.noGoodIndexUsed: boolean - Server can report about nonoptimal queries.
Resultsets.noIndexUsed: boolean
Resultsets.isSlowQuery: boolean
Resultsets.columns: Column[] - Information about columns in resultset.
Resultsets.nPlaceholders: number - Number of ?-placeholders in the SQL query.
Resultsets.hasMore: boolean - True if there are more rows or resultsets to read.
Resultsets.exec(params: any[]): Promise<void> - If this is a prepared query, this function executes it again.
Resultsets.all(): Promise<any[]> - Reads all rows in current resultset to an array.
Resultsets.first(): Promise<any> - Reads all rows in current resultset, and returns the first row.
Resultsets.forEach<T>(callback: (row: any) => T | Promise<T>): Promise<T | undefined> - Reads all rows, and calls the provided callback for each of them.
Resultsets.nextResultset(): Promise<boolean> - Advances to the next resultset of this query, if there is one. Returns true if moved to the next resultset.
Resultsets.discard(): Promise<void> - Reads and discards all the rows in all the resultsets of this query.

Transactions

MyConn class has the following functions to work with transactions:

/**	Start transaction.
    To start regular transaction, call `startTrx()` without parameters.
    To start READONLY transaction, pass `{readonly: true}`.
    To start distributed transaction, pass `{xa: true}`.
    The XA transaction Id will be generated automatically. It will be available through `conn.xaId`.
 **/
function MyConn.startTrx(options?: {readonly?: boolean, xa?: boolean}): Promise<void>;

/**	Creates transaction savepoint, and returns Id number of this new savepoint.
    Then you can call `conn.rollback(pointId)`.
 **/
function MyConn.savepoint(): Promise<number>;

/**	If the current transaction started with `{xa: true}`, this function prepares the 2-phase commit.
    If this function succeeded, the transaction will be saved on the server till you call `commit()`.
    The saved transaction can survive server restart and unexpected halt.
    You need to commit it as soon as possible, all the locks that it holds will be released.
    Usually, you want to prepare transactions on all servers, and immediately commit them, it `prepareCommit()` succeeded, or rollback them, if it failed.
    If you create cross-server session with `pool.session()`, you can start and commit transaction on session level, and in this case no need to explicitly prepare the commit (`session.commit()` will do it implicitly).
 **/
function MyConn.prepareCommit(): Promise<void>;

/**	Rollback to a savepoint, or all.
    If `toPointId` is not given or undefined - rolls back the whole transaction (XA transactions can be rolled back before `prepareCommit()` called, or after that).
    If `toPointId` is number returned from `savepoint()` call, rolls back to that point (also works with XAs).
    If `toPointId` is `0`, rolls back to the beginning of transaction (doesn't work with XAs).
 **/
function MyConn.rollback(toPointId?: number): Promise<void>;

/**	Commit.
    If the current transaction started with `{xa: true}`, you need to call `prepareCommit()` first.
 **/
function MyConn.commit(): Promise<void>;

To start regular transaction call startTrx() without parameters. Then you can create savepoints, rollback to a savepoint, or the whole transaction, and commit.

// To download and run this example:
// export DSN='mysql://root:hello@localhost/tests'
// curl 'https://raw.githubusercontent.com/jeremiah-shaulov/office_spirit_mysql/main/README.md' | perl -ne '$y=$1 if /^```(ts\\b)?/;  print $_ if $y&&$m;  $m=$y&&($m||m~^// deno .*?/example18.ts~)' > /tmp/example18.ts
// deno run --allow-env --allow-net /tmp/example18.ts

import {MyPool} from 'https://deno.land/x/office_spirit_mysql@v0.2.5/mod.ts';

const pool = new MyPool(Deno.env.get('DSN') || 'mysql://root:hello@localhost/tests');

await pool.forConn
(	async conn =>
    {	// CREATE DATABASE
        await conn.query("DROP DATABASE IF EXISTS test1");
        await conn.query("CREATE DATABASE `test1`");

        // USE
        await conn.query("USE test1");

        // CREATE TABLE
        await conn.query("CREATE TABLE t_log (id integer PRIMARY KEY AUTO_INCREMENT, a int)");

        // Start transaction
        await conn.startTrx();

        // Insert a row
        await conn.query("INSERT INTO t_log SET a = 123");

        // Ensure that the row is present
        console.log(await conn.queryCol("SELECT a FROM t_log WHERE id=1").first()); // prints: 123

        // Rollback
        await conn.rollback();

        // The inserted row is not persisted
        console.log(await conn.queryCol("SELECT Count(*) FROM t_log").first()); // prints: 0

        // Drop database that i created
        await conn.query("DROP DATABASE test1");
    }
);

await pool.onEnd();
await pool.closeIdle();

It’s also possible to start a READONLY transaction:

await conn.startTrx({readonly: true});

Or a distributed transaction:

await conn.startTrx({xa: true});

Distributed (aka global) transactions

To be continued…