How to use ConfigService in Nestjs DatabaseModule

In NestJS applications, when integrating TypeORM and ConfigService for database configuration management, we typically follow these steps:

1. Install necessary dependencies: First, ensure that @nestjs/config and @nestjs/typeorm modules, along with the appropriate database drivers, are installed.
2. Configure ConfigModule and ConfigService: Within the AppModule of the NestJS application, import ConfigModule and configure it using .forRoot or .forRootAsync to enable ConfigService to read .env files or other configuration sources.
3. Asynchronously load database configuration: Utilize TypeOrmModule.forRootAsync and inject ConfigService to load database configuration asynchronously. This ensures ConfigService is ready and available when configuring TypeOrmModule.

Here is a specific code example:

First, ensure ConfigModule and ConfigService are imported in the root module:

typescript
import { Module } from '@nestjs/common';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { TypeOrmModule } from '@nestjs/typeorm';

@Module({
  imports: [
    ConfigModule.forRoot({
      // Set to true to load `.env` files
      isGlobal: true, 
    }),
    TypeOrmModule.forRootAsync({
      imports: [ConfigModule], // Import ConfigModule to make ConfigService available
      inject: [ConfigService], // Inject ConfigService
      useFactory: (configService: ConfigService) => ({
        type: 'postgres', // Or any other database type
        host: configService.get('DATABASE_HOST'),
        port: configService.get('DATABASE_PORT'),
        username: configService.get('DATABASE_USERNAME'),
        password: configService.get('DATABASE_PASSWORD'),
        database: configService.get('DATABASE_NAME'),
        entities: [__dirname + '/../**/*.entity{.ts,.js}'],
        synchronize: configService.get('DATABASE_SYNCHRONIZE') === 'true', // Note: environment variables are typically strings
      }),
    }),
  ],
})
export class AppModule {}

In the above code, we use ConfigService's .get method to retrieve environment variables defined in the .env file. These variables include database connection configurations such as host, port, username, password, database name, and whether to synchronize the database schema.

By implementing this approach, we can integrate NestJS's configuration service with TypeORM to manage database connections and configuration flexibly, avoiding hardcoding in the application. This enhances adaptability across different environments, including development, testing, and production.