TypeORMでPostgreSQLのコネクションプールサイズを指定する

TypeORMでPostgreSQLのコネクションプールのサイズを指定するには、ConnectionOptionsのextraプロパティ¹(any型)にpoolSizeもしくはmaxを指定する:

  const connection = await createConnection({
    type: 'postgres',
    host: 'db',
    username: 'root',
    password: 'root',
    database: 'test',
    extra: {
      poolSize: 10, // connection pool size
    },
  })

この方法でPostgreSQLのプールサイズを指定できるのは、TypeOrmのPostgresDriver.tsの86行目あたりでextraを[Pool]クラスのパラメータとして渡すようになっているためである:

/**
 * Organizes communication with PostgreSQL DBMS.
 */
export class PostgresDriver implements Driver {
    // ...

    /**
     * Creates a new connection pool for a given database credentials.
     */
    protected async createPool(options: PostgresConnectionOptions, credentials: PostgresConnectionCredentialsOptions): Promise<any> {
        // ...

        // build connection options for the driver
        const connectionOptions = Object.assign({}, {
            host: credentials.host,
            user: credentials.username,
            password: credentials.password,
            database: credentials.database,
            port: credentials.port,
            ssl: credentials.ssl
        }, options.extra || {}); // Poolクラスに渡すオプションとしてextraを使っている

        // create a connection pool
        const pool = new this.postgres.Pool(connectionOptions);

        // ...
    }

    // ...
}

ここのthis.postgresはpgモジュールのことだが、pgモジュールは内部でpg-poolモジュールに依存しており、上コードのPoolはpg-poolモジュールのPoolクラスになる。

Poolクラスのコンストラクタは次のような実装になっており、maxもしくはpoolSizeの指定がなければ10がコネクション数のデフォルト値になるようになっている:

class Pool extends EventEmitter {
  constructor (options, Client) {
    super()
    this.options = Object.assign({}, options)
    this.options.max = this.options.max || this.options.poolSize || 10
    // ...

参考

• How to set poolSize for postgres driver? · Issue #3388 · typeorm/typeorm

1. extraプロパティの定義は、[ConnectionOptions]→[PostgresConnectionOptions]→[BaseConnectionOptions]の順で追うと見つかる。
   [ConnectionOptions]: https://github.com/typeorm/typeorm/blob/0.2.18/src/connection/ConnectionOptions.ts#L21
   [PostgresConnectionOptions]: https://github.com/typeorm/typeorm/blob/0.2.18/src/driver/postgres/PostgresConnectionOptions.ts#L7
   [BaseConnectionOptions]: https://github.com/typeorm/typeorm/blob/0.2.18/src/connection/BaseConnectionOptions.ts#L104 ↩