導入 PostgreSQL(Postgresとして短縮)は、ソフトウェアアプリケーションの構築で最も多く使用されるデータベースの1つです Postgresは、一般的な目的、オープンソース、オブジェクト関係データベース管理システム(RDBMS)です。 データベースをWebアプリケーションに接続する方法の1つは、ORM(Object Relational Mapper)を使用することです。ORMはアプリケーションとデータベースの間のコミュニケーションの層として機能します。このチュートリアルの目的は、Sequelize ORMを通じてExpressアプリケーションでPostgresを使用する方法を説明することです。 Sequelize ORMは以下のように記述されています。 
 
 Oracle、Postgres、MySQL、MariaDB、SQLite、およびSQL Serverなどのための最新のTypeScriptとNode.js ORM。 Oracle、Postgres、MySQL、MariaDB、SQLite、およびSQL Serverなどのための最新のTypeScriptとNode.js ORM。 簡単なタスク管理APIを構築します。APIは、タスクを作成、リストし、完了状態を更新し、タスクを削除することができます。 このチュートリアルは、Sequelizeを使用してExpressでリレーショナルデータベースの使用に焦点を当てたチュートリアルシリーズの最初のものです。 前提条件 このチュートリアルを続けるには、以下のことが必要になります。 
 
 
 
 
 
 テキストエディター(VS Code) エンドポイントをテストするためのAPIクライアント(例えば、Postman) Node.js がパソコンにインストールされています。 EXPRESSの基本知識 Postgres がローカルまたはリモートで実行されているインスタンス プロジェクト設定 私たちは、Expressアプリケーションを作成するための適切なファイルとディレクトリを設定し、必要なパッケージをインストールすることから始めます。 
 
 
 
 
 
 
 
 
 
 
 
 
 
 Create the project directory:     mkdir tasks-manager-api
 
 
 
 Navigate to the project directory:     cd tasks-manager-api
 
 
 
 Initialize the NPM package by running the following command to create a    file with default settings: package.json     npm init -y
 
 
 
 Install Express and other core dependencies:    npm install express express-async-errors dotenv && npm install nodemon --save-dev
 
 
 
 Install Postgres driver for Node.js:    npm install pg
 
 
 
 Install Sequelize:    npm install sequelize
 
 
 
 In the root directory, create the   and  folders: models utils  mkdir models utils
 
 
 
 In the root directory, create a   file, which will contain the server’s port number and the database URL of any Postgres instance: .env PORT=5000
DATABASE_URL=postgres://<user>:<password>@<host>:<port>/<database>
 
 
 
 In the root directory, create the   file, which is the application entry point: index.js    touch index.js
 
 
 
 Set up the command to run the local development server by editing the   object in  : scripts package.json {
    //…
    "scripts": {
        "test": "echo \"Error: no test specified\" && exit 1",
        "dev": "nodemon index.js",
        "start": "node index.js"
    },
    //…
}
 プロジェクトフォルダの構造は、以下のようになります。 Sequelizeの設定 で2つのファイルを作成する ディレクター: そして utils config.js db.js. 充電環境変数 IN THE ファイル、環境変数をロードする 使用するファイル パッケージ、その後輸出 そして アプリケーションの他の部分でアクセスできるように変数を設定します。 config.js .env dotenv PORT DATABASE_URL THE ファイルには以下のコンテンツが必要です。 config.js require('dotenv').config()

const PORT = process.env.PORT || 3000
const DATABASE_URL = process.env.DATABASE_URL

module.exports = {
    PORT,
    DATABASE_URL
}
 Sequelize Instanceの作成 IN THE ファイル、Sequelize インスタンスを作成します. You can create a Sequelize instance by passing the database connection URI (stored in ) に Sequelize constructor. 次に、機能を作成します。 データベースへの接続をテストすることで、 最後に、エクスポートします。 機能と Sequelize インスタンス db.js DATABASE_URL connectToDB, authenticate connectToDB THE ファイルには以下のコンテンツが必要です。 utils/db.js const Sequelize = require("sequelize");
const { DATABASE_URL } = require("./config");

const sequelize = new Sequelize(DATABASE_URL)

const connectToDB = async () => {
    try {
        await sequelize.authenticate()
        console.log("Database connection established successfully.")
    } catch (error) {
        console.log("Unable to connect to the database:", error)
        return process.exit(1)
    }
    return null
}

module.exports = {
    connectToDB,
    sequelize
}
 タスクモデルの定義 Sequelize モデルは、データベース内のテーブルの表示です。 モデル: extending the Sequelize クラスと呼び方 機能です。 Task Model Model.init(attributes, options) IN THE ディレクター、Create the 以下のコンテンツを持つファイル: models task.js const {Model, DataTypes} = require("sequelize")
const {sequelize} = require("../utils/db")

class Task extends Model {}

Task.init({
    id: {
        type: DataTypes.INTEGER,
        autoIncrement: true,
        primaryKey: true
    },
    title: {
        type: DataTypes.STRING,
        allowNull: false
    },
    completed: {
        type: DataTypes.BOOLEAN,
        defaultValue: false
    }
}, {
    sequelize,
    modelName: "Task",
    timestamps: true,
    underscored: true,
    defaultScope: {
        attributes: {
            exclude: ["createdAt", "updatedAt"]
        }
    }
})

Task.sync()

module.exports = Task
 THE パラメータは、その構造を定義する。 データベースのテーブル - The モデルは3つの属性を持っています: attributes Task Task 
 
 
 
 id: 各レコードをユニークに識別するために使用される自動増加の主要キーである整数フィールド。 タイトル:タスクの名前を表す文字列フィールド。 completed: The completed field has a boolean value that indicates whether the task has been completed. 完成したフィールドには、タスクが完了したかどうかを示すブール値があります。 THE パラメータは Sequelize がモデルをどのように処理するかを設定します。 モデルには以下のオプションがあります。 options Task 
 
 
 
 
 
 sequelize: Utils/db.js で以前作成した Sequelize インスタンス。 modelName: データベースで作成されたテーブルの名前。 timestamps: true に設定すると、createdAt および updatedAt フィールドをモデルに自動的に追加します。 強調: true に設定すると、データベースの camel Case フィールドを serpent case に変換します。 defaultScope: クエリ時に特定の属性をデフォルトで除外します。 THE 機能は、テーブルが存在しない場合にテーブルを作成することで、モデルをデータベースと同期します。 Task.sync() Express Serverの作成 最後に、Express サーバーを作成することにより、すべてを組み合わせます。 file, you set up the necessary middleware, define the API endpoint routes, and run the express server. 必要なミドルウェアを設定し、APIエンドポイントルートを定義し、エクスプレスサーバを実行します。 index.js THE エクスプレスサーバを初期化する機能です。 function first tests the connection to the database by calling the 機能: 接続が成功した場合は、指定されたポートで聴くExpressサーバを起動します。 start start connectToDB() THE ファイルには以下のコンテンツがあります。 index.js require("express-async-errors");
const express = require("express");
const app = express();
const { PORT } = require("./utils/config");
const { connectToDB } = require("./utils/db");
const Task = require("./models/task");

// middlewares
app.use(express.json());

// routes
app.get("/api/tasks", async (req, res) => {
  const tasks = await Task.findAll();
  res.json({
    message: "List of tasks",
    tasks: tasks,
  });
});

app.post("/api/tasks", async (req, res) => {
  const { title } = req.body;
  const task = await Task.create({ title });
  res.status(201).json({
    message: "Task created successfully",
    task,
  });
});

app.patch("/api/tasks/:id/toggle-completed", async (req, res) => {
  const { id } = req.params;
  const task = await Task.findByPk(id);
  if (!task) {
    return res.status(404).json({ message: "Task not found" });
  }
  task.completed = !task.completed;
  await task.save();
  res.json({
    message: task.completed
      ? "Task marked as completed"
      : "Task marked as not completed",
    task,
  });
});

app.delete("/api/tasks/:id", async (req, res) => {
  const { id } = req.params;
  const task = await Task.findByPk(id);
  if (!task) {
    return res.status(404).json({ message: "Task not found" });
  }
  await task.destroy();
  res.json({
    message: "Task deleted successfully",
  });
});

const start = async () => {
  try {
    await connectToDB();
    app.listen(PORT, console.log(`Server is running on port ${PORT}`));
  } catch (error) {
    console.error(error);
    process.exit(1);
  }
};

start();
 API Endpointのテスト 次に、APIエンドポイントをテストします。 
 
 新しいタスクを作成する—POST /api/tasks: 
 
 すべてのタスクをリスト — GET /api/tasks: 
 
 Toggle completion status—PATCH /api/tasks/:id/toggle-completed: トップページへ 
 
 タスクを削除する — DELETE /api/task: 結論 現在、Express アプリケーションを Sequelize を使用して Postgres データベースに接続する方法を知っています. You built a simple task manager API, and in the process, you configured Sequelize, connected Sequelize to a Postgres instance, defined the モデル、そしてAPIエンドポイントを作成しました。 Task 現在、コントローラの論理は、 今後のチュートリアルでは、コントローラ、ルーター、および Sequelize 移行を使用して、このコードベースをよりスケーラブルな構造に再構築します。 index.js 続きを読むには、あなたは、 モデルクエリ、検証、アソシエーション、その他についてもっと知るには。 Sequel ドキュメンタリー あなたはこのチュートリアルのための完全なソースコードを見つけることができます . GitHub 資源 
 
 
 
 
 Sequelize ドキュメンタリー(V6) PostgreSQLとは何ですか? - AWS Relational Databases with Sequelize - FullStackOpen Express.js ドキュメンタリー

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

Read My Stories

Portfolio

このオーディオは、ストーリーの元の言語で制作されています。

エクスプレスアプリケーションをSequelizeを使用してPostgresに接続する方法

About Author

コメント

ラベル

この記事は

Related Stories

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

海を航海する: データレイクを使用した本番環境レベルの RAG アプリケーションの開発

ワークフローを10倍に向上させる方法: 必須アプリ17選

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

18 種類の開発者ツールで生産性を向上しましょう 🚀🔥

海を航海する: データレイクを使用した本番環境レベルの RAG アプリケーションの開発

ワークフローを10倍に向上させる方法: 必須アプリ17選

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps