diff --git a/.gitmodules b/.gitmodules index 7d8100d7e7..b4938ab392 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1148,6 +1148,9 @@ [submodule "vendor/grammars/sublimetext-nasl"] path = vendor/grammars/sublimetext-nasl url = https://github.com/tenable/sublimetext-nasl +[submodule "vendor/grammars/surrealql-grammar"] + path = vendor/grammars/surrealql-grammar + url = https://github.com/surrealdb/surrealql-grammar.git [submodule "vendor/grammars/svelte-atom"] path = vendor/grammars/svelte-atom url = https://github.com/sebastinez/svelte-atom.git diff --git a/grammars.yml b/grammars.yml index 92a49b2d31..7d354ab8e6 100644 --- a/grammars.yml +++ b/grammars.yml @@ -1031,6 +1031,9 @@ vendor/grammars/sublimetext-cuda-cpp: vendor/grammars/sublimetext-nasl: - source.nasl - source.tnsaudit +vendor/grammars/surrealql-grammar: +- inline.surrealql-js-literal +- source.surrealql vendor/grammars/svelte-atom: - source.svelte vendor/grammars/sway-vscode-plugin: diff --git a/lib/linguist/languages.yml b/lib/linguist/languages.yml index 3441a3f316..6ab61ce624 100644 --- a/lib/linguist/languages.yml +++ b/lib/linguist/languages.yml @@ -6842,6 +6842,16 @@ SuperCollider: tm_scope: source.supercollider ace_mode: text language_id: 361 +SurrealQL: + type: programming + color: "#ff00a0" + aliases: + - surql + extensions: + - ".surql" + ace_mode: text + tm_scope: source.surrealql + language_id: 735141027 Svelte: type: markup color: "#ff3e00" diff --git a/samples/SurrealQL/aggregate-view.surql b/samples/SurrealQL/aggregate-view.surql new file mode 100644 index 0000000000..649f78a81d --- /dev/null +++ b/samples/SurrealQL/aggregate-view.surql @@ -0,0 +1,20 @@ +-- Drop all writes to the reading table. We don't need every reading. +DEFINE TABLE reading DROP; + +-- Define a table as a view which aggregates data from the reading table +DEFINE TABLE temperatures_by_month AS + SELECT + count() AS total, + time::month(recorded_at) AS month, + math::mean(temperature) AS average_temp + FROM reading + GROUP BY city +; + +-- Add a new temperature reading with some basic attributes +CREATE reading SET + temperature = 27.4, + recorded_at = time::now(), + city = 'London', + location = (-0.118092, 51.509865) +; \ No newline at end of file diff --git a/samples/SurrealQL/expressions.surql b/samples/SurrealQL/expressions.surql new file mode 100644 index 0000000000..3e5cf681fb --- /dev/null +++ b/samples/SurrealQL/expressions.surql @@ -0,0 +1,14 @@ +-- Select a nested array, and filter based on an attribute +SELECT emails[WHERE active = true] FROM person; + +-- Select all 1st, 2nd, and 3rd level people who this specific person record knows, or likes, as separate outputs +SELECT ->knows->(? AS f1)->knows->(? AS f2)->(knows, likes AS e3 WHERE influencer = true)->(? AS f3) FROM person:tobie; + +-- Select all person records (and their recipients), who have sent more than 5 emails +SELECT *, ->sent->email->to->person FROM person WHERE count(->sent->email) > 5; + +-- Select other products purchased by people who purchased this laptop +SELECT <-purchased<-person->purchased->product FROM product:laptop; + +-- Select products purchased by people in the last 3 weeks who have purchased the same products that we purchased +SELECT ->purchased->product<-purchased<-person->(purchased WHERE created_at > time::now() - 3w)->product FROM person:tobie; \ No newline at end of file diff --git a/samples/SurrealQL/schema.surql b/samples/SurrealQL/schema.surql new file mode 100644 index 0000000000..46e599798c --- /dev/null +++ b/samples/SurrealQL/schema.surql @@ -0,0 +1,10 @@ +-- Specify a field on the user table +DEFINE FIELD email ON TABLE user TYPE string ASSERT string::is::email($value); + +-- Add a unique index on the email field to prevent duplicate values +DEFINE INDEX email ON TABLE user COLUMNS email UNIQUE; + +-- Create a new event whenever a user changes their email address +DEFINE EVENT email ON TABLE user WHEN $before.email != $after.email THEN ( + CREATE event SET user = $this, time = time::now(), value = $after.email, action = 'email_changed' +); \ No newline at end of file diff --git a/test/test_language.rb b/test/test_language.rb index 0f781beeb0..4d963e0add 100644 --- a/test/test_language.rb +++ b/test/test_language.rb @@ -58,6 +58,8 @@ def test_find_by_alias assert_equal Language['Shell'], Language.find_by_alias('sh') assert_equal Language['Shell'], Language.find_by_alias('shell') assert_equal Language['Shell'], Language.find_by_alias('zsh') + assert_equal Language['SurrealQL'], Language.find_by_alias('surql') + assert_equal Language['SurrealQL'], Language.find_by_alias('surrealql') assert_equal Language['SuperCollider'], Language.find_by_alias('supercollider') assert_equal Language['TeX'], Language.find_by_alias('tex') assert_equal Language['TypeScript'], Language.find_by_alias('ts') diff --git a/vendor/README.md b/vendor/README.md index 62c31c6228..530bd3387a 100644 --- a/vendor/README.md +++ b/vendor/README.md @@ -536,6 +536,7 @@ This is a list of grammars that Linguist selects to provide syntax highlighting - **SubRip Text:** [Alhadis/language-subtitles](https://github.com/Alhadis/language-subtitles) - **SugarSS:** [hudochenkov/Syntax-highlighting-for-PostCSS](https://github.com/hudochenkov/Syntax-highlighting-for-PostCSS) - **SuperCollider:** [supercollider/language-supercollider](https://github.com/supercollider/language-supercollider) +- **SurrealQL:** [surrealdb/surrealql-grammar](https://github.com/surrealdb/surrealql-grammar) - **Svelte:** [sebastinez/svelte-atom](https://github.com/sebastinez/svelte-atom) - **Sway:** [FuelLabs/sway-vscode-plugin](https://github.com/FuelLabs/sway-vscode-plugin) - **Sweave:** [textmate/sweave.tmbundle](https://github.com/textmate/sweave.tmbundle) diff --git a/vendor/grammars/surrealql-grammar b/vendor/grammars/surrealql-grammar new file mode 160000 index 0000000000..68b1c5c15f --- /dev/null +++ b/vendor/grammars/surrealql-grammar @@ -0,0 +1 @@ +Subproject commit 68b1c5c15fd2a769874923a1d5e1973c110afaec diff --git a/vendor/licenses/git_submodule/surrealql-grammar.dep.yml b/vendor/licenses/git_submodule/surrealql-grammar.dep.yml new file mode 100644 index 0000000000..b85592398d --- /dev/null +++ b/vendor/licenses/git_submodule/surrealql-grammar.dep.yml @@ -0,0 +1,211 @@ +--- +name: surrealql-grammar +version: 68b1c5c15fd2a769874923a1d5e1973c110afaec +type: git_submodule +homepage: https://github.com/surrealdb/surrealql-grammar.git +license: apache-2.0 +licenses: +- sources: LICENSE + text: |2- + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright © 2023 SurrealDB Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +notices: []