Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

fix: positional params #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
psteinroe merged 6 commits into main from fix/positional-params
Aug 17, 2025
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/pgt_lexer/src/lexer.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ impl<'a> Lexer<'a> {
pgt_tokenizer::TokenKind::Tilde => SyntaxKind::TILDE,
pgt_tokenizer::TokenKind::Question => SyntaxKind::QUESTION,
pgt_tokenizer::TokenKind::Colon => SyntaxKind::COLON,
pgt_tokenizer::TokenKind::DoubleColon => SyntaxKind::DOUBLE_COLON,
pgt_tokenizer::TokenKind::Eq => SyntaxKind::EQ,
pgt_tokenizer::TokenKind::Bang => SyntaxKind::BANG,
pgt_tokenizer::TokenKind::Lt => SyntaxKind::L_ANGLE,
Expand Down
1 change: 1 addition & 0 deletions crates/pgt_lexer_codegen/src/syntax_kind.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ const PUNCT: &[(&str, &str)] = &[
("_", "UNDERSCORE"),
(".", "DOT"),
(":", "COLON"),
("::", "DOUBLE_COLON"),
("=", "EQ"),
("!", "BANG"),
("-", "MINUS"),
Expand Down
70 changes: 46 additions & 24 deletions crates/pgt_tokenizer/src/lib.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,32 +144,37 @@ impl Cursor<'_> {
}
}
':' => {
// Named parameters in psql with different substitution styles.
//
// https://www.postgresql.org/docs/current/app-psql.html#APP-PSQL-INTERPOLATION
match self.first() {
'\'' => {
// Named parameter with colon prefix and single quotes.
self.bump();
let terminated = self.single_quoted_string();
let kind = NamedParamKind::ColonString { terminated };
TokenKind::NamedParam { kind }
}
'"' => {
// Named parameter with colon prefix and double quotes.
self.bump();
let terminated = self.double_quoted_string();
let kind = NamedParamKind::ColonIdentifier { terminated };
TokenKind::NamedParam { kind }
}
c if is_ident_start(c) => {
// Named parameter with colon prefix.
self.eat_while(is_ident_cont);
TokenKind::NamedParam {
kind: NamedParamKind::ColonRaw,
if self.first() == ':' {
self.bump();
TokenKind::DoubleColon
} else {
// Named parameters in psql with different substitution styles.
//
// https://www.postgresql.org/docs/current/app-psql.html#APP-PSQL-INTERPOLATION
match self.first() {
'\'' => {
// Named parameter with colon prefix and single quotes.
self.bump();
let terminated = self.single_quoted_string();
let kind = NamedParamKind::ColonString { terminated };
TokenKind::NamedParam { kind }
}
'"' => {
// Named parameter with colon prefix and double quotes.
self.bump();
let terminated = self.double_quoted_string();
let kind = NamedParamKind::ColonIdentifier { terminated };
TokenKind::NamedParam { kind }
}
c if is_ident_start(c) => {
// Named parameter with colon prefix.
self.eat_while(is_ident_cont);
TokenKind::NamedParam {
kind: NamedParamKind::ColonRaw,
}
}
_ => TokenKind::Colon,
}
_ => TokenKind::Colon,
}
}
// One-symbol tokens.
Expand Down Expand Up @@ -664,6 +669,23 @@ mod tests {
assert_debug_snapshot!(result);
}

#[test]
fn debug_simple_cast() {
let result = lex("::test");
assert_debug_snapshot!(result, @r###"
[
"::" @ DoubleColon,
"test" @ Ident,
]
"###);
}

#[test]
fn named_param_colon_raw_vs_cast() {
let result = lex("select 1 from c where id::test = :id;");
assert_debug_snapshot!(result);
}

#[test]
fn named_param_colon_string() {
let result = lex("select 1 from c where id = :'id';");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
source: crates/pgt_tokenizer/src/lib.rs
expression: result
snapshot_kind: text
---
[
"select" @ Ident,
" " @ Space,
"1" @ Literal { kind: Int { base: Decimal, empty_int: false } },
" " @ Space,
"from" @ Ident,
" " @ Space,
"c" @ Ident,
" " @ Space,
"where" @ Ident,
" " @ Space,
"id" @ Ident,
"::" @ DoubleColon,
"test" @ Ident,
" " @ Space,
"=" @ Eq,
" " @ Space,
":id" @ NamedParam { kind: ColonRaw },
";" @ Semi,
]
2 changes: 2 additions & 0 deletions crates/pgt_tokenizer/src/token.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ pub enum TokenKind {
Minus,
/// `:`
Colon,
/// `::`
DoubleColon,
/// `.`
Dot,
/// `=`
Expand Down
1 change: 1 addition & 0 deletions crates/pgt_workspace/Cargo.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ pgt_schema_cache = { workspace = true }
pgt_statement_splitter = { workspace = true }
pgt_suppressions = { workspace = true }
pgt_text_size.workspace = true
pgt_tokenizer = { workspace = true }
pgt_typecheck = { workspace = true }
pgt_workspace_macros = { workspace = true }
rustc-hash = { workspace = true }
Expand Down
5 changes: 2 additions & 3 deletions crates/pgt_workspace/src/workspace/server.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ use document::{
TypecheckDiagnosticsMapper,
};
use futures::{StreamExt, stream};
use pg_query::convert_to_positional_params;
use pgt_analyse::{AnalyserOptions, AnalysisFilter};
use pgt_analyser::{Analyser, AnalyserConfig, AnalyserParams};
use pgt_diagnostics::{
Expand Down Expand Up @@ -468,7 +469,7 @@ impl Workspace for WorkspaceServer {
// Type checking
let typecheck_result = pgt_typecheck::check_sql(TypecheckParams {
conn: &pool,
sql: id.content(),
sql: convert_to_positional_params(id.content()).as_str(),
ast: &ast,
tree: &cst,
schema_cache: schema_cache.as_ref(),
Expand Down Expand Up @@ -511,8 +512,6 @@ impl Workspace for WorkspaceServer {
.await
.unwrap_or_else(|_| vec![]);

println!("{:#?}", plpgsql_check_results);

for d in plpgsql_check_results {
let r = d.span.map(|span| span + range.start());
diagnostics.push(
Expand Down
54 changes: 54 additions & 0 deletions crates/pgt_workspace/src/workspace/server.tests.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,3 +277,57 @@ async fn test_dedupe_diagnostics(test_db: PgPool) {
Some(TextRange::new(115.into(), 210.into()))
);
}

#[sqlx::test(migrator = "pgt_test_utils::MIGRATIONS")]
async fn test_positional_params(test_db: PgPool) {
let mut conf = PartialConfiguration::init();
conf.merge_with(PartialConfiguration {
db: Some(PartialDatabaseConfiguration {
database: Some(
test_db
.connect_options()
.get_database()
.unwrap()
.to_string(),
),
..Default::default()
}),
..Default::default()
});

let workspace = get_test_workspace(Some(conf)).expect("Unable to create test workspace");

let path = PgTPath::new("test.sql");

let setup_sql = r"
create table users (
id serial primary key,
name text not null,
email text not null
);
";
test_db.execute(setup_sql).await.expect("setup sql failed");

let content = r#"select * from users where id = @one and name = :two and email = :'three';"#;
Copy link
Collaborator

@juleswritescode juleswritescode Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:'three' – i want to meet the person who writes syntax like this haha

Copy link
Collaborator Author

@psteinroe psteinroe Aug 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haha yeah I did for some time two years ago :D


workspace
.open_file(OpenFileParams {
path: path.clone(),
content: content.into(),
version: 1,
})
.expect("Unable to open test file");

let diagnostics = workspace
.pull_diagnostics(crate::workspace::PullDiagnosticsParams {
path: path.clone(),
categories: RuleCategories::all(),
max_diagnostics: 100,
only: vec![],
skip: vec![],
})
.expect("Unable to pull diagnostics")
.diagnostics;

assert_eq!(diagnostics.len(), 0, "Expected no diagnostic");
}
53 changes: 52 additions & 1 deletion crates/pgt_workspace/src/workspace/server/pg_query.rs
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use std::sync::{Arc, Mutex};
use lru::LruCache;
use pgt_query_ext::diagnostics::*;
use pgt_text_size::TextRange;
use pgt_tokenizer::tokenize;

use super::statement_identifier::StatementId;

Expand Down Expand Up @@ -37,7 +38,7 @@ impl PgQueryStore {
}

let r = Arc::new(
pgt_query::parse(statement.content())
pgt_query::parse(&convert_to_positional_params(statement.content()))
.map_err(SyntaxDiagnostic::from)
.and_then(|ast| {
ast.into_root().ok_or_else(|| {
Expand Down Expand Up @@ -87,10 +88,60 @@ impl PgQueryStore {
}
}

/// Converts named parameters in a SQL query string to positional parameters.
///
/// This function scans the input SQL string for named parameters (e.g., `@param`, `:param`, `:'param'`)
/// and replaces them with positional parameters (e.g., `1ドル`, `2ドル`, etc.).
///
/// It maintains the original spacing of the named parameters in the output string.
///
/// Useful for preparing SQL queries for parsing or execution where named paramters are not supported.
pub fn convert_to_positional_params(text: &str) -> String {
let mut result = String::new();
let mut param_index = 1;
let mut position = 0;

for token in tokenize(text) {
let token_len = token.len as usize;
let token_text = &text[position..position + token_len];

if matches!(token.kind, pgt_tokenizer::TokenKind::NamedParam { .. }) {
let replacement = format!("${}", param_index);
let original_len = token_text.len();
let replacement_len = replacement.len();

result.push_str(&replacement);

// maintain original spacing
if replacement_len < original_len {
result.push_str(&" ".repeat(original_len - replacement_len));
}

param_index += 1;
} else {
result.push_str(token_text);
}

position += token_len;
}

result
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_convert_to_positional_params() {
let input = "select * from users where id = @one and name = :two and email = :'three';";
let result = convert_to_positional_params(input);
assert_eq!(
result,
"select * from users where id = 1ドル and name = 2ドル and email = 3ドル ;"
);
}

#[test]
fn test_plpgsql_syntax_error() {
let input = "
Expand Down

AltStyle によって変換されたページ (->オリジナル) /