Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xtlt/denodb-2
MySQL, SQLite, MariaDB, PostgreSQL and MongoDB ORM for Deno (DenoDB 1 from eveningkid)
https://github.com/0xtlt/denodb-2
database deno mysql orm sqlite sqlite3
Last synced: about 1 month ago
JSON representation
MySQL, SQLite, MariaDB, PostgreSQL and MongoDB ORM for Deno (DenoDB 1 from eveningkid)
- Host: GitHub
- URL: https://github.com/0xtlt/denodb-2
- Owner: 0xtlt
- License: mit
- Created: 2020-11-06T15:15:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-08T14:58:24.000Z (about 4 years ago)
- Last Synced: 2024-10-16T18:27:36.362Z (3 months ago)
- Topics: database, deno, mysql, orm, sqlite, sqlite3
- Language: TypeScript
- Homepage:
- Size: 431 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DenoDB 2
## ⚠️ BEFORE : CREDITS ⚠️
This project is first of all a [eveningkid](https://github.com/eveningkid/denodb) project.
I made this new repository to develop new features and correct current bugs.
The logo is also made for the initial project.
## Now the _little_ documentation (from the original repository)
- 🗣Supports PostgreSQL, MySQL, MariaDB, SQLite and MongoDB
- 🔥Simple, typed API
- 🦕Deno-ready
- Read the documentation, WIP doc [here](https://github.com/techtastet/denodb-2/blob/main/docs/Doc.md), you can see the old doc [here](https://eveningkid.github.io/denodb-docs)
```typescript
import {
DataTypes,
Database,
Model,
} from "https://raw.githubusercontent.com/techtastet/denodb-2/main/mod.ts";
const db = new Database("postgres", {
host: "...",
username: "user",
password: "password",
database: "airlines",
});
class Flight extends Model {
static table = "flights";
static timestamps = true;
static fields = {
id: { primaryKey: true, autoIncrement: true },
departure: DataTypes.STRING,
destination: DataTypes.STRING,
flightDuration: DataTypes.FLOAT,
};
static defaults = {
flightDuration: 2.5,
};
}
db.link([Flight]);
await db.sync({ drop: true });
await Flight.create({
departure: "Paris",
destination: "Tokyo",
});
// or
const flight = new Flight();
flight.departure = "London";
flight.destination = "San Francisco";
await flight.save();
await Flight.select("destination").all();
// [ { destination: "Tokyo" }, { destination: "San Francisco" } ]
await Flight.where("destination", "Tokyo").delete();
const sfFlight = await Flight.select("destination").find(2);
// { destination: "San Francisco" }
await Flight.count();
// 1
await Flight.select("id", "destination").orderBy("id").get();
// [ { id: "2", destination: "San Francisco" } ]
await sfFlight.delete();
await db.close();
```
## First steps
Setting up your database with DenoDB is a four-step process:
- **Create a database**, using `Database` (learn more [about clients](#clients)):
```typescript
const db = new Database("postgres", {
host: "...",
username: "user",
password: "password",
database: "airlines",
});
```
- **Create models**, extending `Model`. `table` and `fields` are both required static attributes:
```typescript
class User extends Model {
static table = "users";
static timestamps = true;
static fields = {
id: {
primaryKey: true,
autoIncrement: true,
},
name: DataTypes.STRING,
email: {
type: DataTypes.STRING,
unique: true,
allowNull: false,
length: 50,
},
};
}
```
- **Link your models**, to add them to your database instance:
```typescript
db.link([User]);
```
- Optional: **Create tables in your database**, by using `sync(...)`:
```typescript
await db.sync();
```
- **Query your models!**
```typescript
await User.create({ name: "Amelia" });
await User.all();
await User.deleteById("1");
```
## License
MIT License — [techtastet](https://github.com/techtastet)