Dubartesql

Deno + Mysql

Objective

The object I have for this module is to provide a simple way to communicate with an MYSQL database, using an interface similar to Knexjs.

Examples:

Database connection:

(database.ts)

import { database } from "https://deno.land/x/dubartesql/mods.ts";

const db = database({
  hostname: "127.0.0.1",
  db: "<db>",
  username: "root",
  password: "root",
  poolSize: 5, // by default is 5
});
await db.connect();

export default db;

Creating a model:

(models.ts)

import { Model, TableCreator } from "https://deno.land/x/dubartesql/mods.ts";
import db from './database.js';
import { IBook } from './types.d.ts';

// Option 1
export const Books = new Model<IBook>('books'); // params: tableName 

// Option 2
class Book extends Model<IBook> {
    constructor() {
        super('books'); // table name
    }
    
    definition(table : TableCreator) {
        table.increments("id", true);
        table.string("cover");
        table.string("title");
        table.string("ASIN");
        table.string("publisher");
        table.string("creator");
        table.string("language");
        table.string("path");
        table.timestamps(true, true);
        table.addColumn(new Column('amazon_link', 'MEDIUMTEXT'))
    }
}

// Still, you have to create the Model
export const Books = new Book();

Creating a migration file:

(migate.ts)

import db from './database.js';

// Option 1
// You can use the db.schema.createTable method to create the table as follow:
import { Column } from 'https://deno.land/x/dubartesql/mods.ts';

await db.schema.createTable("books", (table: any) => {
  table.increments("id", true);
  table.string("cover");
  table.string("title");
  table.string("ASIN");
  table.string("publisher");
  table.string("creator");
  table.string("language");
  table.string("path");
  table.timestamps(true, true);
  table.addColumn(new Column('amazon_link', 'MEDIUMTEXT')) // when you want a type that is not defined with the helper function
});

// Option 2
// A cleaner option is using the definition method of the Model
import { Books } from 'models.ts';

await Books.migrate();

Database Communication:

import { Books } from './models.ts';
import {IBook} from "./types.d.ts";

const book : IBook = {
    title: 'test',
    path: 'test',
}

const createdBook = await Books.create(book);
console.log(createdBook); // { id: 1, title: 'test', path: 'test', ...}
console.log(await Books.get()); // [{ ... }, {...}, ...]
console.log(await Books.where('id', createdBook.id).get());
console.log(await Books.where('path', 'LINK', '%test%').count()); // 1
console.log(await Books.find(createdBook.id)); // {...} : IBook
console.log(await Books.updateById(createdBook.id, {
    ASIN: 'asin-xpto'
})); // { ... ASIN: 'asin-xpto', ...}
console.log(await Books.where('id', createdBook.id).delete()); // boolean

Future

I would want to add the following features in the future:

Adding migrations
Relationships between tables
More engines
Interface enhancements
Code refactoring

Conclusion

This module is still in development so expect some features missing and bugs. Hopefully, in the next releases, it will have much more to offer. Right now it just works with some limitations.

namadnuno/dubartesql