parent
							
								
									aa99358a90
								
							
						
					
					
						commit
						c4eb55e8d4
					
				
							
								
								
									
										107
									
								
								docs/3.x.md
								
								
								
								
							
							
						
						
									
										107
									
								
								docs/3.x.md
								
								
								
								
							| 
						 | 
				
			
			@ -109,32 +109,36 @@ db.tableList().then(list => {
 | 
			
		|||
 | 
			
		||||
* name <String> [必传], 数据库名字
 | 
			
		||||
* options <Object>, [必传], 数据库的配置
 | 
			
		||||
  * charset <String> 默认 utf8
 | 
			
		||||
  - charset <String> 默认 utf8
 | 
			
		||||
 | 
			
		||||
> 创建新的数据库
 | 
			
		||||
 | 
			
		||||
> 创建新的数据库, 成功返回true。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
db.dbCreate('foo', { charset: 'utf8mb4' }) // 默认是utf8
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### tableCreate(name, columns ,options)
 | 
			
		||||
 | 
			
		||||
* name <String> [必传], 表名字
 | 
			
		||||
* columns <Array>, [必传], 表字段的配置
 | 
			
		||||
  * name <String> 字段名, 区分大小写, 建议全小写+下划线
 | 
			
		||||
  * type <String> 字段类型, 不区分大小写
 | 
			
		||||
  * primary <Boolean> 是否主键(有且只能有 1 个主键)
 | 
			
		||||
  * inc <Boolean> 是否自增(只允许主键设置,且为整型时才可设置)
 | 
			
		||||
  * notnull <Boolean> 是否允许非空
 | 
			
		||||
  * index <Boolean> 是否设为索引
 | 
			
		||||
  * unique <Boolean> 是否为 唯一索引
 | 
			
		||||
  * default <Any> 设置默认值
 | 
			
		||||
  * update <Boolean> 是否自动更新(只有 datetime & timestamp 可以设)
 | 
			
		||||
  - name <String> 字段名, 区分大小写, 建议全小写+下划线
 | 
			
		||||
  - type <String> 字段类型, 不区分大小写
 | 
			
		||||
  - primary <Boolean> 是否主键(有且只能有 1 个主键)
 | 
			
		||||
  - inc <Boolean> 是否自增(只允许主键设置,且为整型时才可设置)
 | 
			
		||||
  - notnull <Boolean> 是否允许非空
 | 
			
		||||
  - index <Boolean> 是否设为索引
 | 
			
		||||
  - unique <Boolean> 是否为 唯一索引
 | 
			
		||||
  - default <Any> 设置默认值
 | 
			
		||||
  - update <Boolean> 是否自动更新(只有 datetime & timestamp 可以设)
 | 
			
		||||
* options <Object>, [必传], 表的配置
 | 
			
		||||
  * charset <String> 默认 utf8
 | 
			
		||||
  * engine <String> 默认 InnoDB
 | 
			
		||||
  - charset <String> 默认 utf8
 | 
			
		||||
  - engine <String> 默认 InnoDB
 | 
			
		||||
 | 
			
		||||
> 创建新的数据表
 | 
			
		||||
 | 
			
		||||
> 创建新的数据表, 成功返回true。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
db.tableCreate('student',
 | 
			
		||||
| 
						 | 
				
			
			@ -164,6 +168,10 @@ db.tableCreate('student',
 | 
			
		|||
 {charset: 'utf8mb4'}) // 默认是utf8
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### table(name)
 | 
			
		||||
 | 
			
		||||
* name <String> [必传], 数据表名字
 | 
			
		||||
| 
						 | 
				
			
			@ -174,6 +182,10 @@ db.tableCreate('student',
 | 
			
		|||
let table = db.table('student') //
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
## TABLE API
 | 
			
		||||
 | 
			
		||||
> 是指直接对 table 进行操作的接口。
 | 
			
		||||
| 
						 | 
				
			
			@ -181,8 +193,9 @@ let table = db.table('student') //
 | 
			
		|||
### leftJoin(tables)
 | 
			
		||||
 | 
			
		||||
* tables <Array> 左联, 可以联多个表
 | 
			
		||||
  * table <String> 表名
 | 
			
		||||
  * on <String> 左联的条件
 | 
			
		||||
  - table <String> 表名
 | 
			
		||||
  - on <String> 左联的条件
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
db.table('student')
 | 
			
		||||
| 
						 | 
				
			
			@ -195,16 +208,20 @@ db.table('student')
 | 
			
		|||
  ])
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### rightJoin(tables)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### rightJoin(tables)
 | 
			
		||||
> 参考 leftJoin()
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### join(tables)
 | 
			
		||||
 | 
			
		||||
> 参考 leftJoin()
 | 
			
		||||
 | 
			
		||||
### filter(options)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### filter(options)
 | 
			
		||||
* options <Object>
 | 
			
		||||
 | 
			
		||||
> 查询过滤, 这个方法是增删改查中使用率最高的。 也是 Mysqli 模块的核心方法之一。也是参数最复杂的方法, 一条查询里, 只能出现一次 filter, 多次调用, 会覆盖之前的条件.
 | 
			
		||||
| 
						 | 
				
			
			@ -222,6 +239,7 @@ db.table('student')
 | 
			
		|||
> * $gte 大于等于
 | 
			
		||||
> * $eq 等于
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
db
 | 
			
		||||
  .table('student')
 | 
			
		||||
| 
						 | 
				
			
			@ -269,8 +287,11 @@ db
 | 
			
		|||
// filter基本上满足了你日常绝大部分的查询需求, 如果还有没满足的, 可以自己写sql语句.
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
### sort(keys)
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### sort(keys)
 | 
			
		||||
* keys <Object>
 | 
			
		||||
 | 
			
		||||
> 对结果集排序
 | 
			
		||||
| 
						 | 
				
			
			@ -284,6 +305,13 @@ db
 | 
			
		|||
  .sort({ age: -1, id: 1 })
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### skip(num)
 | 
			
		||||
 | 
			
		||||
* num <Number>
 | 
			
		||||
| 
						 | 
				
			
			@ -294,6 +322,11 @@ db
 | 
			
		|||
db.table('student').skip(10) // 跳过前9条, 即从第10条结果开始返回
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### limit(num)
 | 
			
		||||
 | 
			
		||||
* num <Number>
 | 
			
		||||
| 
						 | 
				
			
			@ -304,6 +337,12 @@ db.table('student').skip(10) // 跳过前9条, 即从第10条结果开始返回
 | 
			
		|||
db.table('student').limit(10) // 限制只返回10条记录
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### slice(start, end)
 | 
			
		||||
 | 
			
		||||
* start <Number>
 | 
			
		||||
| 
						 | 
				
			
			@ -321,6 +360,11 @@ db
 | 
			
		|||
  .limit(10)
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### withFields(fields)
 | 
			
		||||
 | 
			
		||||
* fields <Array> [可选], 不传则返回所有的字段
 | 
			
		||||
| 
						 | 
				
			
			@ -331,6 +375,9 @@ db
 | 
			
		|||
db.table('student').withFields(['id', 'name', 'sex']) // 只取 学号,姓名,性别3个字段返回
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### getAll([ids])
 | 
			
		||||
 | 
			
		||||
* ids <Array> [可选],返回指定 id 的结果集; 不传则返回所有结果集。(仅当没有调用过 filter 的情况下,本参数才有效)
 | 
			
		||||
| 
						 | 
				
			
			@ -370,6 +417,10 @@ db
 | 
			
		|||
// 没有"id"字段的表, 请使用 .filter()方法来查询
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### get(id)
 | 
			
		||||
 | 
			
		||||
* id <Any> [可选], 传入单个 ID。
 | 
			
		||||
| 
						 | 
				
			
			@ -398,6 +449,9 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### count()
 | 
			
		||||
 | 
			
		||||
> 该方法同样是对 getAll 的补充, 它最终是调用 getAll 来实现, 返回结果集的总数。
 | 
			
		||||
| 
						 | 
				
			
			@ -414,6 +468,8 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### insert(doc)
 | 
			
		||||
* doc <Object> 要插入的记录
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -434,6 +490,7 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### update(doc)
 | 
			
		||||
* doc <Object> 要插入的记录
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -453,8 +510,8 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### remove()
 | 
			
		||||
 | 
			
		||||
### remove()
 | 
			
		||||
> 删除记录。返回成功删除的总数。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
| 
						 | 
				
			
			@ -469,8 +526,8 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### drop()
 | 
			
		||||
 | 
			
		||||
### drop()
 | 
			
		||||
> 删除当前数据表, 属于`危险操作`哦。 成功返回true。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
| 
						 | 
				
			
			@ -484,8 +541,8 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### renameTo(name)
 | 
			
		||||
 | 
			
		||||
### renameTo(name)
 | 
			
		||||
> 重命名表。成功返回true。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
| 
						 | 
				
			
			@ -499,7 +556,6 @@ db
 | 
			
		|||
 | 
			
		||||
 | 
			
		||||
### indexList()
 | 
			
		||||
 | 
			
		||||
> 返回当前表的索引列表.
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
| 
						 | 
				
			
			@ -519,6 +575,7 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### indexDrop(name)
 | 
			
		||||
* name <String> 索引名
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -535,12 +592,14 @@ db
 | 
			
		|||
```
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
### indexDrop(name, options)
 | 
			
		||||
* name <String> 索引名
 | 
			
		||||
* options <Object> 索引的配置
 | 
			
		||||
  - field <String> 该索引绑定的字段
 | 
			
		||||
  - unique <Bollean> 是否是唯一索引
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
> 给当前表创建索引. 成功返回true。
 | 
			
		||||
 | 
			
		||||
```javascript
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in New Issue