데이터베이스

Sumor Cloud의 도구입니다.
자세한 문서
MySQL 등을 위한 데이터베이스 커넥터. 엔티티 기반.

설치

npm i @sumor/database --save

전제 조건

Node.JS 버전

Node.JS 버전 16.x 이상이 필요합니다.

Node.JS ES 모듈 필요

이 패키지는 ES 모듈로 작성되었으므로, package.json 파일에서 다음 코드를 변경해주시기 바랍니다:

{
  "type": "module"
}

사용 방법

일반 사용법

import database from '@sumor/database'

const config = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'database',
  port: 3306
}

await database.install(config, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      }
    }
  },
  view: {}
})

// 연결 풀을 이용한 클라이언트 얻기
const client = await database.client(config)

// 연결 얻기
const db = await client.connect()

// 작업 사용자 설정
db.setUser('tester')

// 레코드 생성
const car1Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X5'
})
const car2Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X6'
})

// 레코드 조회
const car = await db.single('Car', { id: carId })
// car = {id: car1Id, brand: 'BMW', model: 'X5'}

// 레코드 쿼리
const cars = await db.query('Car', {
  brand: 'BMW'
})
// cars = [{id: car1Id, brand: 'BMW', model: 'X5'}, {id: car2Id, brand: 'BMW', model: 'X6'}]

// 레코드 수 세기
const count = await db.count('Car', {
  brand: 'BMW'
})
// count = 2

// 레코드 업데이트
await db.update(
  'Car',
  { id: car1Id },
  {
    brand: 'BMW',
    model: 'X5M'
  }
)

// 레코드 보증
await db.ensure('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// 만약 이미 'BMW' 브랜드가 존재한다면 레코드 삽입 X

// 레코드 수정
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// 이미 'BMW' 브랜드가 존재한다면 레코드 모델 업데이트

// 레코드 삭제
await db.delete('Car', { id: car1Id })

// 연결 닫기
await db.commit()

// 롤백
await db.rollback()

// 연결 닫기
await db.release()

// 서버 종료 시 클라이언트 소멸
await client.destroy()

쿼리 옵션

// 옵션을 사용하여 레코드 쿼리
const cars = await db.select(
  'Car',
  {
    brand: 'BMW'
  },
  {
    term: 'X5',
    termRange: ['model'],
    top: 10,
    skip: 0
  }
)

엔티티 정의 옵션

Index

테이블에 인덱스를 만들기 위해 엔티티 정의에 인덱스 배열을 추가할 수 있으며, 기본적으로 id 필드에 인덱스를 생성합니다.

Join

테이블에서 조인을 만들기 위해 엔티티 정의에 조인 객체를 추가할 수 있습니다.
아래 예제처럼, Car 엔티티에 userId 필드를 생성합니다.

import database from '@sumor/database'

const config = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'database',
  port: 3306
}

await database.install(config, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      },
      index: ['userId'],
      join: {
        user: 'User'
      }
    }
  },
  view: {}
})