TypeORM Seed Utils

TypeORM Seed Utils is an opinionated library to write and run database seeds.

Requires TypeORM 0.3.x or 1.x. TypeORM 0.2.x is only supported by this package - https://www.npmjs.com/package/typeorm-seed connection registry (createConnection, getConnection, getConnectionManager, ormconfig.json auto-loading) in favor of an explicit DataSource instance, and this library follows suit.

Providing a DataSource

The CLI needs a compiled file that exports a TypeORM DataSource instance, the same file you already point typeorm's own CLI at (e.g. via typeorm migration:run -d dist/data-source.js). The export can be the default export, or a named AppDataSource/dataSource export:

// src/data-source.ts
import { DataSource } from 'typeorm';

export const AppDataSource = new DataSource({
  type: 'mysql',
  // ...
  entities: ['dist/data/models/**/*.js'],
});

export default AppDataSource;

The CLI takes care of calling initialize() (if not already initialized) and destroy().

Running the CLI

node ./node_modules/.bin/typeorm-seed <command> <...files> -d <dataSourceFile>

CLI features:

• Execute one or multiple seed files up

node ./node_modules/.bin/typeorm-seed up roles users -d dist/data-source.js

This will execute sequentially the files dist/data/seeds/roles.js and dist/data/seeds/users.js. Base directory (dist/data/seeds) is not configurable at the moment.

• Revert one or multiple seed files down

node ./node_modules/.bin/typeorm-seed down users roles -d dist/data-source.js

This command will revert seed files users.js and roles.js.

• Clear entire database clear

node ./node_modules/.bin/typeorm-seed clear -d dist/data-source.js

Clear all data from all models registered on the given DataSource.

• Show help --help

node ./node_modules/.bin/typeorm-seed --help

Adding seed files

Seed files should be added at src/data/seeds/<seedFile>.ts. Base path will be configurable in the future.

Examples can be found in Tenant Service

Additional functionality

Seed factory manager

Allows generating data and seeding it to database from the provided factories and models.

Code example:

import * as faker from 'faker';
import { SeedFactoryManager } from 'typeorm-seed';
import { SampleModel, OtherModel } from 'data/models';

const createSampleModel = () => ({
  uuid: faker.random.uuid(),
  name: faker.name.firstName(),
});

const createOtherModel = () => ({
  uuid: faker.random.uuid(),
  name: faker.name.firstName(),
});

export const modelsFactories: SeedFactoryManager = new SeedFactoryManager()
  .register(SampleModel, createSampleModel)
  .register(OtherModel, createOtherModel);

Using model factories:

modelsFactories.makeOne(SampleModel); // create a Sample object from random data (using faker factory)
modelsFactories.makeOne(SampleModel, data); // create a Sample object from provided (partial) data
modelsFactories.makeMany(SampleModel, data, 10); // create 10 Sample objects

await modelsFactories.seedOne(SampleModel); // create and save to database one Sample object
await modelsFactories.seedOne(SampleModel, data, 10); // create and save to database 10 Sample objects
await modelsFactories.seedAll(SampleModel, data); // create and save Sample objects from an array of partial entities

Providing a DataSource to an instance of SeedFactoryManager (or use the static SeedFactoryManager.setManager(dataSource.manager), which the CLI does for you):

modelsFactories.setConnection(customDataSource);

Clearing the database (a DataSource must always be provided explicitly, there is no implicit global connection anymore):

import { clearEntities, clearDatabase } from 'typeorm-seed';

clearEntities([SampleModel, OtherModel], dataSource); // deletes data from specified entities

clearDatabase(dataSource); // deletes data from all entities registered on the given DataSource

To do

• Better error handling
• More verbose CLI
• Configurable connection