Nodejs용 KNEX.JS SQL 쿼리 빌더

SQL 데이터베이스용 KnexJs 시작하기 먼저 프로젝트에 대해 express e.t.c와 같은 모든 중요한 종속 항목을 설치합니다.
knex.js 설치:

설치

$ npm install knex --save

그런 다음 사용하기로 선택한 다음 유형의 SQL 중 하나를 추가합니다.

$ npm install pg  #For PostgreSQL

$ npm install pg-native  #PostgreSQL with native C++ libpq

$ npm install @vscode/sqlite3 # required for sqlite

$ npm install better-sqlite3

$ npm install mysql #For MySQL

$ npm install mysql2 #For MySQL2

$ npm install oracledb #For oracledb

$ npm install tedious

그런 다음 다음으로 수행할 작업은 다음을 사용하여 SQL 데이터베이스를 구성하기 위해 config 폴더에 knexfile을 생성하는 것입니다.

$ npx knex init

이렇게 하면 knexfile.js라는 파일이 생성되며 다음이 포함됩니다.

knexfile.js

// Update with your config settings.

/**
 * @type { Object.<string, import("knex").Knex.Config> }
 */
module.exports = {

  development: {
    client: 'sqlite3',
    connection: {
      filename: './dev.sqlite3'
    }
  },

  staging: {
    client: 'postgresql',
    connection: {
      database: 'my_db',
      user:     'username',
      password: 'password'
    },
    pool: {
      min: 2,
      max: 10
    },
    migrations: {
      tableName: 'knex_migrations'
    }
  },

  production: {
    client: 'postgresql',
    connection: {
      database: 'my_db',
      user:     'username',
      password: 'password'
    },
    pool: {
      min: 2,
      max: 10
    },
    migrations: {
      tableName: 'knex_migrations'
    }
  }

};

여기에서 구성에 맞게 편집할 수 있습니다. 이것은 아래의 내 설정입니다.

// Update with your config settings.

/**
 * @type { Object.<string, import("knex").Knex.Config> }
 */


module.exports = {
  development: {
    client: 'mysql',
      connection: {
        user: 'Abdulraqeeb',
        password: null,
        database: 'test'
    },
    pool: {
        min: 2,
        max: 10
    },
    migrations: {
      tableName: 'knex_migrations'
    }
  }

};

구성을 설정한 후 구성 폴더에 db.js 또는 config.js라는 또 다른 파일을 생성하여 구성을 knex와 연결해야 합니다. 여기에서 knex를 가져오고 아래와 같이 구성에 연결합니다.

config.js or db.js

const knex = require('knex');
const knexfile = require('./knexfile');

const db = knex(knexfile.development);

module.exports = db; 

그런 다음 구성 폴더 내에 마이그레이션이라는 폴더를 만든 다음 API 또는 웹 애플리케이션에 대한 마이그레이션을 생성/작성해야 합니다. 마이그레이션 파일을 생성하려면 아래 명령을 사용하십시오.

$ npx knex migrate:make init --migrations-directory config/migrations 
#you can change "init" to "user" or whatever table name you want to create in your database

그러면 다음과 같은 파일이 생성됩니다.

20220319104333_users.js

내부에는 다음이 있습니다.

/**
 * @param { import("knex").Knex } knex
 * @returns { Promise<void> }
 */

exports.up = function(knex) {

  };

/**
 * @param { import("knex").Knex } knex
 * @returns { Promise<void> }
 */

exports.down = function(knex) {

};

"exports.up" literally means add to the database this "table's schema"
"export.down" means drop or delete this "table's schema"

그런 다음 다음과 같이 테이블 스키마를 작성할 수 있습니다.

/**
 * @param { import("knex").Knex } knex
 * @returns { Promise<void> }
 */

exports.up = function(knex) {
    return knex.schema
        .createTable('users', table => {
            table.string('id', 10).notNullable().unique().primary();
            table.string('email').notNullable().unique();
            table.string('fullname').notNullable();
            table.string('username').notNullable().unique();
            table.string('password').notNullable();
            table.bigInteger('money').notNullable().defaultTo(0);
            table.timestamp('createdAt').defaultTo(knex.raw('CURRENT_TIMESTAMP'));
            table.timestamp('updatedAt').defaultTo(knex.raw('CURRENT_TIMESTAMP'))
        });


};

/**
 * @param { import("knex").Knex } knex
 * @returns { Promise<void> }
 */
exports.down = function(knex) {
    return knex.schema.dropTable('users');
};

knexjshere에서 데이터 유형을 사용하는 방법을 찾을 수 있습니다.

그런 다음 사용 중인 SQL로 마이그레이션할 차례입니다. 제 경우에는 MySQL을 사용하고 있습니다.
마이그레이션을 더 쉽게 하기 위해 "migrate"스크립트를

package.json file

 "scripts": {
    "test": "jest",
    "test:watch": "jest --watch",
    "dev": "nodemon app.js",
    "start": "node app,js",
    "migrate": "npx knex migrate:latest --knexfile config/knexfile.js"
  }

그리고 터미널을 사용하여 실행

$ npm run migrate
#or
$ npx knex migrate:latest --knexfile config/knexfile.js

이렇게 하면 테이블과 knex_migration 및 knex_migration_lock이 생성됩니다.



knex_migration은 마이그레이션한 각 스키마가 포함된 테이블을 보여주고 knex_migration_lock은 스키마의 액세스가 잠겼는지 여부를 보여줍니다.
knex 마이그레이션here에 대해 자세히 알아볼 수 있습니다.

이제 컨트롤러에서 knex를 사용하여 데이터베이스에 데이터를 가져오고 삽입할 차례입니다. 여기서는 Sequelize 또는 TypeORM 등과 같은 다른 ORM과 비교하여 findByPk와 같은 구문을 사용하지 않고 선택, 삽입, 위치, del, 업데이트 등을 사용하여 다른 기능을 수행합니다. 더 알아보기here .
이 중 일부를 예를 들어 설명하겠습니다.

exports.getUsers = async(req, res) => {
    try {
        await db('users')
            .select({
                id: 'id',
                fullname: "fullname",
                username: "username",
                email: "email",
                money: "money"
            })
            .then((user) => {
                if(user) {
                    res.status(200).json(user)
                } else{
                    res.status(404).json("No user found")
                }
            })
    } catch (error) {
        console.error(error)
        return res.status(500).json({
            status: false,
            msg: "an error occured"
        });
    }
}

위의 예시에서 ** SELECT** 메서드는 데이터베이스에서 클라이언트로 보내야 하는 매개변수를 정의하는 데 사용됩니다. 이 경우 데이터베이스의 모든 사용자 정보를 보내려고 합니다. 비동기 함수는 함수를 수행한 후 결과/응답을 제공하는 콜백 함수(".then()")가 있음을 의미합니다. 함수가 작동하지 않도록 콜백 함수를 추가하는 것이 매우 중요합니다.
이 함수는 개체 배열에 사용자를 나열합니다.

[
    {
        "id": "_bnKpvCKaS",
        "fullname": "admin  test",
        "username": "admin",
        "email": "[email protected]",
        "money": 295000
    },
    {
        "id": "pO5bMfU1yV",
        "fullname": "admin2  test",
        "username": "admin2",
        "email": "[email protected]",
        "money": 20000
    }
]

사용자 정보 중 하나가 필요한 경우에는 다음과 같이 함수에 ".where"를 추가해야 합니다.

exports.getUser = async(req, res) => {
 const userinfo = req.user // for cases where you use authorization for logging in
    try {
        await db('users')
            .select({
                id: 'id',
                fullname: "fullname",
                username: "username",
                email: "email",
                money: "money"
            })
            .where({
                username: userinfo.username
           })
            .then((user) => {
                if(user[0]) {
                    res.status(200).json(user[0])
                } else{
                    res.status(404).json("No user found")
                }
            })
    } catch (error) {
        console.error(error)
        return res.status(500).json({
            status: false,
            msg: "an error occured"
        });
    }
}

여기에서 ".where"가 추가되고 "user[0]"도 사용되는 것을 알 수 있습니다. 이는 응답이 배열로 오기 때문입니다. 이렇게 하면 다음을 얻을 수 있습니다.

    {
        "id": "_bnKpvCKaS",
        "fullname": "admin test",
        "username": "admin",
        "email": "[email protected]",
        "money": 295000
    },

INSERT의 경우 삽입은 데이터를 데이터베이스로 가져오는 데 사용됩니다.

       await db('users')
            .insert({
                id: nanoid(10),
                fullname: fullname,
                username: username,
                email: email,
                money: 0,
                password: hashedPass,
                pin: hashedPin,
                 })
                 .then((user)=>{
                  return res.status(201).json({
                  status: true,
                  mesaage: "user Account created successfully"
                    })
               });

업데이트를 위해

      await db('users')
        .where({
                username: userinfo[0].username
            })
         .update(
                req.body
            )
         .catch((err) => console.log(err));

삭제를 위해

   await db('users')
       .where({
             username: username
         })
       .del()
       .catch((err) => console.log(err));

참고: 콜백이 없으면 이러한 기능이 작동하지 않습니다.

내 기사를 읽어 주셔서 감사합니다. 누군가를 도울 수 있기를 바랍니다. 추가했으면 하는 내용이 있으면 언제든지 문의해 주세요.