データベース

Sumor Cloud ツール。
より詳しいドキュメント
MySQLなどのデータベースコネクタ。エンティティをベースにしています。

インストール

npm i @sumor/database --save

前提条件

Node.JS バージョン

Node.JS バージョン 18.x 以上が必要です。

Node.JS の ES モジュールを要求

このパッケージは ES モジュールで書かれているため、package.json ファイル内の次のコードを変更してください:

{
  "type": "module"
}

使用方法

データベースのインストール

データベースにエンティティとビューをインストールするための install メソッドを使用できます。

database.install(config, [リソースパス], [リソースデータ])

ケース1: リソースパスからエンティティとビューをインストールする場合、データ/エンティティとデータ/ビューをプロジェクトのルートパスから読み込みます。

import database from '@sumor/database'

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

await database.install(config.database, process.cwd() + '/data')

ケース2: リソースデータからエンティティとビューをインストールする場合、データ/エンティティとデータ/ビューをデータオブジェクトから読み込みます。

import database from '@sumor/database'

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

一般的な使用方法

import database from '@sumor/database'

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

// コネクションプールを持つクライアントを取得
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: {}
})