@garafu/mysql-fileloader

mysql-fileloader

This module load MySQL SQL string from sql files. Recursively reads SQL files that exist under the specified folder.

Install

npm install @garafu/mysql-fileloader

or

yarn add @garafu/mysql-fileloader

Usage

When read the required SQL string from specified file each time.

const path = require("path");
const root = path.join(__dirname, "./sql");
const { sql } = require("@garafu/mysql-fileloader")({ root });

(async () => {
  console.log(await sql("SELECT_USER_BY_ID")); // <-- "SELECT * FROM user WHERE id=?"
})();

When reading synchronously all SQL files from under specified folder.

const path = require("path");
const SQL = require("mysql-file").loadSync(path.join(__dirname, "./sql"));

console.log(SQL["SELECT_USER_BY_ID"]); // <-- "SELECT * FROM user WHERE id=?"

Documents

• function
  • function init([options]): void
  • function sql(name): Promise<string>
  • function loadSync(root [, options]): SQL
  • function loadAsync(root [, options]): SQL

function

function init([options]): void

Initialize SqlFileLoader.

arguments

• options
  • root {string} Root directory path of loading SQL files.

returns

This module object.

function sql(name): Promise<string>

Load SQL string from specified file asyncnously.

arguments

• name {string} SQL file name.

returns Promise<string> SQL string

function loadSync(root, options): SQL

Load sql string syncronously from sql files under the specified folder.

arguments

• root {string} Start directory for searching sql files.
• options {object} See options section.

returns

function loadAsync(root, options): SQL

Load sql string asyncronously from sql files under the specified folder.

arguments

• root {string} Start directory for searching sql files.
• options {object} See options section.

returns

options

• recursive {boolean} : Whether you want to recoursive search or not.

returns

SQL

Return value is object that includes key which is file name and value which is sql string.

Licence

MIT

Author

Akinari Tsugo