js-sql

Write SQL in your JavaScript

Under development

Examples

function foo(table) {
  var x = <sql>
    SELECT * FROM {table}
    WHERE name = $1 AND id = {getId()}
  </sql>;

  return x;
};

function getId() {
  return 4;
}

console.log(foo("user")); // SELECT * FROM user WHERE name = $1 AND id = 4

A few simple examples

var sql = <sql>SELECT * FROM users WHERE id = $1</sql>
// SELECT * FROM users WHERE id = $1

// multi-line support
var sql = <sql>
  SELECT * FROM users
  WHERE id = $1
</sql>
// SELECT * FROM users WHERE id = $1

Examples of JavaScript in your SQL (use where appropriate, really you should stick to parameterizing)

var sql = <sql>
  SELECT * FROM users
  WHERE id = {3+4}
</sql>
// SELECT * FROM users WHERE id = 7

var email = 'test@test.test'
var sql = <sql>
  SELECT * FROM users
  WHERE email = '{email}'
</sql>
// SELECT * FROM users WHERE email = 'test@test.test'

var email = 'test@test.test'
var sql = <sql>
  SELECT * FROM users
  WHERE email = '{"pre-"+email}'
</sql>
// SELECT * FROM users WHERE email = 'pre-test@test.test'

var getEmail = function() {
  return "test@test.test"
}

var sql = <sql>
  SELECT * FROM users
  WHERE email = '{getEmail()}'
</sql>
// SELECT * FROM users WHERE email = 'test@test.test'

JSS command usage

Usage: jss [options] <source directory> <output directory> [<module ID> [<module ID> ...]]

Options:

  -h, --help                               output usage information
  -V, --version                            output the version number
  -c, --config [file]                      JSON configuration file (no file means STDIN)
  -w, --watch                              Continually rebuild
  -x, --extension <js | coffee | ...>      File extension to assume when resolving module identifiers
  --relativize                             Rewrite all module identifiers to be relative
  --follow-requires                        Scan modules for required dependencies
  --cache-dir <directory>                  Alternate directory to use for disk cache
  --no-cache-dir                           Disable the disk cache
  --source-charset <utf8 | win1252 | ...>  Charset of source (default: utf8)
  --output-charset <utf8 | win1252 | ...>  Charset of output (default: utf8)
  --harmony                                Turns on JS transformations such as ES6 Classes etc.

Transpiling example

jss -x jss src/ build/ # this will transpile all .jss files in the src directory into the build directory

Plugins

vim plugin support is here: vim-js-sql