{"_id":"@acarl005/lang-sql","name":"@acarl005/lang-sql","dist-tags":{"latest":"6.3.0"},"versions":{"6.3.0":{"name":"@acarl005/lang-sql","version":"6.3.0","description":"SQL language support for the CodeMirror code editor","scripts":{"test":"cm-runtests","prepare":"cm-buildhelper src/sql.ts"},"keywords":["editor","code"],"author":{"name":"Marijn Haverbeke","email":"marijnh@gmail.com","url":"http://marijnhaverbeke.nl"},"type":"module","main":"dist/index.cjs","exports":{"import":"./dist/index.js","require":"./dist/index.cjs"},"types":"dist/index.d.ts","module":"dist/index.js","sideEffects":false,"license":"MIT","dependencies":{"@codemirror/autocomplete":"^6.0.0","@lezer/highlight":"^1.0.0","@codemirror/language":"^6.0.0","@codemirror/state":"^6.0.0","@lezer/lr":"^1.0.0"},"devDependencies":{"@codemirror/buildhelper":"^0.1.5"},"repository":{"type":"git","url":"git+https://github.com/codemirror/lang-sql.git"},"gitHead":"500ea9c1c2e49a8753a1517280bde08a6b31e807","bugs":{"url":"https://github.com/codemirror/lang-sql/issues"},"homepage":"https://github.com/codemirror/lang-sql#readme","_id":"@acarl005/lang-sql@6.3.0","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-aRdQbmhwDPM60rVE97pE+H5D4pC9QhUEtdGdwsEk6k6DsklPpJEjpi5wda65JKV0JLRowv1rhzyDsK86uHbHtw==","shasum":"4ebb9681667e354c4424e562d1eaa4b960641ef3","tarball":"https://registry.npmjs.org/@acarl005/lang-sql/-/lang-sql-6.3.0.tgz","fileCount":8,"unpackedSize":103244,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFYptDzCDTUB+BX3nWQtc7t5uKy/OCBw7Z9Zq1hn8wcTAiEA7yb/iY7PGFegO4Fm7XJQ/sipJd/UP1VI9TZMc8r1dkc="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjKLNOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqpTA//fNxzSoie3Dvw9UtH1OBtapdhC994znLRCUkoY3W7+yf2thri\r\npFJCRAkQmdXsYu22AWukvjiT25Wb3icYeY98j4vVByePmPzrwT3ciasuQPK2\r\nUDSEVUKbvUjNUxKP8VsDN8JsS2hoywggvPPVQhvj2aJkYa1dCq+NV1mAOkvQ\r\nOCmIL23PVSuU38GQpeRyuRW/F4DCcBRcrq4cr5C04eyRe5vCrc/ghQz1y4io\r\nWKxQy1lpsHetRvNR7sAwBjb/lrEFp/TdqXX4ma0eXN2wtS9bgDG7LyV1BzrG\r\nVAi6D9QVwr6QNP6P+WlSwoLqGIgiteRNx0ZnErF6wEMLPMnY18eufL6JeVAt\r\n5gaCCB+RJn40Vpl4Y5I1p1N/HHTHznLPhjUqiLHOWis32cM2BTzBBQfLIIs6\r\ntBZXuy+qPLagbX+FXPrepU0RTi2+MuRtgHh4izar9kb0cpvH4Ib5E3VDjDzb\r\nT/FtpHh9/UoaadTfhREzll4hO1Awyzmi37IyyQc3MExgAsCkZ8AiC18PNT0T\r\n/vlk1kHMSX89JRrcimjOEqR0zkTkmSYMRQpjRd05xTd1jwWkfOUOOiTyQKGJ\r\njXzW+e15rrwOxGoGYQ6yylfbDxzTJmhuJJHQjk89LPzd1kjLRsiD/g6MFwBO\r\nXWK6ulA7OvkJ/yOTmWHfnYHmzJiUy3PuNnA=\r\n=k2rV\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"acarl005","email":"2yinyang2@gmail.com"},"directories":{},"maintainers":[{"name":"acarl005","email":"2yinyang2@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/lang-sql_6.3.0_1663611726141_0.22368296412487165"},"_hasShrinkwrap":false}},"time":{"created":"2022-09-19T18:22:06.140Z","6.3.0":"2022-09-19T18:22:06.413Z","modified":"2022-09-19T18:22:06.629Z"},"maintainers":[{"name":"acarl005","email":"2yinyang2@gmail.com"}],"description":"SQL language support for the CodeMirror code editor","homepage":"https://github.com/codemirror/lang-sql#readme","keywords":["editor","code"],"repository":{"type":"git","url":"git+https://github.com/codemirror/lang-sql.git"},"author":{"name":"Marijn Haverbeke","email":"marijnh@gmail.com","url":"http://marijnhaverbeke.nl"},"bugs":{"url":"https://github.com/codemirror/lang-sql/issues"},"license":"MIT","readme":"<!-- NOTE: README.md is generated from src/README.md -->\n\n# @codemirror/lang-sql [![NPM version](https://img.shields.io/npm/v/@codemirror/lang-sql.svg)](https://www.npmjs.org/package/@codemirror/lang-sql)\n\n[ [**WEBSITE**](https://codemirror.net/6/) | [**ISSUES**](https://github.com/codemirror/dev/issues) | [**FORUM**](https://discuss.codemirror.net/c/next/) | [**CHANGELOG**](https://github.com/codemirror/lang-sql/blob/main/CHANGELOG.md) ]\n\nThis package implements SQL language support for the\n[CodeMirror](https://codemirror.net/6/) code editor.\n\nThe [project page](https://codemirror.net/6/) has more information, a\nnumber of [examples](https://codemirror.net/6/examples/) and the\n[documentation](https://codemirror.net/6/docs/).\n\nThis code is released under an\n[MIT license](https://github.com/codemirror/lang-sql/tree/main/LICENSE).\n\nWe aim to be an inclusive, welcoming community. To make that explicit,\nwe have a [code of\nconduct](http://contributor-covenant.org/version/1/1/0/) that applies\nto communication around the project.\n\n## API Reference\n\n<dl>\n<dt id=\"user-content-sql\">\n  <code><strong><a href=\"#user-content-sql\">sql</a></strong>(<a id=\"user-content-sql^config\" href=\"#user-content-sql^config\">config</a>&#8288;?: <a href=\"#user-content-sqlconfig\">SQLConfig</a> = {}) → <a href=\"https://codemirror.net/docs/ref#language.LanguageSupport\">LanguageSupport</a></code></dt>\n\n<dd><p>SQL language support for the given SQL dialect, with keyword\ncompletion, and, if provided, schema-based completion as extra\nextensions.</p>\n</dd>\n<dt id=\"user-content-sqlconfig\">\n  <h4>\n    <code>interface</code>\n    <a href=\"#user-content-sqlconfig\">SQLConfig</a></h4>\n</dt>\n\n<dd><p>Options used to configure an SQL extension.</p>\n<dl><dt id=\"user-content-sqlconfig.dialect\">\n  <code><strong><a href=\"#user-content-sqlconfig.dialect\">dialect</a></strong>&#8288;?: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>The <a href=\"#user-content-sqldialect\">dialect</a> to use. Defaults to\n<a href=\"#user-content-standardsql\"><code>StandardSQL</code></a>.</p>\n</dd><dt id=\"user-content-sqlconfig.schema\">\n  <code><strong><a href=\"#user-content-sqlconfig.schema\">schema</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\">Object</a>&lt;readonly (<a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a> | <a href=\"https://codemirror.net/docs/ref#autocomplete.Completion\">Completion</a>)[]&gt;</code></dt>\n\n<dd><p>An object that maps table names, optionally prefixed with a\nschema name (<code>&quot;schema.table&quot;</code>) to options (columns) that can be\ncompleted for that table. Use lower-case names here.</p>\n</dd><dt id=\"user-content-sqlconfig.tables\">\n  <code><strong><a href=\"#user-content-sqlconfig.tables\">tables</a></strong>&#8288;?: readonly <a href=\"https://codemirror.net/docs/ref#autocomplete.Completion\">Completion</a>[]</code></dt>\n\n<dd><p>By default, the completions for the table names will be\ngenerated from the <code>schema</code> object. But if you want to\ncustomize them, you can pass an array of completions through\nthis option.</p>\n</dd><dt id=\"user-content-sqlconfig.defaulttable\">\n  <code><strong><a href=\"#user-content-sqlconfig.defaulttable\">defaultTable</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>When given, columns from the named table can be completed\ndirectly at the top level.</p>\n</dd><dt id=\"user-content-sqlconfig.defaultschema\">\n  <code><strong><a href=\"#user-content-sqlconfig.defaultschema\">defaultSchema</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>When given, tables prefixed with this schema name can be\ncompleted directly at the top level.</p>\n</dd><dt id=\"user-content-sqlconfig.uppercasekeywords\">\n  <code><strong><a href=\"#user-content-sqlconfig.uppercasekeywords\">upperCaseKeywords</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>When set to true, keyword completions will be upper-case.</p>\n</dd></dl>\n\n</dd>\n<dt id=\"user-content-sqldialect\">\n  <h4>\n    <code>class</code>\n    <a href=\"#user-content-sqldialect\">SQLDialect</a></h4>\n</dt>\n\n<dd><p>Represents an SQL dialect.</p>\n<dl><dt id=\"user-content-sqldialect.language\">\n  <code><strong><a href=\"#user-content-sqldialect.language\">language</a></strong>: <a href=\"https://codemirror.net/docs/ref#language.LRLanguage\">LRLanguage</a></code></dt>\n\n<dd><p>The language for this dialect.</p>\n</dd><dt id=\"user-content-sqldialect.extension\">\n  <code><strong><a href=\"#user-content-sqldialect.extension\">extension</a></strong>: <a href=\"https://codemirror.net/docs/ref#state.Extension\">Extension</a></code></dt>\n\n<dd><p>Returns the language for this dialect as an extension.</p>\n</dd><dt id=\"user-content-sqldialect^define\">\n  <code>static <strong><a href=\"#user-content-sqldialect^define\">define</a></strong>(<a id=\"user-content-sqldialect^define^spec\" href=\"#user-content-sqldialect^define^spec\">spec</a>: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object\">Object</a>) → <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>Define a new dialect.</p>\n<dl><dt id=\"user-content-sqldialect^define^spec\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec\">spec</a></strong></code></dt>\n\n<dd><dl><dt id=\"user-content-sqldialect^define^spec.keywords\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.keywords\">keywords</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>A space-separated list of keywords for the dialect.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.builtin\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.builtin\">builtin</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>A space-separated string of built-in identifiers for the dialect.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.types\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.types\">types</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>A space-separated string of type names for the dialect.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.backslashescapes\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.backslashescapes\">backslashEscapes</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>Controls whether regular strings allow backslash escapes.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.hashcomments\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.hashcomments\">hashComments</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>Controls whether # creates a line comment.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.slashcomments\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.slashcomments\">slashComments</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>Controls whether <code>//</code> creates a line comment.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.spaceafterdashes\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.spaceafterdashes\">spaceAfterDashes</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>When enabled <code>--</code> comments are only recognized when there's a\nspace after the dashes.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.doubledollarquotedstrings\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.doubledollarquotedstrings\">doubleDollarQuotedStrings</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>When enabled, things quoted with &quot;$&quot; are treated as\nstrings, rather than identifiers.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.doublequotedstrings\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.doublequotedstrings\">doubleQuotedStrings</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>When enabled, things quoted with double quotes are treated as\nstrings, rather than identifiers.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.charsetcasts\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.charsetcasts\">charSetCasts</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a></code></dt>\n\n<dd><p>Enables strings like <code>_utf8'str'</code> or <code>N'str'</code>.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.operatorchars\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.operatorchars\">operatorChars</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>The set of characters that make up operators. Defaults to\n<code>&quot;*+\\-%&lt;&gt;!=&amp;|~^/&quot;</code>.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.specialvar\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.specialvar\">specialVar</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>The set of characters that start a special variable name.\nDefaults to <code>&quot;?&quot;</code>.</p>\n</dd><dt id=\"user-content-sqldialect^define^spec.identifierquotes\">\n  <code><strong><a href=\"#user-content-sqldialect^define^spec.identifierquotes\">identifierQuotes</a></strong>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String\">string</a></code></dt>\n\n<dd><p>The characters that can be used to quote identifiers. Defaults\nto <code>&quot;\\&quot;&quot;</code>.</p>\n</dd></dl></dd></dl></dd></dl>\n\n</dd>\n<dt id=\"user-content-standardsql\">\n  <code><strong><a href=\"#user-content-standardsql\">StandardSQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>The standard SQL dialect.</p>\n</dd>\n<dt id=\"user-content-postgresql\">\n  <code><strong><a href=\"#user-content-postgresql\">PostgreSQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>Dialect for <a href=\"https://www.postgresql.org\">PostgreSQL</a>.</p>\n</dd>\n<dt id=\"user-content-mysql\">\n  <code><strong><a href=\"#user-content-mysql\">MySQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p><a href=\"https://dev.mysql.com/\">MySQL</a> dialect.</p>\n</dd>\n<dt id=\"user-content-mariasql\">\n  <code><strong><a href=\"#user-content-mariasql\">MariaSQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>Variant of <a href=\"#user-content-mysql\"><code>MySQL</code></a> for\n<a href=\"https://mariadb.org/\">MariaDB</a>.</p>\n</dd>\n<dt id=\"user-content-mssql\">\n  <code><strong><a href=\"#user-content-mssql\">MSSQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>SQL dialect for Microsoft <a href=\"https://www.microsoft.com/en-us/sql-server\">SQL\nServer</a>.</p>\n</dd>\n<dt id=\"user-content-sqlite\">\n  <code><strong><a href=\"#user-content-sqlite\">SQLite</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p><a href=\"https://sqlite.org/\">SQLite</a> dialect.</p>\n</dd>\n<dt id=\"user-content-cassandra\">\n  <code><strong><a href=\"#user-content-cassandra\">Cassandra</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p>Dialect for <a href=\"https://cassandra.apache.org/\">Cassandra</a>'s SQL-ish query language.</p>\n</dd>\n<dt id=\"user-content-plsql\">\n  <code><strong><a href=\"#user-content-plsql\">PLSQL</a></strong>: <a href=\"#user-content-sqldialect\">SQLDialect</a></code></dt>\n\n<dd><p><a href=\"https://en.wikipedia.org/wiki/PL/SQL\">PL/SQL</a> dialect.</p>\n</dd>\n<dt id=\"user-content-keywordcompletionsource\">\n  <code><strong><a href=\"#user-content-keywordcompletionsource\">keywordCompletionSource</a></strong>(<a id=\"user-content-keywordcompletionsource^dialect\" href=\"#user-content-keywordcompletionsource^dialect\">dialect</a>: <a href=\"#user-content-sqldialect\">SQLDialect</a>, <a id=\"user-content-keywordcompletionsource^uppercase\" href=\"#user-content-keywordcompletionsource^uppercase\">upperCase</a>&#8288;?: <a href=\"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean\">boolean</a> = false) → <a href=\"https://codemirror.net/docs/ref#autocomplete.CompletionSource\">CompletionSource</a></code></dt>\n\n<dd><p>Returns a completion source that provides keyword completion for\nthe given SQL dialect.</p>\n</dd>\n<dt id=\"user-content-schemacompletionsource\">\n  <code><strong><a href=\"#user-content-schemacompletionsource\">schemaCompletionSource</a></strong>(<a id=\"user-content-schemacompletionsource^config\" href=\"#user-content-schemacompletionsource^config\">config</a>: <a href=\"#user-content-sqlconfig\">SQLConfig</a>) → <a href=\"https://codemirror.net/docs/ref#autocomplete.CompletionSource\">CompletionSource</a></code></dt>\n\n<dd><p>Returns a completion sources that provides schema-based completion\nfor the given configuration.</p>\n</dd>\n</dl>\n","readmeFilename":"README.md"}