How to use and export datasource correctly in typeorm

When using TypeORM for database operations, the correct initialization and export of the data source (DataSource) is a critical step, as it determines how the entire application interacts with the database. I will provide a detailed explanation of how to correctly use and export the data source in TypeORM.

Step 1: Install TypeORM and Database Drivers

First, ensure that typeorm and the corresponding database driver (e.g., pg for PostgreSQL, mysql for MySQL) are installed.

bash
npm install typeorm pg

Step 2: Create Data Source Configuration

Create an instance of DataSource in your project, typically in a separate file such as data-source.ts. Here, you should specify configuration information such as the database type, host address, port, username, password, and database name.

typescript
import { DataSource } from 'typeorm';

export const AppDataSource = new DataSource({
    type: "postgres", // Database type
    host: "localhost", // Database host
    port: 5432, // Database port
    username: "user", // Database username
    password: "password", // Database password
    database: "test", // Database name
    entities: [
        // List all entities here
    ],
    synchronize: true, // Automatically create or update table structure based on entities
    logging: false
});

Step 3: Initialize and Connect to the Database

Initialize and connect to the database at the application entry point (e.g., index.ts or app.ts). Use the AppDataSource.initialize() function to initialize the data source.

typescript
import { AppDataSource } from './data-source';

AppDataSource.initialize()
    .then(() => {
        console.log("Data source successfully initialized");
        // You can start the rest of the application here, such as setting up server listening
    })
    .catch((error) => {
        console.error("Data source initialization failed:", error);
    });

Step 4: Use the Data Source in Other Modules

Once the data source is successfully initialized, you can import AppDataSource wherever database operations are needed and use it to manage entities or execute queries.

typescript
import { AppDataSource } from './data-source';
import { User } from './entity/User';

async function getUsers() {
    const userRepository = AppDataSource.getRepository(User);
    return await userRepository.find();
}

Example

Assume we have a user entity User, and we need to implement a function to add a user to the database.

First, define the user entity:

typescript
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';

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

    @Column()
    name: string;
}

Then, implement the function to add a user:

typescript
async function addUser(userName: string) {
    const user = new User();
    user.name = userName;
    const userRepository = AppDataSource.getRepository(User);
    return await userRepository.save(user);
}

This example demonstrates how to define entities in TypeORM, initialize the data source, and use it within the application to add data to the database.

Summary

The correct approach to using and exporting the data source in TypeORM is to create a separate data source configuration file and use this data source for all database-related operations. This method not only enhances code maintainability but also ensures the correctness and efficiency of database operations.