{"_id":"safe-squel","_rev":"3-f9fded8b1d308a95811e24c81551b5c2","name":"safe-squel","dist-tags":{"latest":"5.12.5"},"versions":{"5.12.3":{"name":"safe-squel","description":"(safe version) SQL query string builder","version":"5.12.3","author":{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},"contributors":[{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},{"name":"Sergej Brjuchanov","email":"serges@seznam.cz"}],"dependencies":{"sql-escape-string":"^1.1.0"},"devDependencies":{"babel-preset-env":"^1.6.0","benchmark":"^2.1.4","chai":"1.5.x","coffee-script":"^1.10.0","growl":"^1.10.5","gulp":"^3.9.1","gulp-babel":"^6.1.2","gulp-concat":"^2.6.0","gulp-insert":"^0.5.0","gulp-istanbul":"^1.1.1","gulp-mocha":"^2.2.0","gulp-replace":"^0.5.4","gulp-uglify":"^1.5.3","gulp-umd":"^0.2.0","knex":"^0.14.6","load-grunt-tasks":"~0.1.0","mocha":"1.9.x","run-sequence":"^1.1.5","sinon":"1.6.x","time-grunt":"~0.1.1","uglify-js":"1.3.x","underscore":"1.4.x","yargs":"^4.7.1"},"keywords":["sql","database","rdbms"],"main":"dist/squel.js","types":"dist/squel.d.ts","scripts":{"test":"gulp","test-performance":"node performance/select.js","build":"gulp","prepublish":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/hiddentao/squel.git"},"engines":{"node":">= 0.12.0"},"gitHead":"16207039800a7daffc4a68544ae46cfcafbd6d8a","bugs":{"url":"https://github.com/hiddentao/squel/issues"},"homepage":"https://github.com/hiddentao/squel#readme","_id":"safe-squel@5.12.3","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"yibn2008","email":"yibn2008@gmail.com"},"dist":{"integrity":"sha512-P/89EP66vG+8LxnREkDMaSZ+E9cMNhzOGDEvHTA8bVo+nl3/SxVeRtKLsywDbOTbvXDbnlnY2+wxqdhEs7hEpw==","shasum":"8da1f784be20544ba6318a9d0f9102f304c86971","tarball":"https://registry.npmjs.org/safe-squel/-/safe-squel-5.12.3.tgz","fileCount":14,"unpackedSize":386009,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbow5VCRA9TVsSAnZWagAAnRUP/R0c1L4NbWhMz1i7jE41\ngE/e2q5yh4NH1ImWq9qkts68jBt+hhAz+aAh8quzEBbdAnNRvKbT7GLFUfS3\nEE8u3Z0P4PXm28k6maDX7yIqJ52FtxZAogwAcsIlVRv30aXslj2pmbMh9O6b\nZf8lkvz/FiZeNIZkhsdkGvwNLHqP8qkWAnu0jmidinvmW2lnt4MTAToJvS7u\ne5QGHcbotUSsEaelPnOYTHdEaKmsPaTSaXUw88yyRFNSMU9+F5mejs6k+v83\n8KgBWeCoCCjImKDsWuGZ/K7CX0hDTdPIcOeyrdkuVQaJpuFUlGy5iFM8uCX8\nJuZPgFbiIq+rTRN21ejG6qMjB1zjKE8Izztc4kT9M902M7Jm9ezezg8iBpz0\noHOF8zwzEqswYEB2w/fg0XV1hxu/KmGsNSo0HlEMyK9E8R/mk204+lTMLI4k\nRGJGbWRHvw4OyadbOJ+w5IlJEeQhnRZLA+PbbPJc2Ih5/N8AlazV7wett8Yg\nFHP4GPHX1KhkOvNQs7Lc0wbpO369S/+OHuyCA8Lmpfk+8sm3WJDvNki4DRmE\nGEeYkgSIZIDcUfgqKjAUhLkM6ULaWs7IjPYRRacRS+aMjkaretwXzG+I8Pw2\no887Xv4IwwAQKeo4dkippy4eVcYa+jTU9JisqAHf0pmQvV/44da0b5iUeLUk\ndoud\r\n=d3qJ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD6KrrehMn6W0TfmY6oYZi6RjoD/zHWf6JirdKg+lfnQQIhAKMlPZxOC7yRUDfHJXnYqDVFWJoxKdT1FFUvDLdz+Hti"}]},"maintainers":[{"name":"yibn2008","email":"yibn2008@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/safe-squel_5.12.3_1537412693051_0.08361087476077356"},"_hasShrinkwrap":false},"5.12.4":{"name":"safe-squel","description":"(safe version) SQL query string builder","version":"5.12.4","author":{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},"contributors":[{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},{"name":"Sergej Brjuchanov","email":"serges@seznam.cz"}],"dependencies":{"sql-escape-string":"^1.1.0"},"devDependencies":{"babel-preset-env":"^1.6.0","benchmark":"^2.1.4","chai":"1.5.x","coffee-script":"^1.10.0","growl":"^1.10.5","gulp":"^3.9.1","gulp-babel":"^6.1.2","gulp-concat":"^2.6.0","gulp-insert":"^0.5.0","gulp-istanbul":"^1.1.1","gulp-mocha":"^2.2.0","gulp-replace":"^0.5.4","gulp-uglify":"^1.5.3","gulp-umd":"^0.2.0","knex":"^0.14.6","load-grunt-tasks":"~0.1.0","mocha":"1.9.x","run-sequence":"^1.1.5","sinon":"1.6.x","time-grunt":"~0.1.1","uglify-js":"1.3.x","underscore":"1.4.x","yargs":"^4.7.1"},"keywords":["sql","database","rdbms"],"main":"dist/squel.js","types":"dist/squel.d.ts","scripts":{"test":"gulp","test-performance":"node performance/select.js","build":"gulp","prepublish":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/hiddentao/squel.git"},"engines":{"node":">= 0.12.0"},"gitHead":"130c9aee16c5fb7bdd402f0c5996f7d205f2e91a","bugs":{"url":"https://github.com/hiddentao/squel/issues"},"homepage":"https://github.com/hiddentao/squel#readme","_id":"safe-squel@5.12.4","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"yibn2008","email":"yibn2008@gmail.com"},"dist":{"integrity":"sha512-Kh/BQC54RvGVLtgGO0T1pCXQlQLLCWsw72dlEl1tuOiFDWsoWN/68I8aKNASeOtsvRdLXIMtJ/gk7lWol5IBqA==","shasum":"2b9e0f747e32cfe7295e1de662b98ad676195710","tarball":"https://registry.npmjs.org/safe-squel/-/safe-squel-5.12.4.tgz","fileCount":14,"unpackedSize":386418,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJboxe5CRA9TVsSAnZWagAAU9UQAKLuP+ksD1nxEyFiP4BF\nxBPIDriqqz2m0EqSuiacP5mM3LqRS0dwe97OIGFRUv8xGHI+09EG2mRagz8L\n0UVigtB9f2KzWto1UJbohxRUo98dTEeCPFDDGED+1dyu5Iy8BWnzrlf4NtI+\nGjo75W2WwvCEEZo8znQFkrbSDbFQvq/b6mCMHJ2QlZrO0KAt9FHlIyw/hwhP\nBAlgmlAmo8VbaxVfFSkLPu4SS8CIMDXbQVZli5Hg0lZe6JC8vWGvzaTskuEe\n2FIDJ0YZlcQ0AaBFZ29y2+CbYf7DO34CP6RDHmikixg7Chip6+2zDrAf5Igr\nlSP5x9bZUkyIRfyOufjSgXLuQsAMkFxkF1zCJrLsjQHLiD4LaWF6REeUpBRR\nnIxGTh5yEqVnscSXpfpokZObzu0hNvQ7KdPQgrqWoM16mdHCfkMFKY5xbK5i\n0xvDyjQUiW5aVQ269DdFVm8WzN5Kz8srtXq+fTA/IG+Sa71HEQ21cZ9+hcPx\n9MprhpdBI+msBZTsDj5q7AZNeio6ym4HsuNnGqDH1sUDPKdwjS77MIZvZ4Lz\nu+JoWQtnCAbTZO9kVGgQ2XUkrA7nA6QpOw0hhch4Za8TC2iryswXsd9Rihws\nuYzp7xrrfjcuFcnOWSpllMnIO/ShAcSB2NevcOwRaro1mCFXAGb/ruMOAZw4\niH1D\r\n=YFua\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC354bEHs0SzyhBRjMKUtYk9XEykwnioVV3CD4r3aZBUwIgHiMaHyDit0O1PWGYTLHOwNLnCmx3Bapdw/RUTc3XP80="}]},"maintainers":[{"name":"yibn2008","email":"yibn2008@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/safe-squel_5.12.4_1537415096680_0.09591132686335468"},"_hasShrinkwrap":false},"5.12.5":{"name":"safe-squel","description":"(safe version) SQL query string builder","version":"5.12.5","author":{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},"contributors":[{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},{"name":"Sergej Brjuchanov","email":"serges@seznam.cz"}],"dependencies":{"sql-escape-string":"^1.1.0"},"devDependencies":{"babel-preset-env":"^1.6.0","benchmark":"^2.1.4","chai":"1.5.x","coffee-script":"^1.10.0","growl":"^1.10.5","gulp":"^3.9.1","gulp-babel":"^6.1.2","gulp-concat":"^2.6.0","gulp-insert":"^0.5.0","gulp-istanbul":"^1.1.1","gulp-mocha":"^2.2.0","gulp-replace":"^0.5.4","gulp-uglify":"^1.5.3","gulp-umd":"^0.2.0","knex":"0.x","load-grunt-tasks":"~0.1.0","mocha":"1.9.x","run-sequence":"^1.1.5","sinon":"1.6.x","time-grunt":"~0.1.1","uglify-js":"1.3.x","underscore":"1.4.x","yargs":"^4.7.1"},"keywords":["sql","database","rdbms"],"main":"dist/squel.js","types":"dist/squel.d.ts","scripts":{"test":"gulp","test-performance":"node performance/select.js","build":"gulp","prepublish":"npm run build"},"repository":{"type":"git","url":"git+https://github.com/hiddentao/squel.git"},"engines":{"node":">= 0.12.0"},"gitHead":"130e4e1d5ea70e61feb1e1618392ef39e82d8409","bugs":{"url":"https://github.com/hiddentao/squel/issues"},"homepage":"https://github.com/hiddentao/squel#readme","_id":"safe-squel@5.12.5","_npmVersion":"5.6.0","_nodeVersion":"8.11.3","_npmUser":{"name":"yibn2008","email":"yibn2008@gmail.com"},"dist":{"integrity":"sha512-ls4iMpRE+/yTJ3W9GDRAT9rjqNVl220ng+N55udJXNu9ubcidMFA66Nung5UuE3xFlSSwvkV9PaMR5HZvShuvw==","shasum":"9597cec498dc184a15fe94082b7bcc80cb4d048b","tarball":"https://registry.npmjs.org/safe-squel/-/safe-squel-5.12.5.tgz","fileCount":14,"unpackedSize":386530,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdv58dCRA9TVsSAnZWagAAiAIP/R86yfj9d6hD9+JRzH3/\n+UGbhFt2yWwW6GaqoDPJHUY6vk8VWbDcfEReuhv+srrK1qKV9W1oUtB5ovDO\nUXyOZrPoNwCktIr4te+rGcIXU39+t25RA6PQzMkK0fvnb9PrB6RoE1eno2F+\n6eSsjJ1LQcn6F1WVOcHDvX8O2usg4o/TEgaf9HbM3G+XHGPw0OxPc5WSaeoH\nQrnya9wjcC9kwwQBNUiSxW/Sa70K0Yxtc49w8WCMkVaUsP/k7cHkPIUux8Gs\n8dxSIarK6eX19qWjJ4C15L/WfYg85vr/uutMCc9b9VDsG5x/QNe3Ho+xNjTi\nOLoWKKVb0/Ni+7u0ygBInnwnCn1bqiZGiLRemdoXzNbodDOeAdGRbh9kY86b\nWmEl82DOkSG3vdvtQr6pqxUTxlkVxNNDqqx+spGLqO2wrC2IoonN7DNsT6m1\nv/gD4vs/n+pjh0X6Y88F16+nynYvy98PPVWhqm3OCpNLcl38Cqo+JUMCDFrQ\nno7t35Us/C7M27kh9tG+sfZjTcEeNk68IAvLEUjTrQdtvfg+CMyuxFPYd34Y\nSFX35o0wTk6NcOEakC3luch9H8n6PHOb4KRSBuSfPB/Knn8I4xz6/QHDRhwN\nYwcZGvpoK/fjD8UoXFld51SOq4ATSKM6I+wwwzSLh/2ONYlyA+t2j7Iw2yGy\nK11X\r\n=4TuE\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC95f2Ycp4zfxJuVu5nKiLw3JsHD7dwWGt5C2fZevxAYAIhAP9I7DlSH5U0Y/je908tcewESfMn53hgKyPFIy6oIFCF"}]},"maintainers":[{"name":"yibn2008","email":"yibn2008@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/safe-squel_5.12.5_1572839196933_0.8675466282372584"},"_hasShrinkwrap":false}},"time":{"created":"2018-09-20T03:04:53.050Z","5.12.3":"2018-09-20T03:04:53.331Z","modified":"2022-05-16T10:17:32.921Z","5.12.4":"2018-09-20T03:44:56.836Z","5.12.5":"2019-11-04T03:46:37.649Z"},"maintainers":[{"name":"yibn2008","email":"yibn2008@gmail.com"}],"description":"(safe version) SQL query string builder","homepage":"https://github.com/hiddentao/squel#readme","keywords":["sql","database","rdbms"],"repository":{"type":"git","url":"git+https://github.com/hiddentao/squel.git"},"contributors":[{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},{"name":"Sergej Brjuchanov","email":"serges@seznam.cz"}],"author":{"name":"Ramesh Nair","email":"ram@hiddentao.com","url":"http://www.hiddentao.com/"},"bugs":{"url":"https://github.com/hiddentao/squel/issues"},"readme":"# squel - SQL query string builder\n\n[](http://travis-ci.org/hiddentao/squel)\n[](https://cdnjs.com/libraries/squel)\n[](https://badge.fury.io/js/squel)\n[](https://www.npmjs.com/package/squel)\n[](https://discord.gg/PBAR2Bz)\n[](https://twitter.com/hiddentao)\n\nA flexible and powerful SQL query string builder for Javascript.\n\nFull documentation (guide and API) at [https://hiddentao.com/squel/](https://hiddentao.com/squel/).\n\n## Features\n\n* Works in node.js and in the browser.\n* Supports the standard SQL queries: SELECT, UPDATE, INSERT and DELETE.\n* Supports non-standard commands for popular DB engines such as MySQL.\n* Supports paramterized queries for safe value escaping.\n* Can be customized to build any query or command of your choosing.\n* Uses method chaining for ease of use.\n* Small: ~7 KB minified and gzipped\n* And much more, [see the guide..](https://hiddentao.com/squel/)\n\n**WARNING: Do not ever pass queries generated on the client side to your web server for execution.** Such a configuration would make it trivial for a casual attacker to execute arbitrary queries—as with an SQL-injection vector, but much easier to exploit and practically impossible to protect against.\n\n_Note: Squel is suitable for production use, but you may wish to consider more\nactively developed alternatives such as [Knex](http://knexjs.org/)_\n\n## Installation\n\nInstall using [npm](http://npmjs.org/):\n\n```bash\n$ npm install squel\n```\n\n## Available files\n\n* `squel.js` - unminified version of Squel with the standard commands and all available non-standard commands added\n* `squel.min.js` - minified version of `squel.js`\n* `squel-basic.js` - unminified version of Squel with only the standard SQL commands\n* `squel-basic.min.js` - minified version of `squel-basic.js`\n\n\n## Examples\n\nBefore running the examples ensure you have `squel` installed and enabled at the top of your script:\n\n var squel = require(\"squel\");\n\n### SELECT\n\n```javascript\n// SELECT * FROM table\nsquel.select()\n .from(\"table\")\n .toString()\n\n// SELECT t1.id, t2.name FROM table `t1` LEFT JOIN table2 `t2` ON (t1.id = t2.id) WHERE (t2.name <> 'Mark') AND (t2.name <> 'John') GROUP BY t1.id\nsquel.select()\n .from(\"table\", \"t1\")\n .field(\"t1.id\")\n .field(\"t2.name\")\n .left_join(\"table2\", \"t2\", \"t1.id = t2.id\")\n .group(\"t1.id\")\n .where(\"t2.name <> 'Mark'\")\n .where(\"t2.name <> 'John'\")\n .toString()\n\n// SELECT `t1`.`id`, `t1`.`name` as \"My name\", `t1`.`started` as \"Date\" FROM table `t1` WHERE age IN (RANGE(1, 1.2)) ORDER BY id ASC LIMIT 20\nsquel.select({ autoQuoteFieldNames: true })\n .from(\"table\", \"t1\")\n .field(\"t1.id\")\n .field(\"t1.name\", \"My name\")\n .field(\"t1.started\", \"Date\")\n .where(\"age IN ?\", squel.str('RANGE(?, ?)', 1, 1.2))\n .order(\"id\")\n .limit(20)\n .toString()\n```\n\nYou can build parameterized queries:\n\n```js\n/*\n{\n text: \"SELECT `t1`.`id`, `t1`.`name` as \"My name\", `t1`.`started` as \"Date\" FROM table `t1` WHERE age IN (RANGE(?, ?)) ORDER BY id ASC LIMIT 20\",\n values: [1, 1.2]\n}\n*/\nsquel.select({ autoQuoteFieldNames: true })\n .from(\"table\", \"t1\")\n .field(\"t1.id\")\n .field(\"t1.name\", \"My name\")\n .field(\"t1.started\", \"Date\")\n .where(\"age IN ?\", squel.str('RANGE(?, ?)', 1, 1.2))\n .order(\"id\")\n .limit(20)\n .toParam()\n```\n\n\nYou can use nested queries:\n\n```javascript\n// SELECT s.id FROM (SELECT * FROM students) `s` INNER JOIN (SELECT id FROM marks) `m` ON (m.id = s.id)\nsquel.select()\n .from( squel.select().from('students'), 's' )\n .field('id')\n .join( squel.select().from('marks').field('id'), 'm', 'm.id = s.id' )\n .toString()\n```\n\n### UPDATE\n\n```javascript\n// UPDATE test SET f1 = 1\nsquel.update()\n .table(\"test\")\n .set(\"f1\", 1)\n .toString()\n\n// UPDATE test, test2, test3 AS `a` SET test.id = 1, test2.val = 1.2, a.name = \"Ram\", a.email = NULL, a.count = a.count + 1\nsquel.update()\n .table(\"test\")\n .set(\"test.id\", 1)\n .table(\"test2\")\n .set(\"test2.val\", 1.2)\n .table(\"test3\",\"a\")\n .setFields({\n \"a.name\": \"Ram\",\n \"a.email\": null,\n \"a.count = a.count + 1\": undefined\n })\n .toString()\n```\n\n### INSERT\n\n```javascript\n// INSERT INTO test (f1) VALUES (1)\nsquel.insert()\n .into(\"test\")\n .set(\"f1\", 1)\n .toString()\n\n// INSERT INTO test (name, age) VALUES ('Thomas', 29), ('Jane', 31)\nsquel.insert()\n .into(\"test\")\n .setFieldsRows([\n { name: \"Thomas\", age: 29 },\n { name: \"Jane\", age: 31 } \n ])\n .toString()\n```\n\n### DELETE\n\n```javascript\n// DELETE FROM test\nsquel.delete()\n .from(\"test\")\n .toString()\n\n// DELETE FROM table1 WHERE (table1.id = 2) ORDER BY id DESC LIMIT 2\nsquel.delete()\n .from(\"table1\")\n .where(\"table1.id = ?\", 2)\n .order(\"id\", false)\n .limit(2)\n```\n\n### Paramterized queries\n\nUse the `useParam()` method to obtain a parameterized query with a separate list of formatted parameter values:\n\n```javascript\n// { text: \"INSERT INTO test (f1, f2, f3, f4, f5) VALUES (?, ?, ?, ?, ?)\", values: [1, 1.2, \"TRUE\", \"blah\", \"NULL\"] }\nsquel.insert()\n .into(\"test\")\n .set(\"f1\", 1)\n .set(\"f2\", 1.2)\n .set(\"f3\", true)\n .set(\"f4\", \"blah\")\n .set(\"f5\", null)\n .toParam()\n```\n\n\n### Expression builder\n\nThere is also an expression builder which allows you to build complex expressions for `WHERE` and `ON` clauses:\n\n```javascript\n// test = 3 OR test = 4\nsquel.expr()\n .or(\"test = 3\")\n .or(\"test = 4\")\n .toString()\n\n// test = 3 AND (inner = 1 OR inner = 2) OR (inner = 3 AND inner = 4 OR (inner IN ('str1, 'str2', NULL)))\nsquel.expr()\n .and(\"test = 3\")\n .and(\n squel.expr()\n .or(\"inner = 1\")\n .or(\"inner = 2\")\n )\n .or(\n squel.expr()\n .and(\"inner = ?\", 3)\n .and(\"inner = ?\", 4)\n .or(\n squel.expr()\n .and(\"inner IN ?\", ['str1', 'str2', null])\n )\n )\n .toString()\n\n// SELECT * FROM test INNER JOIN test2 ON (test.id = test2.id) WHERE (test = 3 OR test = 4)\nsquel.select()\n .join( \"test2\", null, squel.expr().and(\"test.id = test2.id\") )\n .where( squel.expr().or(\"test = 3\").or(\"test = 4\") )\n```\n\n### Custom value types\n\nBy default Squel does not support the use of object instances as field values. Instead it lets you tell it how you want\nspecific object types to be handled:\n\n```javascript\n// handler for objects of type Date\nsquel.registerValueHandler(Date, function(date) {\n return date.getFullYear() + '/' + (date.getMonth() + 1) + '/' + date.getDate();\n});\n\nsquel.update().\n .table('students')\n .set('start_date', new Date(2013, 5, 1))\n .toString()\n\n// UPDATE students SET start_date = '2013/6/1'\n```\n\n\n_Note that custom value handlers can be overridden on a per-instance basis (see the [docs](https://hiddentao.com/squel/))_\n\n### Custom queries\n\nSquel allows you to override the built-in query builders with your own as well as create your own types of queries:\n\n```javascript\n// ------------------------------------------------------\n// Setup the PRAGMA query builder\n// ------------------------------------------------------\nvar util = require('util'); // to use util.inherits() from node.js\n\nvar CommandBlock = function() {};\nutil.inherits(CommandBlock, squel.cls.Block);\n\n// private method - will not get exposed within the query builder\nCommandBlock.prototype._command = function(_command) {\n this._command = _command;\n}\n\n// public method - will get exposed within the query builder\nCommandBlock.prototype.compress = function() {\n this._command('compress');\n};\n\nCommandBlock.prototype.buildStr = function() {\n return this._command.toUpperCase();\n};\n\n\n// generic parameter block\nvar ParamBlock = function() {};\nutil.inherits(ParamBlock, squel.cls.Block);\n\nParamBlock.prototype.param = function(p) {\n this._p = p;\n};\n\nParamBlock.prototype.buildStr = function() {\n return this._p;\n};\n\n\n// pragma query builder\nvar PragmaQuery = function(options) {\n squel.cls.QueryBuilder.call(this, options, [\n new squel.cls.StringBlock(options, 'PRAGMA'),\n new CommandBlock(),\n new ParamBlock()\n ]);\n};\nutil.inherits(PragmaQuery, squel.cls.QueryBuilder);\n\n\n// convenience method (we can override built-in squel methods this way too)\nsquel.pragma = function(options) {\n return new PragmaQuery(options)\n};\n\n\n// ------------------------------------------------------\n// Build a PRAGMA query\n// ------------------------------------------------------\n\nsquel.pragma()\n .compress()\n .param('test')\n .toString();\n\n// 'PRAGMA COMPRESS test'\n```\n\nExamples of custom queries in the wild:\n\n * https://github.com/bostrt/squel-top-start-at (blog post about it: http://blog.bostrt.net/extending-squel-js/)\n\n\n## Non-standard SQL\n\nSquel supports the standard SQL commands and reserved words. However a number of database engines provide their own\nnon-standard commands. To make things easy Squel allows for different 'flavours' of SQL to be loaded and used.\n\nAt the moment Squel provides `mysql`, `mssql` and `postgres` flavours which augment query builders with additional commands (e.g. `INSERT ... RETURNING`\nfor use with Postgres).\n\nTo use this in node.js:\n\n```javascript\nvar squel = require('squel').useFlavour('postgres');\n```\n\nFor the browser:\n\n```html\n\n\n```\n\n(Internally the flavour setup method simply utilizes the [custom query mechanism](http://hiddentao.github.io/squel/#custom_queries) to effect changes).\n\nRead the the [API docs](http://hiddentao.github.io/squel/api.html) to find out available commands. Flavours of SQL which get added to\nSquel in the future will be usable in the above manner.\n\n## Building it\n\nTo build the code and run the tests:\n\n $ npm install\n $ npm test <-- this will build the code and run the tests\n\n## Releasing it\n\nInstructions for creating a new release of squel are in `RELEASE.md`.\n\n\n## Contributing\n\nContributions are welcome! Please see `CONTRIBUTING.md`.\n\n## Older verions\n\n**Note: The latest Squel version only works on Node 0.12 or above. Please use Squel 4.4.1 for Node <0.12. The [old 4.x docs](http://hiddentao.github.io/squel/v4/index.html) are also still available.**\n\n\n## Ports to other languages\n\n* .NET - https://github.com/seymourpoler/Squel.net\n* Crystal - https://github.com/seymourpoler/Squel.crystal\n\n## License\n\nMIT - see LICENSE.md\n","readmeFilename":"README.md"}