Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

require-sql

ngourley4.5kBSD-2-Clause1.0.0

Allows for storing and using SQL files via require()

readme

node-require-sql

Allows for files with .sql extensions to be used with queries stored as plain text (no javascript multiline string non-sense).

Basic Example

// some-file.sql
SELECT
  *
FROM
  my_table
require('require-sql');

var query = require('./some-query.sql');

Template Example

An example using Underscore.js to insert variables using the template function.

// some-query-with-params.sql
SELECT
  *
FROM
  my_table
WHERE
    name = <%- name %>
var __ = require('underscore');
require('require-sql');

var query = require('./some-query-with-params.sql');
var queryWithParameters = __.template(query, {name: 'Bob'});