barklan/inline_sql_syntax

Highlight and lint inline SQL strings.

Inline SQL

Also available in Open VSX Registry

Highlight and lint inline SQL strings. Supported languages are Python, Go, JavaScript, TypeScript, Ruby, Java, C#, Rust, PHP, Lua.

Syntax highlighting works for strings starting with --sql or any of the SELECT, INSERT, INTO, DELETE, UPDATE, CREATE TABLE.

Also works with ES6 Template Strings:

const query = sql`
    select * from book;
`;

Linting and diagnostics powered entirely by awesome joereynolds/sql-lint and works for multiline strings that start with either `--sql (backtick followed by --sql), "--sql or """--sql.

Contributors

jwhitaker-swiftnav

Connor Bren

Ferenc Tamás

Gunnar Sv Sigurbjörnsson

Jon Wolfe

Titouan CREACH

Safety

The proper way to sanitize data for insertion into your database is to use placeholders for all variables to be inserted into your SQL strings. In other words, NEVER do this (Python example):

query = f"INSERT INTO foo (bar, baz) VALUES ( {variable1}, {variable2} )";

Instead, use $ placeholders (or ? in some databases):

query = "INSERT INTO foo (bar, baz) VALUES ( $1, $2  )";

And then pass the variables to be replaced when you execute the query. For example with pgx (Go example):

err = conn.QueryRow(
    context.Background(),
    "select name, weight from widgets where id=$1",
    42,
).Scan(&name, &weight)

Integration with real database

Integration with real database is available and controlled through VSCode options:

{
    "inlineSQL.enableDBIntegration": true,
    "inlineSQL.dbDriver": "postgres",
    "inlineSQL.dbHost": "localhost",
    "inlineSQL.dbPort": 5432,
    "inlineSQL.dbUser": "postgres",
    "inlineSQL.dbPassword": "postgres"
}

Examples

Python

JavaScript/TypeScript

Go

Python	JavaScript/TypeScript

Ruby	Java

Limitations

Semantic highlighting

Highlighting does not work with semantic token highlighting enabled (feature provided by some LSP servers).

Currently gopls semantic token highlighting (option gopls.ui.semanticTokens - off by default) overrides extension's syntax.

gopls

{
    "gopls.ui.semanticTokens": false
}

rust-analyzer

{
    "rust-analyzer.highlighting.strings": false
}

C#

{
    "csharp.semanticHighlighting.enabled": false
}

Motivation

This small extension is meant to help those who don't use ORM and don't like SQL builders like squirrel, but still want inline sql in their code to be something more than magic strings, helping to avoid small bugs and typos almost instantly.

Related

• joereynolds/sql-lint - Used for linting.
• joe-re/sql-language-server - SQL Language Server, consider it if you use separate files for sql.
• cmoog/vscode-sql-notebook - Open SQL files as VSCode Notebooks.
• pushqrdx/vscode-inline-html - ES6 Template Strings inline HTML.

inline_sql_syntax's Issues

add rust and c++ language support?

Add support for single quotes `'` (for javascript/typescript)

When using single quotes syntax highlighting doesn’t work for me.
It would be great if that would be supported.

Can't connect to DB

I have put my database credentials in the settings.json, but it does not seem to connect to my database. Is there any Log?

Code folding feature support for inline SQLs

Hi, Team,

Currently inline SQL helps me a lot on writing codes with SQLs.

Recently I find that in VSCode, a pure SQL script supports code folding for a long SQL statement.

So maybe this extension can be enhanced to have SQL code folding feature, too.

It would be a super-helpful feature.

Best Regards.

Feature request: Ignore leading whitespace for SQL detection

In our code, our queries often look like this:

const query = {
	text: `
		SELECT id
		FROM my_neat_table
...

The leading whitespace is helpful for keeping the queries aligned and tidy. Unfortunately, it also prevents the extension from detecting SQL. I recognize that I can use --sql at the beginning of the query but not everyone uses this extension. My request is to use trimStart() before checking the beginning of the string constant for a matching keyword.

Connecting to a SQLite database

Hi,

thank you for creating this project!

I wanted to ask if it is possible to connect it to a sqlite file, and if yes what I would have to enter in my settings.json.

Thanks!

sql-lint has no ability to specify database (uses default one)

SQL errors are not cleared out upon save

Using Visual Studio Code 1.73.1

Using

• enableDBIntegration = true
• dbDriver = mysql
• lintSQLFiles = true

Create an .sql file in VS Code, enter a invalid SQL select query and hit Ctrl+S: the plugin warns about an SQL error.
So far so good.

Now, correct the SQL error and hit Ctrl+S again: the red underline does not go away and the error stays.
Close the .sql file and open it back: the error has disappeared.

The extension always seems to display the latest error even when the SQL syntax indeed is valid.

Explore tighter pg integration using node-postgres client

• https://node-postgres.com/
• postgres EXPLAIN keyword docs

Query for strings using text mate

Ideally text mate should be leveraged to extract document ranges where there are strings analogous to how neovim/treesitter extensions work.

Possibly with this
https://github.com/Microsoft/vscode-textmate

[feat request] support highlight `CREATE INDEX IF NOT EXISTS`

let sql = `CREATE INDEX IF NOT EXISTS index_id ON article (id)`;

Extension causes high cpu load

• Issue Type: Performance
• Extension Name: inline-sql-syntax
• Extension Version: 2.15.0
• OS Version: Windows_NT x64 10.0.22621
• VS Code version: 1.70.1

⚠️ Make sure to attach this file from your home-directory:
⚠️file:///c%3A/Users/Advice/AppData/Local/Temp/qufiwefefwoyn.inline-sql-syntax-unresponsive.cpuprofile.txt

Find more details here: https://github.com/microsoft/vscode/wiki/Explain-extension-causes-high-cpu-load

Support for strings starting with "-- sql"

Assuming Ruby (on Rails, with ActiveRecord) and MySQL/MariaDB - these databases require a space after "--" in a comment.

Example

# valid MySQL/MariaDB query
queryA = Model.where("value=1").select("
-- sql
valueA AS A,
valueB AS B
")

# not valid MySQL/MariaDB query :(
queryB = Model.where("value=1").select("
--sql
valueA AS A,
valueB AS B
")

Current behaviour

In queryA: SQL is not highlighted.

In queryB: SQL is highlighted but it's not valid MySQL/MariaDB query.

Expected behaviour

Both queries should have highlighted SQL.

Support for YAML

Like yaml-string-sql, purpose possibility to parse SQL in YAML.

Example:

Single request

   data: |
          --sql
          SELECT * FROM test;

Multiple requests

   data: |
          --sql-start
          SELECT * FROM test;
          SELECT COUNT(*) from test_2;
          --sql-end

Workflow that publishes releases to GitHub releases

Enhanced auto-syntax highlighting

Currently, the extension automatically detects strings starting with certain words as sql syntax but this wouldn't work if the string first starts with tabs, spaces, and line breaks and then has those words. It'd be great if it could skip whitespace characters and check the first valid word for syntax highlighting.

Feature request: Mark a SQL syntax with `/* sql */` and `sql` comment tag in JS

So instead of:

const query = `--sql SELECT * FROM table`;

We can write this (to be more consistent with the rest of inline extensions):

const query = /* sql */`SELECT * FROM table`;
const html  = /* html */`<div id="root"></div>`;

or:

const query   = sql`SELECT * FROM table`;
const html    = html`<div id="root"></div>`
const graphql = gql`query { testConnection }`;

Add contributors to readme

Python single-quote multiline strings not recognized

I can't get the extension to highlight SQL code inside multiline strings delimited with single quotes in Python files:

MySQL dbDriver: is it possible to automatically select a database in settings.json?

With the MySQL driver, one must explicitly specify the database name in queries, eg.

SELECT name FROM mydatabase.customer

where 'mydatabase' is the name of the database.
This is really annoying - would it be possible to have the extension automatically use a specified database? So that it would just be sufficient to type

SELECT name FROM customer

Thanks.

test: explore the possibility of automated tests (mocha?)

Release workflow (github actions) on commit to main

Manually create GitHub workflow for releases.

SQL Strings with "ALTER TABLE" are not highlighted

When trying to type

"ALTER TABLE table_name ADD COLUMN column_name datatype"

the extension does not highlight the SQL string

Do not report the whole file as a problem when linting SQL files

Auto-keyword based highlighting doesn't seem to work in golang

Example:

Thanks for publishing this!

Add pre-commit ci checks

Diagnostics do not work for PHP multiline strings.

Related #13

test c++ support

SQL capture group highlight correctness

(--sql)|SELECT |INSERT INTO |DELETE |UPDATE |CREATE TABLE)

These should be in diffferent rules - --sql should be comment.sql, the rest should be keyword (probably).

Inline queries formatting

Thank you for the extension!
I'm wondering, is it possible to add support to format inline queries?

Extension randomly popped up a message that just says "fuck!"

I'm not joking

Extension Hasn't Been Updated on OpenVSX

I noticed that that the extension is still at v2.10.3. Can this be updated? It might also help if this process is automated via GitHub actions.

https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#github-action

wrong csharp language identifier

cs instead of csharp

feat: logging output

Right now it does not have output destination to log to.

Extension causes high cpu load

• Issue Type: Performance
• Extension Name: inline-sql-syntax
• Extension Version: 2.15.0
• OS Version: Windows_NT x64 10.0.19044
• VS Code version: 1.71.0

⚠️ Make sure to attach this file from your home-directory:
⚠️[Uploading qufiwefefwoyn.inline-sql-syntax-unresponsive.cpuprofile.txt…]()

Find more details here: https://github.com/microsoft/vscode/wiki/Explain-extension-causes-high-cpu-load

Language-specific syntaxes should be considered separate grammars

... in separate files. Right now this applies only to Rust.

Support for PHP

In php files multi line sql is often written as

  $query = <<<SQL
      SELECT * FROM FOO WHERE FOO.bar = '1'
  SQL;

Support Python f-string

It's impossible to parse Python f-strings for the moment:

✅

❌

It would be very practical to add this possibility 🙏

Semicolumn in string in SQL can end the query and raise "Unmatched parentheses" error

Something like :

SELECT series_id, GROUP_CONCAT(auth_name SEPARATOR '; ') AS auths
FROM Authors
NATURAL JOIN `Series-Authors`
GROUP BY series_id

will be considered an "Unmatched parentheses" error with red squiggles everywhere because the semicolumn ; used as a separator here is considered the end of the query, which causes the closing parenthesis to be in 'another' query.

I'm working in python 3.10, inline sql syntax 2.16.0.

Postgres does no analysis on queries without closing semicolon.

Publish to open VSX Registry

Syntax highliting for individual queries in multiline strings (abstracted from language-specific strings)

Example:

query = """
    SELECT * FROM book;
    SELECT id FROM user;
"""

Two queries should be highlighted separately (starting token is SELECT , ending is semicolon (;).

The thing I'm worried about here is false positives like this one:

query = """
    THIS IS SOME CAPS TEXT. WHO KNOWS WHY IT'S CAPS, but the next line is highlighted as SQL.
    SELECT COMMITTEE .. SOME GIBBERISH FROM SOMETHING. 
"""

.

.

Automated syntax tests using vscode.dev and selenium (or cypress?)

Explore if python's docstring delimiter rule is redundant

...and probably covered in all cases by just "--sql (one double quote).

Add examples of all supported languages to test data

vscode-tmgrammar-test can be used to test. Example: vscode-scala-syntax

bash shell script heredoc inline SQL support

Hi, Team,

Thanks for your great extension, it helps me a lot😊.

I hope to know whether it is possible to support heredoc SQLs in bash shell script.

Heredoc is a way to pass multiple line SQLs to RDBMS client tools (PostgreSQL psql, MySQL mysql, Oracle sqlplus, etc.) inside shell scripts.

If SQL syntax highlighting can also be supported in shell script heredoc, more people can get benefit from it.

A postgres psql example likes below.

#!/bin/bash
psql -v ON_ERROR_STOP=1 -AqtX <<EOF
--sql
BEGIN;
SELECT * FROM table_1;
INSERT INTO table_2 VALUES (1,'hello');
COMMIT;
EOF

Best Regards.

Explore style linting and formatting

Related #2.

• Play with sqlint API (only CLI is documented).

Erroneous detection of -- as comment (breaks golang code completion)

The -- in the referenced line is detected as the start of an SQL comment inside a golang annotation string which effectively swallows the closing ". This breaks the golang source interpretation, flagging large parts of the source as string.

Offending line:
https://github.com/immune-gmbh/agent/blob/v3.8.10/cmd/main.go#L73