tablestore-orm

通过ORM的方式简化阿里云TableStore使用

特性

• 🌱 适用于 Node.js 4.0 及以上版本
• 😊 使用 TypeScript 进行开发封装，提供完善的类型定义
• 🏗 针对表、表数据、多行数据 分别提供了不同的封装
• 🤖 自动填充全局唯一 id 、created、updated 字段

安装

1. 使用 npm 或 yarn 安装

$ npm install @snail-cloud/tablestore-orm --save

$ yarn add @snail-cloud/tablestore-orm

2. 在项目中使用

import TableStoreOrm from "@snail-cloud/tablestore-orm";

// 初始化 具体配置项请查看文档
const Orm = new TableStoreOrm('<config>')

// 添加一行数据
const {sucess,data} = Orm.insert({tableName:"<tableName>",columns:{phone:"<phone>"}})

约定

我们对表的创建有严格的规定，请务必按照如下规范设计表

初始化表时，需要给定下面三个字段

• id: STRING: 主键/分区建
• created: INTEGER: 预设列
• updated: INTEGER: 预设列

注意：只设置 id 这一个主键，其他数据全部存储为 预设列，请不要在设置其他主键

示例

| 名称 | 类型 | 键类型 | 注释 | | -------- | :----: | :---------: | :--------------------: | | id | string | 主键/分区键 | 必须定义，名称不可变 | | phone | string | 预设键 | 手机号 | | password | string | 预设键 | 密码 | | nickname | string | 预设键 | 昵称 | | ... | ... | ... | ... | | created | string | 预设键 | 框架会自动维护更新 | | updated | string | 预设键 | 框架会自动维护更新 |

参与贡献

欢迎加入到 tablestore-orm 的建设队伍中来，请访问 https://github.com/snail-cloud/tablestore-orm 。