typeorm-logger-adaptor
======================


Logger adaptors for TypeORM.

Supported loggers
-----------------

* Bunyan (>= 1.8.5)
* Winston (>= 3.0.0)

Install
-------

``bash


NPM

npm install typeorm-logger-adaptor

Yarn

yarn add typeorm-logger-adaptor
`

How to use
----------

1. Install typeorm-logger-adaptor, typeorm and a logger library you want to use.
2. import { XxxAdaptor } from 'typeorm-logger-adaptor/logger/xxx';.
* Replace xxx with logger library name (e.g. winston, bunyan).
3. Create and configure a logger instance.
4. Create an adaptor instance and configure TypeORM connection.
* See here for details.

Example
-------

`typescript
import {DataSource} from 'typeorm';
import * as winston from 'winston';
import {WinstonAdaptor} from 'typeorm-logger-adaptor/logger/winston';

async function example(): Promise {
// Configure logger (Winston)
const logger = winston.createLogger({
level: 'debug',
format: winston.format.cli(),
transports: [new winston.transports.Console()],
});

// Create and initialize DataSource
const dataSource = await new DataSource({
type: 'mysql',
host: 'database-host',
port: 3306,
username: 'conn_user',
password: 'conn_user_pw',
database: 'database_name',
// Use logger adaptor like this
logger: new WinstonAdaptor(logger, 'all', true),
}).initialize();

try {
await dataSource.synchronize();
await dataSource.runMigrations();
await dataSource.query('SELECT count(1) FROM user WHERE name = ?', ['Taro']);
await dataSource.query('SELECT ___column_that_does_not_exist___ FROM ___table_that_does_not_exist___');
} finally {
await dataSource.destroy();
}
}
``

License
-------

MIT License.

Copyright (c) 2020 KOMIYA Atsushi.