js-sql-query
v3.0.4
Published
Node.js ORM for MySQL and Microsoft SQL Server
Downloads
52
Maintainers
gintamamadaoReadme
js-sql-query
项目简介
Node.jsorm框架，可以通过链式调用api快捷地生成sql语句
环境安装
安装本项目
npm i js-sql-query --save目录
- Build SQL Api
- Connect To Db
- Test Report
Build SQL Api
语句类型
语句的基本类型有
CREATE，INSERT，REPLACE，UPDATE，SELECT，DELETE，其中INSERT和REPLACE的拼装逻辑是完全一样的，就合在一起讲。
不同的基本类型可以调用的
api不完全一样，有些是公用的，有些是仅限某些基本类型才能调用。
sql 语境
如果我们仅仅需要
sql语句并不需要连接数据库，就可以在新建对象时不传入参数，这时sql语句默认语境是mysql，当然也可以传入字符串mysql或者mssql来指定语境。
// 语境为 mysql
var sqlQuery = SqlQuery("mysql");
// 语境为 Microsoft SQL Server
var sqlQuery = SqlQuery("mssql");
// 不同语境生成的语句不完全一样，会根据相应的数据库类型进行适配通过调用 build 可以获取拼装所得的语句, 只有执行了 build 才会开始拼装语句
sqlQuery
.insert()
.table("table1")
.data({
field1: "value1",
field2: "value2",
})
.build();上面执行结果是以下的 sql 语句：
REPLACE INTO `table1` ( `field1`, `field2` ) VALUES ( 'value1', 'value2' )COMMEN
通用 api, 在任何类型下都能调用的 api
table
设置 sql 语句的要操作的 table
参数
- table (String): 表名
例子
设置一个当前的表名
sqlQuery.select().table("table1");设置一个默认的表名
sqlQuery.table("test_table");build
获取调用 api 的结果，返回 sql 字符串
参数
无
例子
sqlQuery
.insert()
.table("table1")
.data({
field1: "value1",
field2: "value2",
})
.build();
// 输出 REPLACE INTO `table1` ( `field1`, `field2` ) VALUES ( 'value1', 'value2' )storeSql
执行 build 并把 build 出来的 sql 字符串缓存起来
参数
无
例子
sqlQuery
.insert()
.table("table1")
.data({
field1: "value1",
field2: "value2",
})
.storeSql();getStore
返回缓存起来的 sql 字符串
参数
无
例子
sqlQuery.getStore();cleanStoreSql
清空缓存起来的 sql 字符串
参数
无
例子
sqlQuery.cleanStoreSql();INSERT/REPLACE
插入数据类型语句
insert/replace
指定为 INSERT/REPLACE 类型语句
参数
无
例子
sqlQuery.insert();sqlQuery.replace();data
设置
sql语句的插入值信息
参数
- object (Object): 要插入的数据，key 为字段，value 为值
例子
sqlQuery
.replace()
.table("table1")
.data({
field1: "value1",
field2: "value2",
})
.build();REPLACE INTO `table1` ( `field1`, `field2` ) VALUES ( 'value1', 'value2' )multiData
设置 sql 语句多行插入值信息，一次插入一行或多行数据
参数
- array (Array): 数组每个 item 是要插入的数据，key 为字段，value 为值
例子
sqlQuery
.insert()
.table("table1")
.fields(["field1", "field2"])
.multiData([
{
field1: "value1",
field2: "value2",
field3: "value3",
},
{
field1: "value4",
field2: "value5",
field3: "value6",
},
])
.build();INSERT INTO `table1` ( `field1`, `field2` ) VALUES ( 'value1', 'value2' ), ( 'value4', 'value5' )values
设置 sql 语句的插入的值信息
参数
- valuesInfo (String | Function): VALUES 后面的值信息，如果是字符串则是
VALUES ${valuesInfo}, 函数则是VALUES ${valuesInfo()}
例子
sqlQuery
.insert()
.table("table1")
.fields(["field1", "field2"])
.values(() =>
sqlQuery.select().table("table1").fields(["field1", "field2"])
)
.build();INSERT INTO `table1` ( `field1`, `field2` ) VALUES SELECT `field1`, `field2` FROM `table1`fields
设置 sql 语句的插入值的字段
参数
- fields (...String | Array): 可以是多个字符串，或者字符串数组
例子
sqlQuery
.insert()
.table("table1")
.fields("field1", "field2")
.data({
field1: "value1",
field2: "value2",
field3: "value3",
})
.build();INSERT INTO `table1` ( `field1`, `field2` ) VALUES ( 'value1', 'value2' )UPDATE
更新数据类型语句
update
指定 sql 语句为 UPDATE 类型
参数
无
例子
sqlQuery.update();set
设置 sql 语句的更新信息，更新方式为覆盖
参数
- object (Object): 要更新的数据，key 为字段，value 为值
例子
sqlQuery
.update()
.table("table1")
.set({
field1: "value1",
field2: "value2",
})
.where()
.equal({
field1: "value1",
})
.build();UPDATE `table1` SET `field1` = 'value1', `field2` = 'value2' WHERE `field3` = 'value3'add
设置 sql 语句的更新信息，更新方式为增加
参数
- object (Object): 要更新的数据，key 为字段，value 为增量
例子
sqlQuery
.update()
.table("table1")
.add({
field1: 1,
})
.where()
.equal({
field1: "value1",
})
.build();UPDATE `table1` SET `field1` = `field1` + 1 WHERE `field2` = 'value2'minus
设置 sql 语句的更新信息，更新方式为减少
参数
- object (Object): 要更新的数据，key 为字段，value 为减量
例子
sqlQuery
.update()
.table("table1")
.minus({
field1: 1,
})
.where()
.equal({
field1: "value1",
})
.build();UPDATE `table1` SET `field1` = `field1` - 1 WHERE `field2` = 'value2'SELECT
查询数据类型语句
select
指定 sql 语句为 SELECT 类型
参数
无
例子
sqlQuery.select();fields
设置 sql 语句的要获取的字段
参数
- fields (...(String | Object)): 需要的字段名或者带函数的字段
例子
sqlQuery
.select()
.table("table1")
.fields("field1", "field2") //参数也可以是字符串数组，即 ["field1", "field2"]
.build();SELECT `field1`, `field2` FROM `table1`也可以是对象，函数信息
sqlQuery
.select()
.table("table1")
.fields("field1")
.fields(
{ func: "count", field: "field2" },
{ func: "count", field: "field3" }
)
.build();SELECT `field1`, COUNT(`field2`), COUNT(`field3`) FROM `table1`count 等函数
设置 sql 语句的函数，有 count，sum，max，min，avg，abs，ceil，floor，round，log，log2，exp，power，acos，asin，atan，cos，sin，tan，conv，random，rand，radians，degrees，distinct 等函数
参数
- field (string): 字段名
例子
sqlQuery.select().table("table1").fields("field1").count("field2").build();SELECT `field1`, COUNT(`field2`) FROM `table1`groupBy
设置 sql 语句根据某个字段聚合
参数
- field (String): 字段名
例子
sqlQuery
.select()
.table("table1")
.fields("field1")
.count("field2")
.groupBy("field2")
.build();SELECT `field1`, COUNT(`field2`) FROM `table1` GROUP BY `field2`asMap
字段的映射名
参数
- map (Object): key 为字段名，value 为映射名
例子
sqlQuery
.select()
.table("table1")
.fields("field1")
.asMap({
field1: "field1_as",
})
.build();SELECT `field1` AS `field1_as` FROM `table1`multiTables
设置多个表名
参数
- tables (...String): 表名
例子
sqlQuery.select().multiTables("table1", "table2").build();SELECT * FROM `table1`, `table2`tableFields
设置表名与字段名的对应关系
参数
- feildsMap (Object): 表名与字段名的对应关系
例子
sqlQuery
.select()
.table("table1")
.tableFields({
table1: ["field1", "field2"],
})
.build();SELECT `table1`.`field1`, `table1`.`field2` FROM `table1`tableAsMap
设置表的字段名相关的映射名
参数
- asMap (Object): 表的字段名相关的映射名
例子
sqlQuery
.select()
.table("table1")
.tableFields({
table1: ["field1", "field2"],
})
.tableAsMap({
table1: {
field1: "field1_as",
field2: "field2_as",
},
})
.build();SELECT `table1`.`field1` AS `field1_as`, `table1`.`field2` AS `field2_as` FROM `table1`innerJoin
设置联表查询信息
参数
- joinInfo (Object): 联表查询信息
例子
sqlQuery
.select()
.table("table1")
.innerJoin({
tableName: "table2",
termInfos: [
{
symbol: "=",
tableFields: {
table1: "field1",
table2: "field2",
},
},
],
})
.build();SELECT * FROM `table1` INNER JOIN `table2` ON (`table1`.`field1` = `table2`.`field2`)leftJoin
设置联表查询信息，联查类型为 left join
参数和逻辑与 innerJoin api 一致
rightJoin
设置联表查询信息，联查类型为 right join
参数和逻辑与 rightJoin api 一致
DELETE
删除数据类型语句
delete
指定 sql 语句为 DELETE 类型
参数
无
例子
sqlQuery.delete();DELETE 类型并没有特有的 api
sqlQuery
.delete()
.table("table1")
.where()
.equal({
field1: "value1",
})
.build();DELETE FROM `table1` WHERE `field1` = 'value1'CONDITION
条件相关的
api
where
指定之后调用的条件 api 的结果是属于
WHERE后面的
参数
无
例子
sqlQuery
.select()
.table("table1")
.where()
.equal({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` = 'value1'将条件 api 名第一个字母大写，前面加上 where 的前缀，可以直接指定该条件是属于
WHERE后面的
sqlQuery
.select()
.table("table1")
.whereEqual({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` = 'value1'having
指定之后调用的条件 api 的结果是属于
HAVING后面的
参数
无
例子
sqlQuery
.select()
.table("table1")
.having()
.equal({
field1: "value1",
})
.build();SELECT * FROM `table1` HAVING `field1` = 'value1'将条件 api 名第一个字母大写，前面加上 having 的前缀，可以直接指定该条件是属于
HAVING后面的
sqlQuery
.select()
.table("table1")
.havingEqual({
field1: "value1",
})
.build();SELECT * FROM `table1` HAVING `field1` = 'value1'equal
条件 =
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.equal({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` = 'value1'notEqual
条件 <>
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.notEqual({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` <> 'value1'in
条件 IN
参数
- object (Object): 条件信息，key 为字段，value 为数组，为所有有效值的集合
例子
sqlQuery
.select()
.table("table1")
.where()
.in({
field1: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` IN ( 'value1', 'value2' )notIn
条件 NOT IN
参数
- object (Object): 条件信息，key 为字段，value 为数组，为所有有效值的集合
例子
sqlQuery
.select()
.table("table1")
.where()
.notIn({
field1: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` NOT IN ( 'value1', 'value2' )more
条件 >
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.more({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` > 'value1'less
条件 <
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.less({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` < 'value1'moreEqual
条件 >=
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.moreEqual({
field1: "value1",
})
.build(); SELECT * FROM `table1` WHERE `field1` >= 'value1'lessEqual
条件 <=
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.lessEqual({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` <= 'value1'like
条件 LIKE
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.like({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` LIKE '%value1%'notLike
条件 NOT LIKE
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.notLike({
field1: "value1",
})
.build();SELECT * FROM `table1` WHERE `field1` NOT LIKE '%value1%'between
条件 BETWEEN
参数
- object (Object): 条件信息，key 为字段，value 为数组，第一个和第二个值代表范围的上限和下限
例子
sqlQuery
.select()
.table("table1")
.where()
.between({
field1: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` BETWEEN 'value1' AND 'value2'notBetween
条件 NOT BETWEEN
参数
- object (Object): 条件信息，key 为字段，value 为数组，第一个和第二个值代表范围的上限和下限
例子
sqlQuery
.select()
.table("table1")
.where()
.notBetween({
field1: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` NOT BETWEEN 'value1' AND 'value2'orEqual
条件 =，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orEqual({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` = 'value1' OR `field2` = 'value2'orNotEqual
条件 <>，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orNotEqual({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` <> 'value1' OR `field2` <> 'value2'orIn
条件 IN，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为数组，为所有有效值的集合
例子
sqlQuery
.select()
.table("table1")
.where()
.orIn({
field1: ["value1", "value2"],
field2: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` IN ( 'value1', 'value2' ) OR `field2` IN ( 'value1', 'value2' )orNotIn
条件 NOT IN，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为数组，为所有有效值的集合
例子
sqlQuery
.select()
.table("table1")
.where()
.orNotIn({
field1: ["value1", "value2"],
field2: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` NOT IN ( 'value1', 'value2' ) OR `field2` NOT IN ( 'value1', 'value2' )orMore
条件 >，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orMore({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` > 'value1' OR `field2` > 'value2'orLess
条件 <，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orLess({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` < 'value1' OR `field2` < 'value2'orMoreEqual
条件 >=，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orMoreEqual({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` >= 'value1' OR `field2` >= 'value2'orLessEqual
条件 <=，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orLessEqual({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` <= 'value1' OR `field2` <= 'value2'orLike
条件 LIKE，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orLike({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` LIKE '%value1%' OR `field2` LIKE '%value2%'orNotLike
条件 NOT LIKE，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为逻辑值
例子
sqlQuery
.select()
.table("table1")
.where()
.orNotLike({
field1: "value1",
field2: "value2",
})
.build();SELECT * FROM `table1` WHERE `field1` NOT LIKE '%value1%' OR `field2` NOT LIKE '%value2%'orBetween
条件 BETWEEN，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为数组，第一个和第二个值代表范围的上限和下限
例子
sqlQuery
.select()
.table("table1")
.where()
.orBetween({
field1: ["value1", "value2"],
field2: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` BETWEEN 'value1' AND 'value2' OR `field2` BETWEEN 'value1' AND 'value2'orNotBetween
条件 NOT BETWEEN，逻辑为或
参数
- object (Object): 条件信息，key 为字段，value 为数组，第一个和第二个值代表范围的上限和下限
例子
sqlQuery
.select()
.table("table1")
.where()
.orNotBetween({
field1: ["value1", "value2"],
field2: ["value1", "value2"],
})
.build();SELECT * FROM `table1` WHERE `field1` NOT BETWEEN 'value1' AND 'value2' OR `field2` NOT BETWEEN 'value1' AND 'value2'bracket
前后的条件分别用括号括起来
参数
无
例子
sqlQuery
.select()
.table("table1")
.where()
.orEqual({
field1: "value1",
})
.orEqual({
field2: "value2",
})
.bracket()
.orEqual({
field3: "value3",
})
.build();SELECT * FROM `table1` WHERE ( `field1` = 'value1' OR `field2` = 'value2' ) AND ( `field3` = 'value3' )orBracket
前后的条件分别用括号括起来，逻辑为或
参数
无
例子
sqlQuery
.select()
.table("table1")
.where()
.equal({
field1: "value1",
field2: "value2",
})
.orBracket()
.equal({
field3: "value3",
})
.build();SELECT * FROM `table1` WHERE ( `field1` = 'value1' AND `field2` = 'value2' ) OR ( `field3` = 'value3' )ORDER
设置
sql的查找数据的排序逻辑
descBy
根据某些字段降序排序
参数
- fields (...String): 字段名
例子
sqlQuery.select().table("table1").descBy("field1").build();SELECT * FROM `table1` ORDER BY `field1` DESCsqlQuery.select().table("table1").descBy("field1", "field2").build();SELECT * FROM `table1` ORDER BY `field1` DESC, `field2` DESCascBy
根据某些字段升序排序
参数
- fields (...String): 字段名
例子
sqlQuery.select().table("table1").ascBy("field1", "field2").build();SELECT * FROM `table1` ORDER BY `field1` ASC, `field2` ASCsqlQuery.select().table("table1").descBy("field1").ascBy("field2").build();SELECT * FROM `table1` ORDER BY `field1` DESC, `field2` ASCorderField
根据某个字段自定义序列排序
参数
- object (Object): 要更新的数据，key 为字段，value 为数组，数组值的顺序就是查询数据的排序根据。
例子
sqlQuery
.select()
.table("table1")
.orderField({
field1: ["value1", "value2"],
})
.build();SELECT * FROM `table1` ORDER BY FIELD(`field1`, 'value1', 'value2')order
设置 ORDER BY 后面的信息
参数
- orderInfo (String | Function): VALUES 后面的值信息，如果是字符串则是
ORDER BY ${orderInfo}, 函数则是ORDER BY ${orderInfo()}
例子
sqlQuery
.select()
.table("table1")
.order(() =>
sqlQuery.order
.descBy("field1")
.ascBy("field2")
.orderField({
field3: ["value1", "value2"],
})
)
.build();SELECT * FROM `table1` ORDER BY `field1` DESC, `field2` ASC, FIELD(`field3`, 'value1', 'value2')LIMIT/OFFSET
设置查找数据的步长和偏移
offset
设置 sql 语句的偏移
参数
- offset (Number): 偏移量
例子
sqlQuery.select().table("table1").offset(1).build();SELECT * FROM `table1` OFFSET 1step
设置 sql 语句的步长
参数
- step (Number): 步长量
例子
sqlQuery.select().table("table1").step(10).build();SELECT * FROM `table1` LIMIT 10paging
设置 sql 语句的步长和偏移。
参数
- page (Number): 页码，从 1 开始算；
- pageSize (Number): 一页包含的数量；
例子
sqlQuery.select().table("table1").paging(2, 10).build();SELECT * FROM `table1` LIMIT 10 OFFSET 10findOne
限制只返回一个，仅限 SELECT 类型使用
参数
无
例子
sqlQuery.select().table("table1").findOne().build();SELECT * FROM `table1` LIMIT 1CREATE
新建表语句，把表的信息用一定的 json 数据格式保存，然后可以通过
api转换成sql语句。
仅支持
MySQL类型数据库
create
指定 sql 语句为 CREATE 类型
参数
无
例子
sqlQuery.create();info
新建表的信息
参数
- object (Object): 表信息
例子
将下面的 sql 语句用 json 数据格式保存:
CREATE TABLE student (
`id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '学生id',
`name` VARCHAR(32) NOT NULL DEFAULT '' COMMENT '学生名字',
`update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '最后更新时间',
CONSTRAINT `id` PRIMARY KEY (`id`),
CONSTRAINT `pk_id` UNIQUE KEY (`id`,`name`)
) ENGINE=InnoDB AUTO_INCREMENT=10000 DEFAULT CHARSET=utf8 COMMENT='学生信息表';const tableInfo = {
tableName: "student",
primaryKey: "id",
uniqueKey: {
keyName: "pk_id",
combineFields: ["id", "name"],
},
engine: "InnoDB",
autoIncrement: 10000,
defaultCharset: "utf8",
comment: "学生信息表",
fields: [
{
field: "id",
type: "bigint",
unsigned: true,
notNull: true,
autoIncrement: true,
comment: "学生id",
},
{
field: "name",
type: "varchar(32)",
default: "",
notNull: true,
comment: "学生名字",
},
{
field: "update_time",
type: "timestamp",
notNull: true,
default: "CURRENT_TIMESTAMP",
onUpdate: "CURRENT_TIMESTAMP",
comment: "最后更新时间",
},
],
};将 json 数据格式转换成 sql 语句
sqlQuery.create().info(tableInfo).build();CREATE TABLE IF NOT EXISTS student ( `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '学生id',`name` VARCHAR(32) NOT NULL DEFAULT '' COMMENT '学生名字',`update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '最后更新时间',CONSTRAINT `id` PRIMARY KEY (`id`),CONSTRAINT `pk_id` UNIQUE KEY (`id`,`name`) ) ENGINE=InnoDB AUTO_INCREMENT=10000 DEFAULT CHARSET=utf8 COMMENT='学生信息表';字段结构说明
- tableName，表名
- primaryKey，主键
- uniqueKey，索引
- engine，即 ENGINE
- autoIncrement，即 AUTO_INCREMENT，设置自增位置或者是否是自增字段
- defaultCharset，即 DEFAULT CHARSET
- comment，备注
- fields，字段信息
- field，字段名
- type，数据类型
- unsigned，无符号数值
- notNull，不允许为空
- default，设置默认值
- onUpdate，数据更新时字段的更新值
dataBase
新建数据库
参数
- dataBaseName (String): 数据库名
例子
sqlQuery.create().dataBase("database1").build();CREATE DATABASE database1ALTER
ALTER类型语句，用于改变表信息。
仅支持
MySQL类型数据库。
alter
指定 sql 语句为 ALTER 类型
参数
无
例子
sqlQuery.alter();add
添加字段
参数
- object (Object): 字段信息
例子
sqlQuery
.alter()
.table("table1")
.add({
field: "field1",
type: "bigint",
unsigned: true,
notNull: true,
autoIncrement: true,
comment: "学生id",
})
.build();ALTER TABLE `table1` ADD COLUMN `field1` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '学生id'drop
删除字段
参数
- field (String): 字段名
例子
sqlQuery.alter().table("table1").drop("field1").build();ALTER TABLE `table1` DROP COLUMN `field1`modify
修改字段
参数
- field (String): 字段名；
- object (Object): 字段信息；
例子
sqlQuery
.alter()
.table("table1")
.modify("field1", {
type: "varchar(32)",
})
.build();ALTER TABLE `table1` MODIFY COLUMN `field1` VARCHAR(32)change
修改字段
参数
- field (String): 字段名；
- object (Object): 字段信息；
例子
sqlQuery
.alter()
.table("table1")
.change("field1", {
field: "id",
type: "bigint",
})
.build();ALTER TABLE `table1` CHANGE COLUMN `field1` `id` BIGINT字段结构说明
数据字段结构和 CREATE 是基本一样的，但没有 table 相关的字段
- autoIncrement，设置是否是自增字段
- comment，备注
- field，字段名
- type，数据类型
- unsigned，无符号数值
- notNull，不允许为空
- default，设置默认值
- onUpdate，数据更新时字段的更新值
Test Report
Tests are using jest, to run the tests use:
$ npm run testreport detail
-----------------|----------|----------|----------|----------|-------------------|
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s |
-----------------|----------|----------|----------|----------|-------------------|
All files | 76.6 | 59.93 | 65.48 | 76.74 | |
js-sql-query.js | 76.6 | 59.93 | 65.48 | 76.74 |... 3695,3696,3697 |
-----------------|----------|----------|----------|----------|-------------------|
Test Suites: 14 passed, 14 total
Tests: 145 passed, 145 total
Snapshots: 0 total
Time: 3.568s, estimated 4s
Ran all test suites.License (MIT)
Copyright (c) 2019 gintamamadao
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.