Is TypeORM the Superhero Your TypeScript Project Needs?

Magic of TypeORM: Streamlined Database Management for TypeScript and JavaScript Devs

May 2, 2023

Is TypeORM the Superhero Your TypeScript Project Needs?

TypeORM, you say? Let’s dive into why this ORM tool is turning heads in the world of TypeScript and JavaScript development. It’s pretty much the go-to toolbox for anyone who wants to simplify the whole ordeal of database interactions in a way that’s both straightforward and powerful. Working with databases was never this cool!

The magic behind TypeORM lies in how it transforms database tables and application objects into one cohesive unit. It’s like having a trusty sidekick who handles all the tedious tasks, freeing you up to focus on coding awesomeness. No wonder it’s a big hit among developers looking to streamline their projects.

Features That Make TypeORM Shine

Why do devs love TypeORM? For starters, it’s got wide-ranging support for popular relational databases. MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, SAP Hana, and WebSQL—TypeORM’s got them all covered. So no matter what database you’re vibing with, you can bet TypeORM will play nice with it.

Another sweet feature is its compatibility with both TypeScript and JavaScript. Though crafted with TypeScript in mind, it doesn’t leave JavaScript folks out in the cold. Strong type checking, classy classes, and easy-breezy decorators—TypeORM leverages all the TypeScript goodness while playing well with ES5, ES6, and ES7. Dual-language support? Check!

Adding to the charm, TypeORM lets you choose between Active Record and Data Mapper patterns. It provides the flexibility to write scalable, maintainable code in a way that suits your project style.

And did someone say CLI commands? Oh yeah! TypeORM’s CLI is a heaven-sent feature for kicking off projects quickly. Just a simple command like typeorm init and—bam!—you’ve got your skeleton ready to start fleshing out.

Hitting the Ground Running with TypeORM

Getting started with TypeORM couldn’t be easier. A quick spin with its CLI, and you’re all set to punch in some code. Consider this—if PostgreSQL is your database darling, you can spin up a new project with a single line of code:

npx typeorm init --name MyProject --database postgres

This swiftly drops a new project folder filled with all the necessary files—entity, migration, data-source.ts, and index.ts files. After that, installing dependencies and tweaking your data-source.ts to set up the DB connection are just child’s play.

The Lowdown on Defining Entities

Entities are where the database magic starts to happen. In TypeORM, entities translate to classes representing your database tables. Thanks to decorators, creating these entities is like crafting a beautiful symphony: elegant and seamless. For instance, if you want a User entity, it’s as easy as pie:

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

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @Column()
  email: string;
}

In these few lines, you’ve got a User table ready to roll with an id, name, and email.

Wrangling Queries with TypeORM

TypeORM’s query builder is like a Swiss Army knife for constructing those complex SQL queries without the headache. Want to fetch all users from the database? Here’s how you do it, seamless and slick:

import { getRepository } from "typeorm";
import { User } from "./User.entity";

const userRepository = getRepository(User);
const users = await userRepository.find();
console.log(users);

With this snippet, you’re retrieving users effortlessly and logging them out, ready to take on the world—or at least your next project phase.

Navigating Entity Relationships

Relationships in databases can be tricky? Not with TypeORM. It’s got you covered with support for one-to-one, one-to-many, and many-to-many relationships. Say you’re setting up a one-to-many between User and Post entities. Here’s how you nail it:

import { Entity, Column, PrimaryGeneratedColumn, OneToMany } from "typeorm";
import { Post } from "./Post.entity";

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  name: string;

  @OneToMany(() => Post, (post) => post.user)
  posts: Post[];
}

@Entity()
export class Post {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  title: string;

  @ManyToOne(() => User, (user) => user.posts)
  user: User;
}

Here’s the magic—this code effortlessly sets up a multiple-posts-to-one-user relationship. Easy-peasy!

Keep It Evolving with Migrations

Database schema changes can feel like shifting tectonic plates, but TypeORM handles it with grace. Managing these changes over time with migrations is smooth sailing. Creating a fresh migration for adding a column? Just a cakewalk:

npx typeorm migration:create --name AddEmailColumn

Then, you hop into the generated migration file and lay out your schema changes. Let’s add that new email column to the User entity:

import { MigrationInterface, QueryRunner } from "typeorm";

export class AddEmailColumn1587723412439 implements MigrationInterface {
  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`ALTER TABLE "user" ADD "email" character varying NOT NULL`);
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`ALTER TABLE "user" DROP COLUMN "email"`);
  }
}

Hit the run button, and:

npx typeorm migration:run

Your database schema is now perfectly in sync with your application code. Smooth, right?

TypeORM Plays Nicely with Express

And it gets even better. TypeORM pairs perfectly with the Express framework, creating a dynamic duo for building web apps. Setting up an Express server with TypeORM integration? Piece of cake:

import express from "express";
import { createConnection } from "typeorm";
import { User } from "./User.entity";

const app = express();
app.use(express.json());

createConnection({
  type: "postgres",
  url: "localhost:5432",
  username: "username",
  password: "password",
  database: "database",
  entities: [User],
  synchronize: true,
}).then((connection) => {
  const userRepository = connection.getRepository(User);

  app.get("/users", async (req, res) => {
    const users = await userRepository.find();
    res.json(users);
  });

  app.post("/users", async (req, res) => {
    const user = await userRepository.save(req.body);
    res.json(user);
  });

  app.listen(3000, () => {
    console.log("Server is running on port 3000");
  });
}).catch((error) => console.log(error));

This snippet sets up an Express server, complete with endpoints to get and create users. All you have to do is focus on crafting your web app masterpiece.

Wrapping It Up

TypeORM is like that versatile multitool you never knew you needed but can’t live without. Its support for multiple databases, user-friendly query builder, and seamless integration with frameworks like Express make it a no-brainer for developers. Whether you’re piecing together a small app or engineering a colossal enterprise system, TypeORM’s got your back, making database management intuitive and efficient. Dive in and see how much lighter your workload can get with TypeORM by your side.