Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/walinejs/dittorm
A Node.js ORM for MySQL, SQLite, PostgreSQL, MongoDB, GitHub and serverless service like Deta, InspireCloud, CloudBase, LeanCloud.
https://github.com/walinejs/dittorm
cloudbase deta github inspirecloud leancloud mongodb mysql nodejs orm postgresql serverless sqlite
Last synced: 2 months ago
JSON representation
A Node.js ORM for MySQL, SQLite, PostgreSQL, MongoDB, GitHub and serverless service like Deta, InspireCloud, CloudBase, LeanCloud.
- Host: GitHub
- URL: https://github.com/walinejs/dittorm
- Owner: walinejs
- License: mit
- Created: 2022-02-22T15:25:07.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-14T02:23:27.000Z (5 months ago)
- Last Synced: 2024-09-14T15:37:09.001Z (5 months ago)
- Topics: cloudbase, deta, github, inspirecloud, leancloud, mongodb, mysql, nodejs, orm, postgresql, serverless, sqlite
- Language: TypeScript
- Homepage:
- Size: 260 KB
- Stars: 27
- Watchers: 4
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deta - Dittorm - A Node.js ORM for MySQL, SQLite, PostgreSQL, MongoDB, GitHub and serverless service like Deta, InspireCloud, CloudBase, LeanCloud. (ORM's / JavaScript ORM)
README
# Dittorm
A Node.js ORM for MySQL, SQLite, PostgreSQL, MongoDB, GitHub and serverless service like Deta, InspireCloud, CloudBase, LeanCloud.
## Installation
```
npm install dittorm --save
```
## Quick Start
```js
const Model = require('dittorm')('leancloud');
const userModel = new Model('user', {
appId: 'xxx',
appKey: 'xxx',
masterKey: 'xxx'
});
const user = await userModel.add({
username: 'lizheming',
email: '[email protected]'
});
const findUser = await user.select({email: '[email protected]'});
```
## Documentation
### Configuration
#### LeanCloud
```js
const Model = require('dittorm')('leancloud');
const userModel = new Model('user', {
appId: 'xxx',
appKey: 'xxx',
masterKey: 'xxx'
});
```
| Name | Required | Default | Description |
| ----------- | -------- | ------- | ----------- |
| `appId` | ✅ | | |
| `appKey` | ✅ | | |
| `masterKey` | ✅ | | |
#### Deta
```js
const Model = require('dittorm')('deta');
const userModel = new Model('user', {
token: 'xxx'
});
```
| Name | Required | Default | Description |
| ------- | -------- | ------- | ----------------------- |
| `token` | ✅ | | Deta project secret key |
#### InspireCloud
```js
const Model = require('dittorm')('inspirecloud');
const userModel = new Model('user', {
serviceId: 'xxx',
serviceSecret: 'xxx'
});
```
| Name | Required | Default | Description |
| --------------- | -------- | ------- | --------------------------- |
| `serviceId` | ✅ | | InspireCloud Service ID |
| `serviceSecret` | ✅ | | InspireCloud Service Secret |
#### CloudBase
```js
const Model = require('dittorm')('cloudbase');
const userModel = new Model('user', {
env: 'xxx',
secretId: 'xxx',
secretKey: 'xxx'
})
```
| Name | Required | Default | Description |
| ----------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `env` | ✅ | | CloudBase enviroment ID |
| `secretId` | ✅ | | CloudBase API secret Id, apply it at [here](https://console.cloud.tencent.com/cam/capi) |
| `secretKey` | ✅ | | CloudBase API secret Key, apply it at [here](https://console.cloud.tencent.com/cam/capi) |
#### GitHub
```js
const Model = require('dittorm')('github');
const userModel = new Model('user', {
token: 'xxx',
repo: 'xxx',
path: 'xxx',
})
```
| Name | Required | Default | Description |
| ----- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------- |
| token | ✅ | | [Personal access tokens](https://github.com/settings/tokens) |
| repo | ✅ | | repository name, such as `walinejs/dittorm` |
| path | | | The data storage directory, such as `data` means it is stored in the `data` directory, root directory by default |
#### MySQL
```js
const Model = require('dittorm')('mysql');
const userModel = new Model('user', {
host: '127.0.0.1',
port: 3306,
database: 'blog',
user: 'admin',
password: 'admin',
prefix: 'dt_',
charset: 'utf8mb4',
dateString: true
})
```
| Name | Required | Default | Description |
| ---------- | -------- | --------- | --------------------- |
| `host` | | 127.0.0.1 | MySQL server address |
| `port` | | 3306 | MySQL server port |
| `database` | ✅ | | MySQL database name |
| `user` | ✅ | | MySQL server username |
| `password` | ✅ | | MySQL server password |
| `prefix` | | | MySQL table prefix |
| `charset` | | | MySQL table charset |
#### SQLite
| Name | Required | Default | Description |
| ---------- | -------- | ------- | ------------------------------------------------------------------- |
| `path` | ✅ | | SQLite storage file path, not include file name |
| `database` | | | SQLite storage file name, change it if your filenamed is not waline |
| `prefix` | | | SQLite table prefix |
#### PostgreSQL
```js
const Model = require('dittorm')('postgresql');
const userModel = new Model('user', {
host: '127.0.0.1',
port: 5432,
database: 'blog',
user: 'admin',
password: 'admin',
prefix: 'dt_',
connectionLimit: 1,
})
```
| Name | Required | Default | Description |
| ---------- | -------- | --------- | -------------------------- |
| `host` | | 127.0.0.1 | PostgreSQL server address |
| `port` | | 3211 | PostgreSQL server port |
| `database` | ✅ | | PostgreSQL database name |
| `user` | ✅ | | PostgreSQL server username |
| `password` | ✅ | | PostgreSQL server password |
| `prefix` | | | PostgreSQL table prefix |
#### MongoDB
```js
const Model = require('dittorm')('mongodb');
const userModel = new Model('user', {
host: '127.0.0.1',
port: 27017,
database: 'blog',
user: 'admin',
password: 'admin',
options: {
replicaset: 'xxx',
authSource: 'admin',
ssl: true
}
});
```
| Name | Required | Default | Description |
| ------------- | -------- | --------- | -------------------------------------------- |
| `host` | | 127.0.0.1 | MongoDB server address, support array format |
| `port` | | 27017 | MongoDB server port, support array format |
| `database` | ✅ | | MongoDB database name |
| `user` | ✅ | | MongoDB server username |
| `password` | ✅ | | MongoDB server password |
| `replicaset` | | | MongoDB replica set |
| `authSourcce` | | | MongoDB auth source |
| `ssl` | | | use SSL connection |
### API
#### add(data)
Save store data.
```js
const data = await userModel.add({ username: 'lizheming', email: '[email protected]' });
console.log(data.id);
```
#### select(where, options)
Find store data by condition.
```js
// SELECT * FROM user WHERE username = 'lizheming';
const data = await userModel.select({ username: 'lizheming' });
// SELECT email FROM user WHERE username = 'lizheming' ORDER BY email DESC LIMIT 1 OFFSET 1;
const data = await userModel.select({ username: 'lizheming' }, {
field: ['email'],
desc: 'email',
limit: 1,
offset: 1
});
// SELECT * FROM user WHERE username != 'lizheming';
const data = await userModel.select({ username: ['!=', 'lizheming'] });
// SELECT * FROM user WHERE create_time > '2022-01-01 00:00:00';
const data = await userModel.select({ username: ['>', '2022-01-01 00:00:00'] });
// SELECT * FROM user WHERE username IN ('lizheming', 'michael');
const data = await userModel.select({ username: ['IN', ['lizheming', 'michael']] });
// SELECT * FROM user WHERE username NOT IN ('lizheming', 'michael');
const data = await userModel.select({ username: ['NOT IN', ['lizheming', 'michael']] });
// SELECT * FROM user WHERE username LIKE '%li%';
const data = await userModel.select({ username: ['LIKE', '%li%'] });
// SELECT * FROM user WHERE username = 'lizheming' AND create_time > '2022-01-01 00:00:00';
const data = await userModel.select({
username: 'lizheming',
create_time: ['>', '2022-01-01 00:00:00']
});
// SELECT * FROM user WHERE username = 'lizheming' OR create_time > '2022-01-01 00:00:00';
const data = await userModel.select({
_complex: {
username: 'lizheming',
create_time: ['>', '2022-01-01 00:00:00'],
_logic: 'OR'
}
});
```
#### update(data, where)
Update store data by condition. `where` format same as `select(where, options)`.
#### count(where)
Return store data count by condition. `where` format same as `select(where, options)`.
#### delete(where)
Clean store data by condition. `where` format same as `select(where, options)`.