TypeORM Configuration Utilities

Useful utilities for configuring TypeORM.

Features

Provides a default configuration that can work out-of-the-box
Default configuration values can be easily overridden
Uses standard environment variables for runtime configuration
- Interoperable with variables used by common Docker database images (mysql, mariadb, postgres, and more)

Installation

Install the utilities via @formulaic/ormconfig, or import from the bundle @formulaic/api.

Create a datasource.js file:

const { Config } = require("@formulaic/ormconfig");

const config = new Config({
  __dirname, (1)
  type: "mysql",

  hostByNodeEnv: {
    production: "db", (2)
  },

  user: "root",
  pass: "mySecretPassword",

  database: "example-app",
});

// For TypeORM < 3.0
// const options = config.toConnectionOptions();

// For TypeORM >= 3.0
const dataSource = config.toDataSource();

module.exports = dataSource;

1	Providing `__dirname` is optional, but will allow entities to be automatically found in source files, and more.
2	Configured to use `"db"` as the hostname for production, while falling back to `"localhost"` in development

Options

Each section describes a variable that is applicable for one or more databases.

When a variable can be set via more than 1 source, the various sources will be listed from the most default fallback option to the highest priority option, that will override alternatives.

Any environment variable can be supplied by a file. If you have a file /tmp/username.txt that contains a username (e.g. myusername), set MYSQL_USER_FILE=/tmp/username.txt.

Providing a value directly (MYSQL_USER) as well as the filename (MYSQL_USER_FILE) will prevent the file from being read.

Type

The type of database.

Set via:

Configuration type

Values:

"mysql"
"postgres"
"cockroachdb"
"sqlite"
"better-sqlite3"

Synchronize

Can be used on any database.

Determines if the database will update it’s schema each time it starts, instead of using migrations.

Set via:

Default false
Configuration sync: true
Environment DB_SYNC=true