atlas-provider-typeorm

Use Atlas with TypeORM to manage your database schema as code. By connecting your TypeORM models to Atlas, you can define and edit your schema directly in TypeScript or JavaScript. Atlas will then automatically plan and apply database schema migrations for you, eliminating the need to write migrations manually.

Atlas brings automated CI/CD workflows to your database, along with built-in support for testing, linting, schema drift detection, and schema monitoring. It also allows you to extend TypeORM with advanced database objects such as triggers, row-level security, and custom functions that are not supported natively.

Use-cases

1. Declarative migrations - Use the Terraform-like atlas schema apply --env typeorm command to apply your TypeORM schema to the database.
2. Automatic migration planning - Use atlas migrate diff --env typeorm to automatically plan database schema changes and generate a migration from the current database version to the desired version defined by your TypeORM schema.

Installation

Install Atlas from macOS or Linux by running:

curl -sSf https://atlasgo.sh | sh

See atlasgo.io for more installation options.

Install the provider by running:

npm i @ariga/atlas-provider-typeorm

Make sure all your Node dependencies are installed by running:

npm i

Standalone

If all of your TypeORM entities exist in a single Node module, you can use the provider directly to load your TypeORM schema into Atlas.

In your project directory, create a new file named atlas.hcl with the following contents:

data "external_schema" "typeorm" {
  program = [
    "npx",
    "@ariga/atlas-provider-typeorm",
    "load",
    "--path", "./path/to/entities",
    "--dialect", "mysql", // mariadb | postgres | sqlite | mssql
  ]
}

env "typeorm" {
  src = data.external_schema.typeorm.url
  dev = "docker://mysql/8/dev"
  migration {
    dir = "file://migrations"
  }
  format {
    migrate {
      diff = "{{ sql . \"  \" }}"
    }
  }
}

As a library

In TS Script

If you want to use the provider as TS program, you can use the provider as follows:

Create a new file named load.ts with the following contents:

#!/usr/bin/env ts-node-script

import { loadEntities } from "@ariga/atlas-provider-typeorm/build/load";

// import typeorm entities you want to load
import { User } from "./entities/User";
import { Blog } from "./entities/Blog";

loadEntities("mysql", [User, Blog]).then((sql) => {
  console.log(sql);
});

In JS Script

If you want to use the provider as JS program, you can use the provider as follows:

Create a new file named load.js with the following contents:

#!/usr/bin/env node

const loadEntities = require("@ariga/atlas-provider-typeorm/build/load").loadEntities;
const EntitySchema = require("typeorm").EntitySchema;

// require typeorm entities you want to load
const post = new EntitySchema(require("./entities/Post"));
const category = new EntitySchema(require("./entities/Category"));

loadEntities("mysql", [post, category]).then((sql) => {
  console.log(sql);
});

Next, in your project directory, create a new file named atlas.hcl with the following contents:

data "external_schema" "typeorm" {
    program = [
        "ts-node",
        "load.ts", // for javascript: "node", "load.js"
    ]
}

env "typeorm" {
    src = data.external_schema.typeorm.url
    dev = "docker://mysql/8/dev"
    migration {
        dir = "file://migrations"
    }
    format {
        migrate {
            diff = "{{ sql . \"  \" }}"
        }
    }
}

Usage

Once you have the provider installed, you can use it to apply your TypeORM schema to the database:

Apply

You can use the atlas schema apply command to plan and apply a migration of your current TypeORM schema to your database. This works by inspecting the target database and comparing it to the TypeORM schema and creating a migration plan. Atlas will prompt you to confirm the migration plan before applying it to the database.

atlas schema apply --env typeorm -u "mysql://root:password@localhost:3306/mydb"

Where the -u flag accepts the URL to the target database.

Diff

Atlas supports a version migration workflow, where each change to the database is versioned and recorded in a migration file. You can use the atlas migrate diff command to automatically generate a migration file that will migrate the database from its latest revision to the current TypeORM schema.

atlas migrate diff --env typeorm 

Supported Databases

The provider supports the following databases:

• MySQL
• MariaDB
• PostgreSQL
• SQLite
• Microsoft SQL Server

Issues

Please report any issues or feature requests in the ariga/atlas repository.

License

This project is licensed under the Apache License 2.0.