데이터베이스

Sumor Cloud Tool.
추가 문서
MySQL 등을 위한 데이터베이스 커넥터. Entity를 기반으로 합니다.

설치

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: {
      properties: {
        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'가 이미 존재한다면 레코드를 삽입하지 않습니다.

// 레코드 수정
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
  }
)

Entity 정의 옵션

Index

테이블에 인덱스를 생성하려면 entity 정의에 index 배열을 추가할 수 있습니다. 기본적으로 id 필드에 인덱스가 생성됩니다.

Join

테이블에 조인을 생성하려면 entity 정의에 join 객체를 추가할 수 있습니다.
다음 예제와 같이, Car entity에 userId 필드가 생성될 것입니다.

import database from '@sumor/database'

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

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