ts-framework-sql

A minimalistic framework for typescript based applications, with async/await and decorators support.

This plugin extends the Server for handling a SQL database using TypeORM and Knex.js.

Getting Started

Create a new Database class to handle your entities and connections.

import Config from '../config';
import { Database } from 'ts-framework-sql';
import { User } from './models';

export default class MainDatabase extends Database {
  constructor() {
    super({
      connectionOptions: {
        type: "postgres",
        logging: ["error"],
        host: process.env.DATABASE_HOST || "localhost",
        port: process.env.DATABASE_PORT || "5432",
        username: process.env.DATABASE_USER || "postgres",
        password: process.env.DATABASE_PASSWORD || "postgres",
        database: process.env.DATABASE_NAME || "test",

        // IMPORTANT: Path should be relative to root
        entities: ["./api/models/**/*.ts"],
        migrations: ["./api/migrations/**/*.ts"],
        
        cli: {
          // IMPORTANT: Path should be relative to root
          entitiesDir: "./api/models",
          migrationsDir: "./api/migrations"
        }
      })
    }
  }
}

For more information about configuration, refer to the Connection Options documentation in the TypeORM repository.

Now, you can bind the database initialization to the TS Framework Server instance.

import { Server, ServerOptions, Logger } from 'ts-framework';
import { StatusController } from './controllers/StatusController'
import MainDatabase from './database';

// Prepare the database to be connected later
const database = new MainDatabase();

export default class MainServer extends Server {
  constructor(options: ServerOptions) {
    super({
      port: process.env.PORT || 3000,
      controllers: { status: StatusController },
      // Database will be initialized in the Server lifecycle
      children: [database],
      ...options
    });
  }
} 

Create your first model

import {Entity, PrimaryGeneratedColumn, Column} from "typeorm";

@Entity()
export class User {

  @PrimaryGeneratedColumn("uuid")
  id: number;

  @Column()
  firstName: string;

  @Column()
  lastName: string;

  @Column()
  isActive: boolean;

}

For more information, refer to the Entities documentation in the TypeORM repository.

Update the Main Database to register the new Entity.

import Config from '../config';
import { Database } from 'ts-framework-sql';
import { User } from './models';

export default class MainDatabase extends Database {
  constructor() {
    super({
      connectionOptions: {
        type: "postgres",
        logging: ["error"],
        host: process.env.DATABASE_HOST || "localhost",
        port: process.env.DATABASE_PORT || "5432",
        username: process.env.DATABASE_USER || "postgres",
        password: process.env.DATABASE_PASSWORD || "postgres",
        database: process.env.DATABASE_NAME || "test",
        
        // Register your entities 
        entities: [User],

        // IMPORTANT: Path should be relative to root
        entities: ["./api/models/**/*.ts"],
        migrations: ["./api/migrations/**/*.ts"],
        
        cli: {
          // IMPORTANT: Path should be relative to root
          entitiesDir: "./api/models",
          migrationsDir: "./api/migrations"
        }
      })
    }
  }
}

License

The project is licensed under the MIT License.