{"id":21831355,"url":"https://github.com/nodef/pg-slang","last_synced_at":"2025-06-10T08:35:26.985Z","repository":{"id":57322652,"uuid":"136447368","full_name":"nodef/pg-slang","owner":"nodef","description":"Convert informal SQL SELECT to formal SQL.","archived":false,"fork":false,"pushed_at":"2025-04-08T17:10:23.000Z","size":13,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-10T02:09:36.505Z","etag":null,"topics":["column","formal","informal","pg","row","select","slang","sql","table"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/pg-slang","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodef.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-07T08:34:49.000Z","updated_at":"2025-04-08T17:10:27.000Z","dependencies_parsed_at":"2022-08-25T21:01:15.446Z","dependency_job_id":null,"html_url":"https://github.com/nodef/pg-slang","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodef%2Fpg-slang","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodef%2Fpg-slang/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodef%2Fpg-slang/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodef%2Fpg-slang/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodef","download_url":"https://codeload.github.com/nodef/pg-slang/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodef%2Fpg-slang/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259039161,"owners_count":22796767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["column","formal","informal","pg","row","select","slang","sql","table"],"created_at":"2024-11-27T19:09:52.510Z","updated_at":"2025-06-10T08:35:26.971Z","avatar_url":"https://github.com/nodef.png","language":"JavaScript","readme":"# pg-slang\n\n[![NPM](https://nodei.co/npm/pg-slang.png)](https://nodei.co/npm/pg-slang/)\n\nConvert informal [SQL SELECT] to formal SQL.\n\u003e NOTE: [pg-english] can convert english query to informal SQL.\n\n```sql\n-- ex: SLANG\nSELECT \"food name\", \"calcium\" FROM \"apples\"\n-- ex: SQL\nSELECT \"name\", \"ca\", \"ca_e\" FROM \"compositions\"\nWHERE TRUE AND (FALSE OR (\"tsvector\" @@ 'apples'))\n```\n\n```javascript\nconst slang = require('pg-slang');\n// slang(\u003cinformal sql\u003e, \u003cmap fn\u003e, [this], [options])\n// -\u003e Promise (formal sql)\n\n// \u003cinformal sql\u003e:\n// SELECT \"food name\", \"trans fat\" FROM \"food\" ORDER BY \"trans fat\" DESC\n// SELECT \"protein\", \"vitamin d\" FROM \"poultry ORDER BY \"vitamin d\" DESC\n// SELECT \"sum: essential amino acids\" AS \"amino\" FROM \"meat\" ORDER BY \"amino\"\n// ...\n\n// \u003cmap fn\u003e(\u003ctext\u003e, \u003ctype\u003e, [hint], [from]):\n// - text: field name, like \"food name\", \"trans fat\", \"food\", ...\n// - type: field type, can be \"from\",\"columns\", \"where\", \"having\", \"orderBy\", or \"groupBy\"\n// - hint: field hint, can be null, \"all\", \"sum\", or \"avg\"\n// - from: field from, will be null for type=table\n// -\u003e Promise [\u003cvalue\u003e]\n// - value: expression string\n\n// [options]:\n// - from: default table\n// - limit: default maximum limit\n// - limits: table specific maximum limts\n```\n\n```javascript\n// 1. \nfunction fnA(text, type, hint, from) {\n  return ['sample1', 'sample1'];\n};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnA).then(console.log);\n// SELECT \"sample\", \"sample\" FROM \"sample\" WHERE TRUE AND TRUE\n\n\nfunction fnB(text, type, hint, from) {\n  if(type==='column') return ['name'];\n  return ['compositions'];\n};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnB).then(console.log);\n// SELECT \"name\", \"name\" FROM \"compositions\" WHERE TRUE AND TRUE\n\n\nfunction fnC(text, type, hint, from) {\n  if(type==='column') return ['ca', 'ca_e'];\n  return ['compositions'];\n};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnC).then(console.log);\n// SELECT \"ca\", \"ca_e\", \"ca\", \"ca_e\" FROM \"compositions\" WHERE TRUE AND TRUE\n\n\nvar columns = {\n  'food code': ['code'],\n  'food name': ['name'],\n  'calcium': ['ca', 'ca_e'],\n  'magnesium': ['mg', 'mg_e']\n};\nvar tables = ['food', 'compositions'];\nfunction fnD(text, type, hint, from) {\n  if(type==='column') return columns[text];\n  return tables.includes(text)? ['compositions']:[];\n};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnD).then(console.log);\n// SELECT \"name\", \"ca\", \"ca_e\" FROM \"null\" WHERE TRUE AND TRUE\n\n\nfunction fnE(text, type, hint, from) {\n  if(type==='column') return columns[text];\n  return tables.includes(text)? ['compositions']:[`\"tsvector\" @@ '${text}'`];\n};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnE).then(console.log);\n// SELECT \"name\", \"ca\", \"ca_e\" FROM \"null\" WHERE TRUE AND (FALSE OR (\"tsvector\" @@ 'apples'))\n\n\nvar options = {from: 'compositions'};\nslang(`SELECT \"food name\", \"calcium\" FROM \"apples\"`, fnE, null, options).then(console.log);\n// SELECT \"name\", \"ca\", \"ca_e\" FROM \"compositions\" WHERE TRUE AND (FALSE OR (\"tsvector\" @@ 'apples'))\n\n\n// PRIMARY USECASE\n// ---------------\nfunction fnDB(text, type, hint, from) {\n  return new Promise((resolve, reject) =\u003e {\n    // ...\n    // \u003cdo some database lookup\u003e\n    // ...\n  });\n};\nslang(/*  */, fnDB, null, options).then(console.log);\n// SELECT \"name\", \"ca\", \"ca_e\" FROM \"compositions\" WHERE TRUE AND (FALSE OR (\"tsvector\" @@ 'apples'))\n\n\n// NOTES\n// -----\n// 1. Map function return value can be an expression array\n// 2. For column, return multiple values to select multiple columns\n// 3. But in expressions, only first return value is considered\n// 4. Hints perform an operation on matching columns\n// 5. Use hint to decide which columns to return\n// 6. For table, returning expression will append to where\n// 7. Return expression and table name for full association\n// 8. Hint can be used in column text as \"\u003chint\u003e: \u003ccolumn text\u003e\"\n// 9. Hint \"all\": all|each|every\n// 10. Hint \"sum\": sum|gross|total|whole|aggregate\n// 11. Hint \"avg\": avg|mid|par|mean|norm|center|centre|average|midpoint\n// 12. Experiment! And mail me for issues / pull requests!\n```\n\n![](https://ga-beacon.deno.dev/G-RC63DPBH3P:SH3Eq-NoQ9mwgYeHWxu7cw/github.com/nodef/pg-slang)\n\n[SQL SELECT]: https://www.postgresql.org/docs/10/static/sql-select.html\n[pg-english]: https://www.npmjs.com/package/pg-english\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodef%2Fpg-slang","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodef%2Fpg-slang","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodef%2Fpg-slang/lists"}