Въведение PostgreSQL (съкратено като Postgres) е една от най-използваните бази данни в изграждането на софтуерни приложения. Postgres е система за управление на обект-релационни бази данни (RDBMS) с общо предназначение, с отворен код. Едно от предимствата на използването на Postgres е нейната поддръжка както за релационни (SQL), така и за нерелационни (NoSQL) заявки. Един от начините за свързване на база данни към уеб приложение е чрез използването на ORM (Object Relational Mapper). ORM действа като слой на комуникация между вашето приложение и базата данни. Целта на това урок е да се обясни как можете да използвате Postgres в Express приложение чрез Sequelize ORM. Sequelize ORM се описва като: 
 
 Модерен TypeScript и Node.js ORM за Oracle, Postgres, MySQL, MariaDB, SQLite и SQL Server и др. Модерен TypeScript и Node.js ORM за Oracle, Postgres, MySQL, MariaDB, SQLite и SQL Server и др. Разширяване на документацията Ще изградите прост API за управление на задачи. API ще може да създава, списък, актуализиране на състоянието на завършване и изтриване на задачи. Този урок е първият в предстояща поредица от уроци, фокусирани върху използването на релационни бази данни в Express с помощта на Sequelize. Предпоставки За да продължите с този урок, ще ви е необходимо следното: 
 
 
 
 
 
 Редактор на текст (напр. VS код) Клиент на 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 Създаване на два файла в Директорът : и utils config.js db.js. Зареждане на променливи на околната среда В на файл, заредете променливите на околната среда от Файлове, използващи пакета. След това експортирайте и променливи, така че да могат да бъдат достъпни в други части на приложението. config.js .env dotenv PORT DATABASE_URL на Файлът трябва да съдържа следното съдържание: 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 В на файл, създайте Sequelize инстанция. Можете да създадете Sequelize инстанция, като прехвърлите URI на връзката на базата данни (съхранена в ) към Sequelize constructor. След това създавате функция ще тества връзката с базата данни, като се обади на функцията. Накрая, вие експортирате Функция и Sequelize инстанция. db.js DATABASE_URL connectToDB, authenticate connectToDB на Файлът трябва да съдържа следното съдържание: 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 е представяне на таблица в базата данни. Моделът се разширява чрез Sequelize клас и да се обади на на функцията. Task Model Model.init(attributes, options) В на Директор, създаване на Файлове със следното съдържание: 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
 на Параметърът определя структурата на Таблица в базата данни. на Моделът има три атрибута: attributes Task Task 
 
 
 
 id: Поле за цели числа, което е автоматично увеличаващ се първичен ключ, използван за уникално идентифициране на всеки запис. Заглавие: Поле за низ, което представлява името на задачата. Завършено: Завършеното поле има булева стойност, която показва дали задачата е завършена. на параметърът конфигурира как Sequelize се справя с модела. Моделът има следните опции: options Task 
 
 
 
 
 
 Sequelize: Инстанцията Sequelize, създадена по-рано в utils/db.js. modelName: Името на таблицата, създадена в базата данни. Временни отметки: Когато е зададен на True, автоматично добавя полетата createdAt и updatedAt към модела. Подчертано: Когато е зададено на True, конвертира полетата Camel Case в случай на змия в базата данни. defaultScope: Изключва определени атрибути по подразбиране при заявка. на Функцията синхронизира модела с базата данни, като създава таблицата, ако таблицата не съществува. Task.sync() Създаване на Express Server В края на краищата, можете да го сложите заедно, като създадете Express сървъра. файл, можете да настроите необходимия междинен софтуер, да дефинирате маршрутите на крайните точки на API и да изпълните експрес сървъра. index.js на функцията е отговорна за инициализирането на Express сървъра. функцията първо тества връзката към базата данни, като назове Ако връзката е успешна, тя стартира Express сървъра, който слуша на посочения порт. start start connectToDB() на Файлът съдържа следното съдържание: 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: 
 
 Попълнете състоянието на завършване — PATCH /api/tasks/:id/toggle-completed: 
 
 Изтриване на задача — DELETE /api/task: Заключението Сега знаете как да свържете приложение Express към база данни на Postgres с помощта на Sequelize.Създадохте прост API за управление на задачи и в процеса конфигурирахте Sequelize, свързахте Sequelize към инстанция на Postgres, дефинирахте Създаване на API крайни точки. Task В момента логиката на контролера е написана в В предстоящите уроци ще преработим тази кодова база в по-скалабилна структура с помощта на контролери, маршрутизатори и миграции Sequelize. index.js За по-нататъшно четене трябва да преминете през за да научите повече за заявки за модели, валидиране, асоциации и др. Разширяване на документацията Можете да намерите пълния код за този урок на . GitHub Ресурсите 
 
 
 
 
 Изтегляне на документация (v6) Какво е PostgreSQL? - AWS Използване на релационни бази данни с 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

Това аудио е създадено на оригиналния език на историята!

Как да свържете приложението Express към Postgres с помощта на Sequelize

About Author

КОМЕНТАРИ

ЗАКАЧВАЙТЕ ЕТИКЕТИ

ТАЗИ СТАТИЯ Е ПРЕДСТАВЕНА В

Related Stories

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps