mybatis-mapper-myyrakle
Advanced tools
Readme
This module is managed separately by fork from OldBlackJoe's mybatis-mapper. Unlike the original version, which is only for mysql, this version is postgresql compatible.
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
npm install --save mybatis-mapper-myyrakle
mybatis-mapper supports all of dynamic SQL elements.
You can see description of Dynamic SQL of MyBatis3 in the link below.
http://www.mybatis.org/mybatis-3/dynamic-sql.html
First, prepare XML file(s) written in MyBatis3 syntax like below.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testBasic">
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple' AND
<![CDATA[ price < 500 ]]>
</select>
</mapper>
Second, writing Node.js codes.
const mysql = require("mysql2");
const mybatisMapper = require("mybatis-mapper-myyrakle");
// 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);
});
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testParameters">
SELECT
name,
category,
price
FROM
fruits
WHERE
category = #{category}
AND price > ${price}
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
category: "apple",
price: 100,
};
var query = mybatisMapper.getStatement("fruit", "testParameters", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND price > 100
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testIf">
SELECT
name,
category,
price
FROM
fruits
WHERE
1=1
<if test="category != null and category !=''">
AND category = #{category}
</if>
<if test="price != null and price !=''">
AND price = ${price}
<if test="price >= 400">
AND name = 'Fuji'
</if>
</if>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
category: "apple",
price: 500,
};
var query = mybatisMapper.getStatement("fruit", "testIf", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
1 = 1
AND category = 'apple'
AND price = 500
AND name = 'Fuji'
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testTrim">
SELECT
name,
category,
price
FROM
fruits
<trim prefix="WHERE" prefixOverrides="AND|OR">
OR category = 'apple'
OR price = 200
</trim>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = null;
var query = mybatisMapper.getStatement("fruit", "testTrim", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
OR price = 200
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testWhere">
SELECT
name,
category,
price
FROM
fruits
<where>
AND category = 'apple'
<if test="price != null and price !=''">
AND price = ${price}
</if>
AND
</where>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
price: 500,
};
var query = mybatisMapper.getStatement("fruit", "testWhere", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND price = 500
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<update id="testSet">
UPDATE
fruits
<set>
<if test="category != null and category !=''">
category = #{category},
</if>
<if test="price != null and price !=''">
price = ${price},
</if>
</set>
WHERE
name = #{name}
</update>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
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);
UPDATE
fruits
SET
category = 'apple',
price = 300
WHERE
name = 'Fuji'
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testChoose">
SELECT
name,
category,
price
FROM
fruits
<where>
<choose>
<when test="name != null">
AND name = #{name}
</when>
<when test="category == 'banana'">
AND category = #{category}
<if test="price != null and price !=''">
AND price = ${price}
</if>
</when>
<otherwise>
AND category = 'apple'
</otherwise>
</choose>
</where>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
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);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'banana'
AND price = 300
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testForeach">
SELECT
name,
category,
price
FROM
fruits
<where>
category = 'apple' AND
<foreach collection="apples" item="name" open="(" close=")" separator="OR">
<if test="name == 'Jonathan' or name == 'Fuji'">
name = #{name}
</if>
</foreach>
</where>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
apples: ["Jonathan", "Mcintosh", "Fuji"],
};
var query = mybatisMapper.getStatement("fruit", "testForeach", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
AND (
name = 'Jonathan'
OR name = 'Fuji'
)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<insert id="testInsertMulti">
INSERT INTO
fruits
(
name,
category,
price
)
VALUES
<foreach collection="fruits" item="fruit" separator=",">
(
#{fruit.name},
#{fruit.category},
${fruit.price}
)
</foreach>
</insert>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
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);
INSERT INTO
fruits (
name,
category,
price
)
VALUES
(
'Jonathan',
'apple',
100
),
(
'Mcintosh',
'apple',
500
)
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<select id="testBind">
<bind name="likeName" value="'%' + name + '%'"/>
SELECT
name,
category,
price
FROM
fruits
WHERE
name like #{likeName}
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
name: "Mc",
};
var query = mybatisMapper.getStatement("fruit", "testBind", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
name like '%Mc%'
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="fruit">
<sql id="sometable">
fruits
</sql>
<sql id="somewhere">
WHERE
category = #{category}
</sql>
<sql id="someinclude">
FROM
<include refid="${include_target}"/>
<include refid="somewhere"/>
</sql>
<select id="testInclude">
SELECT
name,
category,
price
<include refid="someinclude">
<property name="prefix" value="Some"/>
<property name="include_target" value="sometable"/>
</include>
</select>
</mapper>
var mybatisMapper = require("mybatis-mapper-myyrakle");
mybatisMapper.createMapper(["./fruits.xml"]);
var param = {
category: "apple",
};
var query = mybatisMapper.getStatement("fruit", "testInclude", param, {
language: "sql",
indent: " ",
});
console.log(query);
SELECT
name,
category,
price
FROM
fruits
WHERE
category = 'apple'
FAQs
mybatis-mapper can generate SQL statements from the MyBatis3 Mapper XML file in node.js. You can use Dynamic SQL elements
The npm package mybatis-mapper-myyrakle receives a total of 0 weekly downloads. As such, mybatis-mapper-myyrakle popularity was classified as not popular.
We found that mybatis-mapper-myyrakle demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.