mybatis-mapper #


mybatis-mapper can generate SQL statements from the MyBatis3 Mapper XML file in node.js.

You can also use Dynamic SQL elements, for example, <if>, <where>, <foreach>.

__Table of contents__

- Installation
- Usage
- Change Log

Installation ##

``
npm install --save mybatis-mapper
`

Usage ##

mybatis-mapper supports all of dynamic SQL elements.

* <if>
* <choose>, <when>, <otherwise>
* <trim>, <where>, <set>
* <foreach>
* <bind>
* <include>

You can see description of Dynamic SQL of MyBatis3 in the link below.

http://www.mybatis.org/mybatis-3/dynamic-sql.html

$3

First, prepare XML file(s) written in MyBatis3 syntax like below.


#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple' AND



`
- The XML file must have one 'mapper' element, which must have the 'namespace' attribute.
- mybatis-mapper recognizes and parses the 'select', 'insert', 'update', and 'delete' elements in the 'mapper' element as SQL statements.
- You can use CDATA section in xml for well-formed XML.
- other attributes are ignored.

Second, writing Node.js codes.


#### fruits.js ####
`javascript
const mysql = require('mysql2');
const mybatisMapper = require('mybatis-mapper');

// create the connection to database
const connection = mysql.createConnection({
host: 'localhost',
user: 'root',
database: 'test'
});

// create the myBatisMapper from xml file
mybatisMapper.createMapper([ './fruits.xml' ]);

// SQL Parameters
var param = {
category : 'apple',
price : 100
}

// Get SQL Statement
var format = {language: 'sql', indent: ' '};
var query = mybatisMapper.getStatement('fruit', 'testBasic', param, format);

// Do it!
connection.query(query, function(err, results, fields) {
console.log(results);
console.log(fields);
});
`

##### createMapper( [XML Files] ) #####
- This method takes Array of XML files as a arguments.
- Reads and parses the specified xml file to prepare the SQL statements.

##### getStatement(Namespace, SqlID, Parameters, format) #####
- This method takes Namespace, SQL ID, and Parameters as a arguments.
- Create SQL statement from XML using Parameters and return it.
- You can use this SQL string for Node.js MySQL Clients like mysql2.
- "format" argument is Optional, it can set the format of the SQL language and indent.
For more information, see https://www.npmjs.com/package/sql-formatter

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits
WHERE
category = #{category}
AND price > ${price}


`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
category : 'apple',
price : 100
}

var query = mybatisMapper.getStatement('fruit', 'testParameters', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND price > 100
`

- As in the example above, if a variable is enclosed in #{ }, the variable is wrapped in quotation marks.
- The other side, if the variable is enclosed in ${ }, the variable is converted as it is.
- In general, you can use #{ } for a String variable, and ${ } for a numeric value.

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits
WHERE
1=1

AND category = #{category}


AND price = ${price}

AND name = 'Fuji'




`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
category : 'apple',
price : 500
}

var query = mybatisMapper.getStatement('fruit', 'testIf', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
1 = 1
AND category = 'apple'
AND price = 500
AND name = 'Fuji'
`

- You can use dynamic SQL elements repeatedly. for example, <if><if></if></if>

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits

OR category = 'apple'
OR price = 200



`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = null;

var query = mybatisMapper.getStatement('fruit', 'testTrim', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
OR price = 200
`

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits

AND category = 'apple'

AND price = ${price}

AND



`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
price : 500
}

var query = mybatisMapper.getStatement('fruit', 'testWhere', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND price = 500
`

$3

#### fruits.xml ####
`xml




UPDATE
fruits


category = #{category},


price = ${price},


WHERE
name = #{name}


`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
name : 'Fuji',
category : 'apple',
price : 300
}

var query = mybatisMapper.getStatement('fruit', 'testSet', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
UPDATE
fruits
SET
category = 'apple',
price = 300
WHERE
name = 'Fuji'
`

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits



AND name = #{name}


AND category = #{category}

AND price = ${price}



AND category = 'apple'





`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
name : null,
category : 'banana',
price : 300
}

var query = mybatisMapper.getStatement('fruit', 'testChoose', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'banana'
AND price = 300
`

$3

#### fruits.xml ####
`xml




SELECT
name,
category,
price
FROM
fruits

category = 'apple' AND


name = #{name}





`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
apples : [ 'Jonathan', 'Mcintosh', 'Fuji' ]
}

var query = mybatisMapper.getStatement('fruit', 'testForeach', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND (
name = 'Jonathan'
OR name = 'Fuji'
)
`

$3

#### fruits.xml ####
`xml




INSERT INTO
fruits
(
name,
category,
price
)
VALUES

(
#{fruit.name},
#{fruit.category},
${fruit.price}
)



`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
fruits : [
{
name : 'Jonathan',
category : 'apple',
price : 100
},
{
name : 'Mcintosh',
category : 'apple',
price : 500
}
]
}
var query = mybatisMapper.getStatement('fruit', 'testInsertMulti', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
INSERT INTO
fruits (
name,
category,
price
)
VALUES
(
'Jonathan',
'apple',
100
),
(
'Mcintosh',
'apple',
500
)
`

$3

#### fruits.xml ####
`xml





SELECT
name,
category,
price
FROM
fruits
WHERE
name like #{likeName}


`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
name : 'Mc'
}

var query = mybatisMapper.getStatement('fruit', 'testBind', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
name like '%Mc%'
`

$3

#### fruits.xml ####
`xml




fruits



WHERE
category = #{category}



FROM





SELECT
name,
category,
price






`

#### fruits.js ####
`javascript
var mybatisMapper = require('mybatis-mapper');
mybatisMapper.createMapper([ './fruits.xml' ]);
var param = {
category : 'apple'
}

var query = mybatisMapper.getStatement('fruit', 'testInclude', param, {language: 'sql', indent: ' '});
console.log(query);
`

#### result SQL ####
`sql
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
``

Change Log ##

$3

* Fix match with sql-formatter's placeholder types
* Fix function scoping of findMapper & replaceCdata
* Add equalsIgnoreCase replacer

$3

* create namespace if only not exists

$3

* Escape param key for sql string
* Add suffix feature for TRIM
* Fix trim suffix may be empty and param may have underscore
* Solve grave accent issue

$3

* Use escape dollar sign when using replace method

$3

* Fix query with an apostrophe results in an error

$3

* Update dependencies for fix issue #13

$3

* Fix Unexpected end of input error

$3

* Fix JSON data type parsing (arrays/objects)

$3

* Fix bug that Null parameter was not converted.

$3

* Hot fix for <foreach> element.

$3

* Improved parameter conversion logic.
* Bug fix for <trim> <where> elements.

$3

* Added typings for use with TypeScript.

$3

* Hot fix for <include> element.

$3

* Error Handling

$3

* Hot fix for <foreach> element.

$3

* Support <include> element.
* Do not formatting SQL when 'format' parameter is null
* Bug fix

$3

* Support <set> element.
* Support <bind> element.
* SQL formatting using sql-formatter.
* Bug fix

$3

* Support CDATA section
* Bug fix & Error Handling

$3

* Change XML parsing library xml2js to html-parse-stringify2.
* Dynamic SQL elements can use repeatedly. for example, <if><if></if></if>
* Support <choose> <when> <otherwise> element.
* Support <trim> element.

$3

* Initial Version