Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manyuanrong/dso
Simple Orm library for Deno based on deno_mysql
https://github.com/manyuanrong/dso
Last synced: about 1 month ago
JSON representation
Simple Orm library for Deno based on deno_mysql
- Host: GitHub
- URL: https://github.com/manyuanrong/dso
- Owner: manyuanrong
- License: mit
- Created: 2019-03-07T06:28:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-27T02:56:22.000Z (over 3 years ago)
- Last Synced: 2024-10-04T11:22:26.606Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 112 KB
- Stars: 91
- Watchers: 5
- Forks: 16
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-deno - dso - 一个基于MySQL的简单ORM库。 (Uncategorized / Uncategorized)
- awesome-deno-cn - @manyuanrong/dso
- awesome-deno - dso - A simple ORM library based on mysql. (Modules / Online Playgrounds)
- awesome-deno - dso - A simple ORM library based on mysql. (Modules / Database)
README
## Deno Simple Orm
[](https://www.travis-ci.org/manyuanrong/dso)
`dso` is a simple ORM Library based on [deno_mysql](https://github.com/manyuanrong/deno_mysql)
### Example
```ts
import {
BaseModel,
Defaults,
dso,
Field,
FieldType,
CharsetType,
Index,
IndexType,
Join,
Model,
Where
} from "https://deno.land/x/[email protected]/mod.ts";
// Define a database model
@Model("users")
class UserModel extends BaseModel {
// Character set for whole table. UTF-8 is default and is not necessary to define.
charset: CharsetType.utf8;
// The ! operator is needed for primary key since it's never null
@Field({
type: FieldType.INT,
primary: true,
length: 11,
autoIncrement: true
})
id: number;
@Field({ type: FieldType.STRING, length: 30 })
name: string;
@Field({ type: FieldType.STRING, length: 30 })
password: string;
// Charset can be explicitly defined for each column.
@Field({ type: FieldType.STRING, length: 60, charset: CharsetType.utf8mb4 })
namespace: string;
// Index can be created [index/unique/spatial/fulltext] for each field
@Field({ type: FieldType.STRING, length: 30, unique: true })
email: string;
// Multi column index can be defined by decorated @Index
@Index({ type: IndexType.UNIQUE, columns: ["username","namespace"] })
public myUniqueIndex!: Index;
}
const userModel = dso.define(UserModel);
async function main() {
// The database must be created before linking
await dso.connect({
hostname: "127.0.0.1",
port: 3306,
username: "root",
password: "",
db: "dbname"
});
/*
When installing or initializing a database,
you can use dso.sync to synchronize the database model to the database.
Use false as the parameter if you want to sync only newly added models,
Use true as the parameter if you want to sync the whole defined models
to the database tables.
== WARNING! ==
Using true as the parameter will reset your whole database! Use with caution.
*/
await dso.sync(false);
// You can add records using insert method
const insertId = await userModel.insert({
name: "user1",
password: "password"
});
// You can use the Model.findById method to get a record
const user = await userModel.findById(1);
// You can use Where clause too to get a record. For more information on
// clauses such as join, order, etc. please consult:
// https://github.com/manyuanrong/sql-builder
// findOne + Where
const userWhere = await userModel.findOne(Where.from({ name: "user1" }));
// findAll + Where
const userAll = await userModel.findAll(Where.from({ name: "user1" }));
// findAll + expr like
const userLike = await userModel.findAll(Where.expr("name like 'user%'"));
console.log("Found user by id:", user);
console.log("Found user by where eq clause:", userWhere);
console.log("All users by where eq clause:", userAll);
console.log("All users by where like clause:", userLike);
console.log("User has these columns in index:", user.myUniqueIndex.columns);
}
main();
```
## Running
Since this library needs to use Typescript Decorators and other features, a custom `tsconfig.json` needs to be added. Example config file can be found [here](https://github.com/manyuanrong/dso/blob/master/tsconfig.json), or just copy the contents below and create a new `tsconfig.json` file in your root directory.
`tsconfig.json`
```json
{
"compilerOptions": {
"allowJs": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"module": "esnext",
"isolatedModules": false
}
}
```
To run, use:
```sh
deno run --allow-net -c tsconfig.json main.ts
```
where `main.ts` is your Typescript file for Deno.
### Top Level API
#### dso.showQueryLog
Set whether query debugging information is displayed
```ts
dso.showQueryLog = true;
```
#### dso.connect
You need to use this method to link to the database before you can manipulate the database
```ts
await dso.connect({
hostname: "127.0.0.1", // database hostname
port: 3306, // database port
username: "root", // database username
password: "", // database password
db: "dbname" // database name. (tips: The database must be created before linking)
});
```
#### dso.define()
Add an annotated `Model` instance and return the instance.
```ts
@Model("users")
class UserModel extends BaseModel {
@Field({
type: FieldType.INT,
primary: true,
length: 11,
autoIncrement: true
})
id!: number;
@Field({ type: FieldType.STRING, length: 30 })
name?: string;
@Field({ type: FieldType.STRING, length: 30 })
password: string;
@Field({
type: FieldType.STRING,
unique: true,
length: 20})
phoneNumber?: string;
}
}
export default const userModel = dso.define(UserModel);
// userModel.findById(...)
// userModel.findAll(...)
// userModel.findOne(...)
// userModel.insert(...)
// userModel.update(...)
// userModel.delete(...)
```
#### dso.sync
When installing or initializing a database, you can use sync to synchronize the database model to the database.
```ts
// If set to FORCE, tables will be deleted before they are created,
// otherwise only new models will be synchronized.
const force = true; // force
await dso.sync(force);
```
#### dso.transaction(processor: (transaction: Transaction) => Promise): Promise
Create and start a transaction.
New `Model` instances must be obtained through `getModel(Model)`. Otherwise, it will not be controlled by transactions.
```ts
const result = await dso.transaction(async trans => {
const userModel = trans.getModel(UserModel);
const topicModel = trans.getModel(TopicModel);
userId = await userModel.insert({ nickName: "foo", password: "bar", phoneNumber: "08135539123" });
topicId = await topicModel.insert({ title: "zoo", userId });
return true;
});
```
### Top Level Types
#### FieldType
- `DATE`
- `INT`
- `TEXT`
- `STRING`
- `BOOLEAN`
#### Field
Field type describes the following properties of a field
| key | type | default value | desc |
| ------------- | ------------------------------------ | ------------- | -------------------------------------------------------------------------------------------- |
| type | one of the [FieldTypes](https://github.com/manyuanrong/dso/blob/8d32e64489baaea053d09d64a378fa19b7331ecb/src/field.ts#L10) | null | types of database fields |
| length | number | unfixed | field length |
| primary | boolean | false | database primary key? |
| default | any | null | default values for fields |
| autoIncrement | boolean | false | identify auto-increment fields. It can only be used for INT types |
| notNull | boolean | false | identity fields can not be null |
| autoUpdate | boolean | false | updated automatically according to the current timestamp. It can only be used for DATE types
| unique | boolean | false | database unique index?
| spatial | boolean | false | database spatial index?
| fullText | boolean | false | database fullText index?
| index | boolean | false | database non unique index?
#### Index
Following types of an index are available
| key | multi column
| ------------- | ------------------------------------
| index | true
| unique | true
| spatial | false
| fulltext | true
#### Character sets
list of valid character sets is based on https://dev.mysql.com/doc/refman/8.0/en/charset-charsets.html