Repository
Current version released
4 years ago
Deno Simple Orm
dso
is a simple ORM Library based on deno_mysql
Example
import {
BaseModel,
Defaults,
dso,
Field,
FieldType,
Join,
Model,
Where
} from "https://deno.land/x/dso@v1.0.0/mod.ts";
// Define a database model
@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;
}
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.
// 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);
}
main();
Top Level API
dso.showQueryLog
Set whether query debugging information is displayed
dso.showQueryLog = true;
dso.connect
You need to use this method to link to the database before you can manipulate the database
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.
@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;
}
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.
// 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.
const result = await dso.transaction<boolean>(async trans => {
const userModel = trans.getModel(UserModel);
const topicModel = trans.getModel(TopicModel);
userId = await userModel.insert({ nickName: "foo", password: "bar" });
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 | 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 |