What is the correct method for setting the DATABASE_URL in ormconfig.json?

Question

What is the correct method for setting the DATABASE_URL in ormconfig.json?

As I work on deploying my Vesper server to Heroku, I've encountered a challenge with the ormconfig.json file that Vesper requires.

While setting up my local database, everything runs smoothly as I can input all the necessary fields for the connection string. However, when it comes to adding a database in Heroku, I only have access to the full URL and I'm unsure where to place it within the configuration file.

Currently, this is how my ormconfig.json looks:

{
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  "username": "postgres",
  "password": "password",
  "database": "test",
  "synchronize": true,
  "entities": ["target/entity/**/*.js"],
  "migrations": ["target/migrations/*.js"],
  "cli": {
    "migrationsDir": "src/migrations"
  }
}

I'm hoping to streamline the configuration by replacing most of the fields with just the database_url, but I haven't been able to find any documentation specifying where exactly to include it.

typescript heroku typeorm

Answer 1

Answer №1

If you're looking to parse Heroku environment variables, consider utilizing an URL parser like pg-connection-string. You can find more information about it at this link.

To get started with TypeOrm on the server side, use the createConnection function provided by TypeOrm.

import * as PostgressConnectionStringParser from "pg-connection-string";

const databaseUrl: string = process.env.DATABASE_URL;
const connectionOptions = PostgressConnectionStringParser.parse(databaseUrl);
const typeOrmOptions: PostgresConnectionOptions = {
    type: "postgres",
    name: connectionOptions.name,
    host: connectionOptions.host,
    port: connectionOptions.port,
    username: connectionOptions.username,
    password: connectionOptions.password,
    database: connectionOptions.database,
    synchronize: true,
    entities: ["target/entity/**/*.js"],
    extra: {
        ssl: true
    }
};
const connection = createConnection(typeOrmOptions);
...

For managing different configurations, you may need to adjust this code snippet to handle scenarios such as enabling/disabling SSL based on the environment (disabling SSL in dev mode, handling entity formats in .ts for ts-node, etc.).

If generating ormconfig.json is a necessity, you can achieve that by creating the file through a script using the preceding code and including a writing operation:

...
const json = JSON.stringify(typeOrmOptions, null, 2);
fs.writeFile("./target/ormconfig.json", json, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log("File has been created");
});

Answer 2

If you're looking to parse Heroku environment variables, consider utilizing an URL parser like pg-connection-string. You can find more information about it at this link.

To get started with TypeOrm on the server side, use the createConnection function provided by TypeOrm.

import * as PostgressConnectionStringParser from "pg-connection-string";

const databaseUrl: string = process.env.DATABASE_URL;
const connectionOptions = PostgressConnectionStringParser.parse(databaseUrl);
const typeOrmOptions: PostgresConnectionOptions = {
    type: "postgres",
    name: connectionOptions.name,
    host: connectionOptions.host,
    port: connectionOptions.port,
    username: connectionOptions.username,
    password: connectionOptions.password,
    database: connectionOptions.database,
    synchronize: true,
    entities: ["target/entity/**/*.js"],
    extra: {
        ssl: true
    }
};
const connection = createConnection(typeOrmOptions);
...

For managing different configurations, you may need to adjust this code snippet to handle scenarios such as enabling/disabling SSL based on the environment (disabling SSL in dev mode, handling entity formats in .ts for ts-node, etc.).

If generating ormconfig.json is a necessity, you can achieve that by creating the file through a script using the preceding code and including a writing operation:

...
const json = JSON.stringify(typeOrmOptions, null, 2);
fs.writeFile("./target/ormconfig.json", json, (err) => {
    if (err) {
        console.error(err);
        return;
    }
    console.log("File has been created");
});

What is the correct method for setting the DATABASE_URL in ormconfig.json?

Answer №1

Similar questions

The entire space should be filled with the background

Customizing the toString Method in a TypeScript Class for JavaScript Objects

Problems with importing modules in Apollo Server

Collision Detection in Kendo UI Menu

What causes an Object to potentially be null even after Array.isArray(obj) check has been performed?

Tips for adding an autocomplete feature to your Angular application with Bootstrap 4, all without the need for JQuery

Updated the application to Angular 6 but encountered errors when attempting to run npm run build --prod. However, running the command npm run build --env=prod was executed without any issues

Avoiding the pitfalls of hierarchical dependency injection in Angular 6

Elevate the Appearance of Material UI Elements with custom CSS Sty

The value of 'number' can be assigned to the constraint 'T[keyof T]', however, there is a possibility that 'T[keyof T]' may be initialized with a different subtype of the constraint 'number'

Mastering TypeScript debugging in Visual Studio Code with automatic restart

The unit test is not passing due to inconsistencies between the mock data generated in the constructors and the original mock data

Eliminate repeat entries in MongoDB database

Exploring the world of chained JavaScript Promises for automatic pagination of an API

Having trouble getting the generated component from Ionic v4 CLI to function properly

update the data source of the material table inside the subscription

What is the best approach for associating interfaces with nested objects to ensure proper configuration validation?

Set up a TypeScript project with essential dependencies for creating multiple raw JavaScript output files

Generating data types based on the output of functions

The function cannot be called on a type that does not have a callable signature. The specified type, 'number | Dispatch<SetStateAction<number>>', does not have any compatible call signatures