Node.js開発者必見！SequelizeでMariaDB接続をマスターするステップバイステップガイド

2024-05-26

Node.js で Sequelize を使って MariaDB に接続する方法

このチュートリアルでは、Node.js、Sequelize、MariaDB を使ってデータベースに接続する方法を説明します。

Sequelize とは？

Sequelize は、Node.js 向けの オブジェクト関係マッピング (ORM) ライブラリです。 ORM は、データベースとのやり取りをより簡単にするために、データベースをオブジェクトとして表現するツールです。 Sequelize を使用すると、SQL クエリを記述する代わりに、JavaScript オブジェクトを使用してデータベースとやり取りできます。

MariaDB は、MySQL のオープンソース互換代替品です。 MySQL とほぼ互換性があるため、既存の MySQL アプリケーションを MariaDB に移行するのは比較的簡単です。

前提条件

このチュートリアルを開始する前に、以下のものが必要です。

Node.js がインストールされていること
MariaDB がインストールおよび実行されていること
基本的な JavaScript の知識

手順

必要なパッケージをインストールする

npm install sequelize mysql2

データベース接続を設定する

以下のコード例のように、config.js ファイルを作成してデータベース接続設定を保存します。

const Sequelize = require('sequelize');

module.exports = {
  development: {
    username: 'your_username',
    password: 'your_password',
    database: 'your_database',
    host: 'localhost',
    dialect: 'mysql',
  },
};

上記のコード例では、your_username、your_password、your_database を実際の値に置き換える必要があります。

Sequelize インスタンスを作成する

以下のコード例のように、app.js ファイルを作成して Sequelize インスタンスを作成します。

const Sequelize = require('sequelize');
const config = require('./config');

const sequelize = new Sequelize(config.development);

(async () => {
  try {
    await sequelize.authenticate();
    console.log('Connection to MariaDB established successfully.');
  } catch (error) {
    console.error('Unable to connect to MariaDB:', error);
  }
})();

このコードは、config.js ファイルから設定を読み込み、Sequelize インスタンスを作成します。そして、authenticate() メソッドを使用してデータベースに接続し、接続が成功したかどうかを確認します。

モデルを定義する

Sequelize を使用して、データベース内のテーブルを表すモデルを定義できます。以下のコード例は、User テーブルを表すモデルの定義方法を示しています。

const Sequelize = require('sequelize');

const User = sequelize.define('user', {
  id: {
    type: Sequelize.INTEGER,
    primaryKey: true,
    autoIncrement: true,
  },
  name: {
    type: Sequelize.STRING,
    allowNull: false,
  },
  email: {
    type: Sequelize.STRING,
    unique: true,
  },
});

module.exports = User;

このコードは、User モデルを定義し、id、name、email という 3 つの属性を持つことを指定します。

モデルとやり取りする

モデルを定義したら、データベースとのやり取りに使用できます。以下のコード例は、User モデルを使用して新しいユーザーを作成する方法を示しています。

const User = require('./models/user');

(async () => {
  try {
    const user = await User.create({
      name: 'John Doe',
      email: '[email protected]',
    });
    console.log('User created:', user.toJSON());
  } catch (error) {
    console.error('Unable to create user:', error);
  }
})();

このコードは、User モデルを使用して新しいユーザーを作成し、そのユーザー情報をコンソールに出力します。

このチュートリアルでは、Node.js、Sequelize、MariaDB を使ってデータベースに接続する方法を説明しました。 Sequelize を使用すると、データベースとのやり取りをより簡単にすることができます。

Node.js で Sequelize を使って MariaDB に接続するサンプルコード

npm install sequelize mysql2

const Sequelize = require('sequelize');

module.exports = {
  development: {
    username: 'your_username',
    password: 'your_password',
    database: 'your_database',
    host: 'localhost',
    dialect: 'mysql',
  },
};

const Sequelize = require('sequelize');
const config = require('./config');

const sequelize = new Sequelize(config.development);

(async () => {
  try {
    await sequelize.authenticate();
    console.log('Connection to MariaDB established successfully.');
  } catch (error) {
    console.error('Unable to connect to MariaDB:', error);
  }
})();

const Sequelize = require('sequelize');

const User = sequelize.define('user', {
  id: {
    type: Sequelize.INTEGER,
    primaryKey: true,
    autoIncrement: true,
  },
  name: {
    type: Sequelize.STRING,
    allowNull: false,
  },
  email: {
    type: Sequelize.STRING,
    unique: true,
  },
});

module.exports = User;

const User = require('./models/user');

(async () => {
  try {
    const user = await User.create({
      name: 'John Doe',
      email: '[email protected]',
    });
    console.log('User created:', user.toJSON());
  } catch (error) {
    console.error('Unable to create user:', error);
  }
})();

その他の操作

Sequelize を使用して、データベースに対して様々な操作を実行できます。以下に、一般的な操作の例を示します。

データの読み取り
データの作成
関連データの取得

Sequelize の詳細については、Sequelize ドキュメントを参照してください。

このサンプルコードを拡張する方法

このサンプルコードは、Node.js、Sequelize、MariaDB を使ってデータベースに接続する方法を示す基本的な例です。以下のように、このサンプルコードを拡張することができます。

モデル間の関連関係を定義する
データベースのクエリをより複雑にする
トランザクションを使用してデータの一貫性を保つ
エラー処理を改善する

Sequelize 以外の MariaDB 接続方法

mysql モジュールは、Node.js の公式モジュールの一つで、MySQL と MariaDB への接続を可能にします。 Sequelize よりも軽量でシンプルなライブラリですが、ORM 機能は備わっていません。

以下のコード例は、mysql モジュールを使用して MariaDB に接続する方法を示しています。

const mysql = require('mysql');

const connection = mysql.createConnection({
  host: 'localhost',
  user: 'your_username',
  password: 'your_password',
  database: 'your_database',
});

connection.connect(error => {
  if (error) {
    console.error('Unable to connect to MariaDB:', error);
  } else {
    console.log('Connection to MariaDB established successfully.');
  }
});

このコードは、MariaDB への接続を確立し、接続が成功したかどうかを確認します。接続が確立されたら、connection オブジェクトを使用してデータベースに対してクエリを実行できます。

Knex.js は、JavaScript で SQL クエリを構築するためのライブラリです。 Sequelize のように ORM 機能を備えていますが、より柔軟で強力なクエリを作成することができます。

const knex = require('knex')({
  client: 'mysql',
  connection: {
    host: 'localhost',
    user: 'your_username',
    password: 'your_password',
    database: 'your_database',
  },
});

knex('users').select('*').then(data => {
  console.log(data);
});

このコードは、MariaDB に接続し、users テーブルからすべてのデータを取得します。

MikroORM は、もう一つの人気のある Node.js ORM です。 Sequelize と同様に、データモデルを定義して、データベースとのやり取りを簡素化することができます。

const { Entity, PrimaryKey, Property } = require('@mikroorm/core');
const { MariaDBDriver } = require('@mikroorm/mariadb');

const orm = new MikroORM({
  type: MariaDBDriver,
  dbName: 'your_database',
  user: 'your_username',
  password: 'your_password',
});

class User extends Entity {
  @PrimaryKey()
  id: number;

  @Property()
  name: string;

  @Property()
  email: string;
}

orm.em.findOne(User, 1).then(user => {
  if (user) {
    console.log(user);
  } else {
    console.log('User not found.');
  }
});