xdriver 2.0.2 → 2.0.4

package/README.md

@@ -1,108 +1,147 @@
-## 文档懒得写，更详细API查看源码 目录：src/ts/
+# 说明
 
-### indexDB
+## 初始化Connection
 
+```javascript
+import {KeyRange, Driver} from 'xdriver';
+// 初始化数据库驱动
+const driver = new Driver('demo', version);
+// 定义表结构以及初始化数据
+driver.defineTables({
+    name: 'player',
+    primaryKey: 'id',
+    autoIncrement: true,
+    indexes: [
+        {name: 'age_index', column: 'age'},
+        {name: 'name_index', column: 'name'},
+        {name: 'double_index', column: ['sex', 'age']},
+    ],
+    rows: [{name: 'xxx', age: '', sex: ''}] //初始化数据
+});
+const connect = await driver.connect();
 ```
-import Driver from 'ndriver';
-const driver = new Driver('demo', version?);
-driver.on("process", function (state) {
-    console.log(state)
-})
-driver.open().then(function () {
-    var arrPlayers = []
-    for(let i=0; i<100; i++) {
-        arrPlayers.push({
-            name: `韩梅梅${i}`,
-            sex: `女${i}`
-        })
-    }
-    driver.createTable({
-        name: 'player',
-        primaryKey: 'id',
-        autoIncrement: true,
-        indexes: [
-          {name: 'name_index', column: 'name', unique: true},
-        ],
-        data : arrPlayers
-    })
-})
+
+## 查询操作
+
+```javascript
+const player = connect.table('player');
+
+let results = await player.queryByIndex('age_index', KeyRange.between(10, 20));
+results = await player.queryByIndex('double_index', KeyRange.eq(['女3', 0]));
+results = await player.query(KeyRange.between(10, 20))
+results = connect.queryByIndex('tableName', 'indexName', KeyRange.between(10, 20))
 ```
 
-### API
-#### constructor(name, version?)
-	name: 数据库名字
-	version: 数据库版本 默认1
-	eg: var driver = new Driver('database')
-### open
-	打开数据库连接 返回promise对象 在resolve中可以创建表或者删除表 
-	driver.open().then(() => {
-	    driver.createTable({
-	        name: 'table',
-	        primaryKey: 'key',
-	        indexes: [
-	            {name: 'name_index', column: 'key', unique: true},
-	        ],
-	    })
-	})
-#### Driver.prototype.insert(table, data)
-	table: 表名
-	data: 需要插入的数据 obj or array
-	eg: driver.insert({key: 'key', name: '', ...})
-#### Driver.prototype.select(table, keyRange?, limit?)
-	table: 表名
-	keyRange: KeyRange 包含多种比较操作
-	limit: 取出记录数
-	eg: driver.select('table', keyRange.eq('key'), 1).then(rs => console.log(rs))
-	
-#### Driver.prototype.selectByKey(table, key) 
-	table:表名
-	key: 主键
-	eg: driver.selectByKey('key').then(rs => console.log(rs))
-
-#### Driver.prototype. count (table, keyRange?)
-	根据条件统计记录数
-	table: 表名
-	keyRange: @see select
-	eg: driver.count('table').then(size => console.log(size))
-#### Driver.prototype. update (table, modify, where?)
-	 数据更新，如果数据不存在则新增
-	 table: 表名
-	 modify: 修改的对象
-	 where：条件
-	 eg: driver.update('table', {name: 'xxxx'}, {key: 'key'})
-#### Driver.prototype.delete (table, key)
-	table: 表名
-	key: 主键
-	根据主键删除
-	eg: driver.delete('table', 'key')
-	
-#### Driver.prototype.truncate(table)
-	清空某张表
-    table：表名
-
-### 示例
+## API
+
+### Connection
 
 ```
-const driver = new Driver('pallet', 1);
-driver.on("process", function (state) {
-    console.log(state)
-})
-driver.open().then(function () {
-    var arrPlayers = []
-    for(let i=0; i<100; i++) {
-        arrPlayers.push({
-            name: `韩梅梅${i}`,
-            sex: `女${i}`
-        })
-    }
-    driver.createTable({
-        name: 'player',
-        primaryKey: 'id',
-        autoIncrement: true,
-        indexes: [
-          {name: 'name_index', column: 'name', unique: true},
-        ],
-        data : arrPlayers
-    })
-})
+/**
+ * 查询数据
+ * @param table 表名
+ * @param query 查询条件
+ * @param count 查询数量
+ */
+query<R extends Row>(table: string, query?: IDBValidKey | IDBKeyRange, count: number = 1000): Promise<RowPacket<R>>;
+
+/**
+ * 查询数据
+ * @param table 表名
+ * @param key 查询条件
+ * @param index 索引名称
+ * @param count 查询数量
+ */
+select<R extends Row>(table: string, key?: IDBValidKey | IDBKeyRange, index?: string, count: number = 1000): Promise<RowPacket<R>>;
+
+/**
+ * 获取数据
+ * @param table 表名
+ * @param key 查询条件
+ */
+queryByKey<R extends Row>(table: string, key: IDBValidKey | IDBKeyRange): Promise<RowPacket<R>>;
+
+/**
+ *
+ * @param table
+ * @param indexName 索引名称
+ * @param key key or keyRange (对应的是索引包含的列的数据)
+ * @param count 返回的列数
+ */
+async queryByIndex<R extends Row>(table: string, indexName: string, key?: IDBValidKey | IDBKeyRange, count?: number): Promise<RowPacket<R>>;
+
+/**
+ * 获取数据
+ * @param table
+ * @param id
+ * @param indexName
+ */
+async queryById<R extends Row>(table: string, id: any | Array<any>, indexName?: string): Promise<R>;
+
+/**
+ * 获取数据
+ * @param table 表名
+ * @param key 查询条件
+ */
+count(table: string, key: IDBValidKey | IDBKeyRange);
+
+/**
+ * 插入数据
+ * @param table
+ * @param data
+ */
+insert(table: string, data: Array<Record<string, any>>);
+
+/**
+ * 更新数据
+ * @param table 表名
+ * @param modify 更新内容
+ * @param key 条件
+ */
+update(table: string, modify: Row, key?: IDBValidKey | IDBKeyRange | null);
+
+/**
+ * 删除数据
+ * @param table 表名
+ * @param key 索引名称
+ */
+delete(table: string, key: IDBValidKey | IDBKeyRange);
+
+/**
+ * 清空表
+ * @param table 表名
+ */
+truncate(table: string);
+
+/**
+ * 获取内存分页模型对象
+ * @param table
+ * @param pageSize
+ */
+getPagination<R extends Row>(table: string, pageSize: number = 10): Promise<Pagination<R>>;
+
+/**
+ * 扫描数据
+ * @param table 表名
+ * @param key key or keyRange (对应的是主键的数据)
+ * @param direction 游标方向
+ * @param indexName 索引名称
+ */
+async scan<R extends Row>(table: string, key?: IDBValidKey | IDBKeyRange, direction: IDBCursorDirection = 'next', indexName?: string): Promise<RowPacket<R>>;
+
+/**
+ * 获取所有数据
+ * @param table
+ */
+getAllData<R extends Row>(table: string): Promise<Array<R>>;
+
+/**
+ * 分页查询
+ * @param table
+ * @param pageNo 页码
+ * @param pageSize 每页数量
+ * @param key (对应的是主键的数据)
+ * @param indexName 索引名称
+ */
+async paginate<R extends Row>(table: string, pageNo: number = 1, pageSize: number = 10, key?: IDBValidKey | IDBKeyRange, indexName?: string): Promise<RowPacket<R>>;
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xdriver",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "A simple driver for IndexDB",
   "main": "./lib/index",
   "files": [
@@ -16,7 +16,7 @@
     "url": "https://gitee.com/xxx/indexdb.git"
   },
   "keywords": [
-    "storage"
+    "indexdb"
   ],
   "author": "xs",
   "license": "ISC",