ObjectMySQL

MySQL objects are classes used to operate MySQL databases.

Below is an example using MySQL objects.

1
2
3
4
5
6
7
8
9
10
11
12
13
var db = require('db');

var conn = db.openMySQL('mysql://root:password@localhost/test');

// call execute method to insert data
var res = conn.execute("insert into user(username, password) values ('testuser', '123456')");
console.log(res);

// call execute method to query data
res = conn.execute("select * from user where username = 'testuser'");
console.log(res);

conn.close();

In the above example, first we usedb.openMySQLThe method creates a MySQL connection object and specifies the connection information. Then we use the execute method to add a new user to the user data table we prepared in advance, and then we call the execute method to query the user record we just created. Finally we call the close method to close the link object and complete our MySQL operation.

inheritance relationship

member properties

rxBufferSize

Integer, database connection receive cache size

1Integer MySQL.rxBufferSize;

txBufferSize

Integer, database connection send cache size

1Integer MySQL.txBufferSize;

type

String, query the current connection database type

1
readonly String MySQL.type;

member function

close

Close current database connection

1
MySQL.close() async;

use

Select the default database for the current database connection

1
MySQL.use(String dbName) async;

Call parameters:

dbName: String, specify the database name

begin

Start a transaction on the current database connection

1
MySQL.begin(String point = "") async;

Call parameters:

point: String, specifies the name of the transaction, not specified by default

commit

Commit the transaction on the current database connection

1
MySQL.commit(String point = "") async;

Call parameters:

point: String, specifies the name of the transaction, not specified by default

rollback

Rollback a transaction on the current database connection

1
MySQL.rollback(String point = "") async;

Call parameters:

point: String, specifies the name of the transaction, not specified by default

trans

Enter a transaction to execute a function, and commit or rollback based on the execution of the function.

1
Boolean MySQL.trans(Function func);

Call parameters:

func: Function, a function executed in a transactional manner

Return results:

Boolean, returns whether the transaction is committed, returns true for normal commit, returns false for rollback, and throws an error if the transaction goes wrong.

There are three results of func execution:

The function returns normally, including end of operation and active return, at which time the transaction will be automatically committed.
The function returns false and the transaction will be rolled back
Function operation error, transaction automatically rolled back

Enter a transaction to execute a function, and commit or rollback based on the execution of the function.

1
2
Boolean MySQL.trans(String point,
    Function func);

Call parameters:

point: String, specifies the name of the transaction
func: Function, a function executed in a transactional manner

Return results:

Boolean, returns whether the transaction is committed, returns true for normal commit, returns false for rollback, and throws an error if the transaction goes wrong.

There are three results of func execution:

The function returns normally, including end of operation and active return, at which time the transaction will be automatically committed.
The function returns false and the transaction will be rolled back
Function operation error, transaction automatically rolled back

execute

Execute a sql command and return the execution result

1
NArray MySQL.execute(String sql) async;

Call parameters:

sql: String, string

Return results:

NArray, returns an array containing result records. If the request is UPDATE or INSERT, the returned result will also include affected and insertId. mssql does not support insertId.

Execute a sql command and return the execution result. The string can be formatted according to the parameters.

1
2
NArray MySQL.execute(String sql,
    ...args) async;

Call parameters:

sql: String, format string, optional parameters are specified with ?. For example: 'SELECT FROM TEST WHERE [id]=?'
args: ..., optional parameter list

Return results:

NArray, returns an array containing result records. If the request is UPDATE or INSERT, the returned result will also include affected and insertId. mssql does not support insertId.

createTable

Create data table

1
MySQL.createTable(Object opts) async;

Call parameters:

opts: Object, parameter list

dropTable

Delete data table

1
MySQL.dropTable(Object opts) async;

Call parameters:

opts: Object, parameter list

createIndex

Create data table index

1
MySQL.createIndex(Object opts) async;

Call parameters:

opts: Object, parameter list

dropIndex

Delete data table index

1
MySQL.dropIndex(Object opts) async;

Call parameters:

opts: Object, parameter list

insert

Insert new record

1
Number MySQL.insert(Object opts) async;

Call parameters:

opts: Object, parameter list

Return results:

Number, returns the id containing the insertion, or 0 if the engine does not support it.

find

Query data based on specified conditions

1
NArray MySQL.find(Object opts) async;

Call parameters:

opts: Object, parameter list

Return results:

NArray, returns records containing results

count

Count the number of data records based on specified conditions

1
Integer MySQL.count(Object opts) async;

Call parameters:

opts: Object, parameter list

Return results:

Integer, returns the number of records containing the result

update

Update data based on specified conditions

1
Integer MySQL.update(Object opts) async;

Call parameters:

opts: Object, parameter list

Return results:

Integer, returns the number of records containing updates

remove

Delete data based on specified conditions

1
Integer MySQL.remove(Object opts) async;

Call parameters:

opts: Object, optional parameter list

Return results:

Integer, returns the number of records containing updates

format

Format a sql command and return the formatted result

1
2
String MySQL.format(String method,
    Object opts);

Call parameters:

method: String, specifies the requested method
opts: Object, optional parameter list

Return results:

String, returns the formatted sql command

Format a sql command and return the formatted result

1
2
String MySQL.format(String sql,
    ...args);

Call parameters:

sql: String, format string, optional parameters are specified with ?. For example: 'SELECT FROM TEST WHERE [id]=?'
args: ..., optional parameter list

Return results:

String, returns the formatted sql command

toString

Returns the string representation of the object. Generally, "[Native Object]" is returned. The object can be re-implemented according to its own characteristics.

1
String MySQL.toString();

Return results:

String, returns the string representation of the object

toJSON

Returns a JSON format representation of the object, generally returning a collection of readable properties defined by the object.

1
Value MySQL.toJSON(String key = "");

Call parameters:

key: String, not used

Return results:

Value, returns a value containing JSON serializable

Development Guide

Basic module

built-in objects

community module

ObjectMySQL

inheritance relationship

member properties

rxBufferSize

txBufferSize

type

member function

close

use

begin

commit

rollback

trans

execute

createTable

dropTable

createIndex

dropIndex

insert

find

count

update

remove

format

toString

toJSON