# orql-executor

> orql executor

Latest version **0.0.10** (published 2019-06-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install orql-executor
pnpm add orql-executor
yarn add orql-executor
bun add orql-executor
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.10 |
| Published | 2019-06-14 |
| First published | 2019-03-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 115.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | qiushijie |
| Maintainers | qiushijie |

## Links

- npm: https://www.npmjs.com/package/orql-executor
- npm.io page: https://npm.io/package/orql-executor

## Dependencies (1)

- [orql-parser](https://npm.io/package/orql-parser.md) 0.0.4

## Recent versions

- 0.0.10 (latest) — 2019-06-14
- 0.0.9 — 2019-06-12
- 0.0.8 — 2019-06-06
- 0.0.7 — 2019-06-04
- 0.0.6 — 2019-05-14
- 0.0.5 — 2019-05-05
- 0.0.3 — 2019-05-05
- 0.0.2 — 2019-05-01
- 0.0.1 — 2019-03-06

## README

orql-executor
---

orql（Object Relational Query Language）是一种对象关系查询语言，使用键（a: {b: c: [d]}）描述对象的树结构。orql还包含表达式和排序等。orql-executor用于执行orql的增删改查操作。

# 运行环境

node.js >= 8.0

使用typescript编写,也支持javascript直接运行

typescript >= 3.0

# 安装

```
yarn add orql-executor

// 安装对应数据库驱动
yarn add mysql
yarn add sqlite3
```

# orql示例

添加用户 `add user: {phone, password}`

用户登陆 `query user(phone = $phone && password = $password): {id, name}`

修改用户名 `update user(id = $id): {name}`

查询全部用户忽略密码 `query user: [*, !password]`

添加角色 `add role: {name}`

添加用户和用户角色 `add user: {phone, password, role}`

查询用户和角色 `query user: [*, role: {*}]`

# 特性

* orql执行
* async/await异步
* 多数据库支持(目前支持mysql和sqlite3)
* 1:1 1:N N:1 N:M关系
* 数据库事务
* 原生sql映射
* 表结构同步

# 文档
* [开始使用](./docs/index.md)
* [schema定义](./docs/schema.md)
* [orql语法](./docs/orql.md)
* [session](./docs/session.md)

# 相关项目
* [orql-baas](https://www.github.com/orql/orql-baas) 基于orql的可视化后端云

# 其他语言
* [java](https://github.com/orql/orql-executor-java)

---
_Source: https://npm.io/package/orql-executor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._