[ Working with Connection ]

🐢 What is connection

• 앱과 데이터베이스와의 상호작용은 connection을 설정한 후에만 사용가능하다.
• typeORM의 connection은 connection pool을 생성하여 사용.
• query runner는 별도의 connection을 생성하여 데이터베이스에 접근한다.
• connection pool 생성은 설정(DB접속에 관한 설정)이 완료되면 자동 호출된다.
• createConnection함수 사용시 자동으로, 설정한 connection을 사용한다.
• disconnection에 해당하는 메소드 호출 시 connection 소멸한다.
• connection의 소멸은 반드시 데이터베이스와의 연동 작업이 종료 된 이후여야 한다. 하지만 실제 웹서비스는 백엔드 서버가 항상 실행중이므로 connection이 항상 구동되는 형태여야한다.

---

🦕 Createing a new Connection

TypeORM과 DB 연결에는 몇가지 방법이 있다.
가장 간단한 방법은 createConnection / createConnections 의 사용이다.

1️⃣ createConnection : 단일 connection 생성

import {createConnection, Connection} from "typeorm";

const connection = await createConnection({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "test",
    password: "test",
    database: "test"
});

❗️ 단일 url속성과 DB 타입으로 연결 가능

createConnection({
    type: 'mysql',
    url: 'mysql://root:1234@localhost/HongDB'
})

2️⃣ createConnections : 여러개의 connection생성
❗️ 여러 데이터 베이스에 접근하기 위함이다.

import {createConnections, Connection} from "typeorm";

const connections = await createConnections([{
    name: "default",
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "test",
    password: "test",
    database: "test"
}, {
    name: "test2-connection",
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "test",
    password: "test",
    database: "test2"
}]);

3️⃣ 위와 같은 방식은 사용자가 직접 DB연결 정보를 정의하고 createConnection()메소드를 사용하여 DB와 연동하는 방식이다.
프로젝트 루트에 ormconfig.json 파일에 위와같은 정보를 작성하면 자동으로 DB와의 연동이 실행된다.

// ormconfig.json
import {createConnection, createConnections, Connection} from "typeorm";

- const connection: Connection = await createConnection();

- const secondConnection: Connection = await createConnection("test2-connection");

- const connections: Connection[] = await createConnections();

• connection을 생성 후 getconnection 기능을 활용하여 어디서든 연결을 얻을 수 있다.

// main.js
import {getConnection} from "typeorm";

const connection = getConnection();

const secondConnection = getConnection("test2-connection");

---

🦑 Using ConnectionManager

DB와의 연결이 되는 시점을 제어하고 싶은 경우가 아니면 따로 연결에 관한 클래스나 인스턴스를 만들지 않는다.
이 기능은 이미 typeorm에 내장되어 있기 때문에 리소스 낭비이다.
하지만 만약 사용시 아래와 같이 사용한다.
이 방법 사용시 getConnection() 사용불가.
클래스 생성후 connectionManager.get 이렇게 사용해야댐

// ex) connectionManager.js

import {getConnectionManager, ConnectionManager, Connection} from "typeorm";

const connectionManager = getConnectionManager();
const connection = connectionManager.create({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "root",
    password: "1234",
    database: "HongDB",
});
await connection.connect(); // performs connection

---

🦥 Working with Connection

Connection을 사용한다는 것은 데이터베이스에 접근하여 데이터들을 조작(CRUD)하는 행위를 말한다.
Typeorm은 생성한 Connection정보를 이용하여 데이터베이스에 접근, 보통 아래와 같은 메소드들을 활용하여 데이터베이스내의 데이터를 조작한다.

1️⃣ getManager()메소드(= Entity Manager()메소드)
getManager(Entity Manager)를 통해 Entity를 제어(CRUD)할 수 있다.

import {getManager, getRepository} from "typeorm";
import {User} from "../entity/User";

export class UserController {

    @Get("/users")
    getAll() {
        return getManager().find(User);
    }
}

또는

import {getManager} from "typeorm";
import {User} from "./entity/User";

const entityManager = getManager(); // getManager()를 entityManager로 취급
const user = await entityManager.findOne(User, 1); // 변수 user에 id값1인 행의 정보 입력
user.name = "Umed"; // 정보 변경
await entityManager.save(user); // 변경된 정보를 저장

2️⃣ getRepository()메소드
getManager()메소드와 유사하지만 특정 Entity를 한정하여 작업을 제한한다.

import {getManager, getRepository} from "typeorm";
import {User} from "../entity/User";

export class UserController {

    @Get("/users/:id")
    getAll(@Param("id") userId: number) {
        return getRepository(User).findOne(userId);
    }

}

또는

import {getRepository} from "typeorm";
import {User} from "./entity/User";

const userRepository = getRepository(User); // 작업할 특정 Entity 지정
const user = await userRepository.findOne(1); // 변수user에 id값1인 행의 정보 저장
user.name = "Umed"; // 정보 변경
await userRepository.save(user); // 변경된 정보 저장

❗️ getManager()메소드와 getRepository()메소드의 차이점
getManager()메소드는 모든 Entity를 처리할 수 있다.
반면, getRepository()메소드는 단일 Entity만을 지정하여 처리한다.

// getManager()메소드
const manager = getManager();
const user = manager.create(User);

// getRepository()메소드
const repository = connection.getRepository(User);
const user = repository.create();

또 다른 예시를 살펴보자

// getManager()메소드
const manager = getManager();
manager.find(User);

// getRepository()메소드
getRepository(User).find();

3️⃣ getConnection()메소드
데이터베이스와의 연결을 설정하면, getConnection메소드를 사용하여 앱 어디서든 사용할 수 있다.
해당 연결을 통해 데이터베이스의 데이터들을 제어(CRUD)한다.

// user.js
import {getConnection} from "typeorm";
import {User} from "../entity/User";

export class UserController {

    @Get("/users")
    getAll() {
        return getConnection().manager.find(User);
    }

}

getConnection()메소드를 사용하여 Entity를 관리하기 위해(데이터를 조작)아래와 같은 방식을 요구한다.

• Find Options: getRepository()와 EntityManager()는 query builder를 사용하지 않고, 필요한 데이터를 쿼리하는데 사용할 수 있는 기본적인 find기능이 제공된다.
• query builder: 해당 기능은 sql문을 대체하여 entity를 제어할 수 있도록 한다.

const firstUser = await connection
    .getRepository(User)
    .createQueryBuilder("user")
    .where("user.id = :id", { id: 1 })
    .getOne();

---

[ Using ormconfig.json ]

🐣 Creating a new connection from the configuration file

• 대부분의 경우 DB 연결 옵션은 관리의 편리로 인해 별도로 파일에 저장한다.
• typeorm은 여러가지 DB연결 설정 소스를 제공한다.
• ormconfig.json파일을 작성하여 package.json 파일과 동일한 곳에 위치시키면 별도의 '파일을 읽어오는 설정'같은 구성을 요구하지 않고 createConnection을 통해 DB와의 Connection을 실행한다.
• ormconfig.json과 같이 유설정 정보를 저장하는 파일은 다양한 파일 형식을 지원한다.
• ormconfig파일에 포함될 Database연결 옵션 정보는 아래를 참고하자
  <공식홉페이지: ormconfig에 포함될 옵션값들 참고>
  .json, .js, .ts, .env, .yml .xml.

import {createConnection} from "typeorm";

const connection = await createConnection();

🦆 Using ormconfig.json

• 데이터베이스 연결 정보를 json형식으로 생성할 경우 아래와같이 작성한다.
• 해당 파일은 반드시 프로젝트 내의 package.json과 동일한 위치를 요구한다.
• 아래 예시에서 추가로 다른 옵션들을 지정할 수 있다.

1️⃣ 기본 작성법 (단일 connection)

{
   "type": "mysql",
   "host": "localhost",
   "port": 3306,
   "username": "test",
   "password": "test",
   "database": "test"
}

2️⃣ 기본 작성법 (다중 connections)

[{
   "name": "default",
   "type": "mysql",
   "host": "localhost",
   "port": 3306,
   "username": "test",
   "password": "test",
   "database": "test"
}, {
   "name": "second-connection",
   "type": "mysql",
   "host": "localhost",
   "port": 3306,
   "username": "test",
   "password": "test",
   "database": "test"
}]

🐩 Using ormconfig.js

• 데이터베이스 연결 정보를 js형식으로 생성할 경우 아래와같이 작성한다.
• 해당 파일은 반드시 프로젝트 내의 package.json과 동일한 위치를 요구한다.
• 아래 예시에서 추가로 다른 옵션들을 지정할 수 있다.

module.exports = {
   "type": "mysql",
   "host": "localhost",
   "port": 3306,
   "username": "test",
   "password": "test",
   "database": "test"
}

지원 환경이 갖춰질 경우 아래와 같이 ECMAScript module형식을 사용할 수 있다.

export default {
   "type": "mysql",
   "host": "localhost",
   "port": 3306,
   "username": "test",
   "password": "test",
   "database": "test"
}

🪂 Using environment variables

• 데이터베이스 연결 정보를 ormconfig.env방식으로 생성할 경우 아래와같이 작성한다.
• 해당 파일은 반드시 프로젝트 내의 package.json과 동일한 위치를 요구한다.

TYPEORM_CONNECTION = mysql
TYPEORM_HOST = localhost
TYPEORM_USERNAME = root
TYPEORM_PASSWORD = admin
TYPEORM_DATABASE = test
TYPEORM_PORT = 3000
TYPEORM_SYNCHRONIZE = true
TYPEORM_LOGGING = true
TYPEORM_ENTITIES = entity/*.js,modules/**/entity/*.js

사용가능한 Typeorm의 환경변수 목록은 아래와 같다.

TYPEORM_CACHE
TYPEORM_CACHE_ALWAYS_ENABLED
TYPEORM_CACHE_DURATION
TYPEORM_CACHE_OPTIONS
TYPEORM_CONNECTION
TYPEORM_DATABASE
TYPEORM_DEBUG
TYPEORM_DRIVER_EXTRA
TYPEORM_DROP_SCHEMA
TYPEORM_ENTITIES
TYPEORM_ENTITIES_DIR
TYPEORM_ENTITY_PREFIX
TYPEORM_HOST
TYPEORM_LOGGER
TYPEORM_LOGGING
TYPEORM_MAX_QUERY_EXECUTION_TIME
TYPEORM_MIGRATIONS
TYPEORM_MIGRATIONS_DIR
TYPEORM_MIGRATIONS_RUN
TYPEORM_MIGRATIONS_TABLE_NAME
TYPEORM_PASSWORD
TYPEORM_PORT
TYPEORM_SCHEMA
TYPEORM_SID
TYPEORM_SUBSCRIBERS
TYPEORM_SUBSCRIBERS_DIR
TYPEORM_SYNCHRONIZE
TYPEORM_URL
TYPEORM_USERNAME
TYPEORM_UUID_EXTENSION

🤼 Overriding options defined in ormconfig

로직에 따라 ormconfig파일을 재정의 해야하는 상황이 있을 수 있다.
상황에 맞추어 DB연결 설정 정보를 변경하여 적용할 수 있다.

const connectionOptions = await getConnectionOptions();

Object.assign(connectionOptions, { namingStrategy: new MyNamingStrategy() });

const connection = await createConnection(connectionOptions);

[Connection APIs]

connection에 관련된 즉, 데이터베이스에 접근하는 행위에 관련된 Typeorm에서 제공하는 API들에 대하여 알아보자.

• 기본적으로 DB연결을 구현하는 API
• DB에 접근하여 데이터를 제어하는 API
  등등이 제공된다.

🎹 Main APIs

🉑 createConnection()

• connection을 생성한다.
• 연결 옵션 매개 변수가 생략된 경우 ormconfig파일 또는 env에서 연결 옵션을 읽어온다.

import {createConnection} from "typeorm";

const connection = await createConnection({
    type: "mysql",
    host: "localhost",
    port: 3306,
    username: "test",
    password: "test",
    database: "test"
});

🉑 getConnection()

• createConnection()메소드를 사용하여 생성한 connection객체를 가져온다.

import {getConnection} from "typeorm";

const connection = getConnection();

🉑 getRepository()
Connection객체를 통해 연결된 데이터베이스에서 특정 Entity를 가져와 제어할 수 있다.

import {getRepository} from "typeorm";

const userRepository = getRepository(User);

const blogRepository = getRepository(Blog, "secondary-connection"); // 어떤 Connection(데이터베이스)에서 가져올지 지정할 수 있다. 

Connection APIs

🉑