データベース

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'
})
// brand が 'BMW' のレコードがすでに存在する場合は挿入されません

// レコードの修正
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// brand が '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
  }
)

エンティティ定義オプション

インデックス

テーブルにインデックスを作成するために、エンティティ定義にインデックス配列を追加することができます。デフォルトでは、id フィールドにインデックスが作成されます。

結合

テーブルに結合を作成するために、エンティティ定義に結合オブジェクトを追加することができます。 以下の例のように、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: {}
})