killercup / sortstringtosql

Node Module. Convert Sort Expression to SQL that can be used in 'ORDER BY' statement, e.g. '-aired,id' -> 'aird DESC NULLS LAST, id ASC NULLS LAST'.

Sort String To SQL

This is a JavaScript/node.js module to convert 'sort expressions' to SQL expressions that can be used in an 'ORDER BY'. E.g., -date,id will be converted date DESC NULLS LAST, id ASC NULLS LAST.

It can be used to parse a query parameter for sorting and to easily convert it to an expression that can be used in an SQL query.

I'm only using this with Postgres myself, so I can't promise you it will work with other databases.

Example

var sortStringToSql = require('sort-string-to-sql');
// In an express server, this might be `req.param('sort')`
var sortParam = '-date,id';
sortStringToSql(sortParam);
// => "date DESC NULLS LAST, id ASC NULLS LAST"

Input Format

Comma separated list of field names. Prepend a '-' for descending order or a '+' dor ascending order (which is the default, so it's optional). Append a '-' if you want records with null values first (this sets NULLS FIRST).

You can find some examples in test.js.

License

MIT

sortstringtosql's Issues

Should ORDER BY be prefixed in the returned value?

so that:

sortStringToSql('name') == 'ORDER BY name ASC NULLS LAST'
sortStringToSql('') ==  ''
sortStringToSql() ==  ''