Skip to content

ide: code completion for schemas #858

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.

Sign up for GitHub

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
kodiakhq merged 1 commit into from
Jan 18, 2026
Merged

ide: code completion for schemas #858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 8 additions & 2 deletions crates/squawk_ide/src/binder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,21 @@ impl Binder {
&self.search_path_changes[0].search_path
}

pub(crate) fn all_symbols_by_kind(&self, kind: SymbolKind) -> Vec<&Name> {
pub(crate) fn all_symbols_by_kind(
&self,
kind: SymbolKind,
schema: Option<&Schema>,
) -> Vec<&Name> {
let root_scope = self.root_scope();
let scope = &self.scopes[root_scope];

let mut names = vec![];
for (name, symbol_ids) in &scope.entries {
for symbol_id in symbol_ids {
let symbol = &self.symbols[*symbol_id];
if symbol.kind == kind {
if symbol.kind == kind
&& schema.is_none_or(|schema| symbol.schema.as_ref() == Some(schema))
{
names.push(name);
break;
}
Expand Down
228 changes: 138 additions & 90 deletions crates/squawk_ide/src/completion.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
use rowan::TextSize;
use squawk_syntax::ast::{self, AstNode};
use squawk_syntax::{SyntaxKind, SyntaxToken};
use std::collections::HashSet;

use crate::binder;
use crate::resolve;
use crate::symbols::SymbolKind;
use crate::symbols::{Name, Schema, SymbolKind};
use crate::tokens::is_string_or_comment;

pub fn completion(file: &ast::SourceFile, offset: TextSize) -> Vec<CompletionItem> {
let Some(token) = token_at_offset(file, offset) else {
// empty file
return default_completions(true);
return default_completions();
};
// We don't support completions inside comments since we don't have doc
// comments a la JSDoc.
Expand All @@ -19,33 +20,34 @@ pub fn completion(file: &ast::SourceFile, offset: TextSize) -> Vec<CompletionIte
return vec![];
}

let binder = binder::bind(file);
match completion_context(token) {
CompletionContext::TableOnly => table_completions(&binder),
CompletionContext::Default(is_nested) => default_completions(!is_nested),
match completion_context(&token) {
CompletionContext::TableOnly => table_completions(file, &token),
CompletionContext::Default => default_completions(),
CompletionContext::SelectClause(select_clause) => {
select_completions(binder, file, select_clause)
select_completions(file, select_clause, &token)
}
}
}

fn select_completions(
binder: binder::Binder,
file: &ast::SourceFile,
select_clause: ast::SelectClause,
token: &SyntaxToken,
) -> Vec<CompletionItem> {
let binder = binder::bind(file);
let mut completions = vec![];
let functions = binder.all_symbols_by_kind(SymbolKind::Function);
let schema = schema_qualifier_at_token(token);
let functions = binder.all_symbols_by_kind(SymbolKind::Function, schema.as_ref());
completions.extend(functions.into_iter().map(|name| CompletionItem {
label: name.to_string(),
label: format!("{name}()"),
kind: CompletionItemKind::Function,
detail: None,
insert_text: None,
insert_text_format: None,
trigger_completion_after_insert: false,
}));

let tables = binder.all_symbols_by_kind(SymbolKind::Table);
let tables = binder.all_symbols_by_kind(SymbolKind::Table, schema.as_ref());
completions.extend(tables.into_iter().map(|name| CompletionItem {
label: name.to_string(),
kind: CompletionItemKind::Table,
Expand All @@ -55,6 +57,10 @@ fn select_completions(
trigger_completion_after_insert: false,
}));

if schema.is_none() {
completions.extend(schema_completions(&binder));
}

if let Some(parent) = select_clause.syntax().parent()
&& let Some(select) = ast::Select::cast(parent)
&& let Some(from_clause) = select.from_clause()
Expand Down Expand Up @@ -84,10 +90,32 @@ fn select_completions(
return completions;
}

fn table_completions(binder: &binder::Binder) -> Vec<CompletionItem> {
fn schema_completions(binder: &binder::Binder) -> Vec<CompletionItem> {
let default_schemas =
["public", "pg_temp", "pg_catalog", "pg_toast", "postgres"].map(Name::from_string);
let mut names = HashSet::from(default_schemas);
for name in binder.all_symbols_by_kind(SymbolKind::Schema, None) {
names.insert(name.clone());
}

names
.into_iter()
.map(|name| CompletionItem {
label: name.to_string(),
kind: CompletionItemKind::Schema,
detail: None,
insert_text: None,
insert_text_format: None,
trigger_completion_after_insert: false,
})
.collect()
}

fn table_completions(file: &ast::SourceFile, token: &SyntaxToken) -> Vec<CompletionItem> {
let binder = binder::bind(file);
// We're in a TRUNCATE or TABLE statement, return table names
let tables = binder.all_symbols_by_kind(SymbolKind::Table);
tables
let tables = binder.all_symbols_by_kind(SymbolKind::Table, None);
let mut completions: Vec<CompletionItem> = tables
.into_iter()
.map(|name| CompletionItem {
label: name.to_string(),
Expand All @@ -97,41 +125,33 @@ fn table_completions(binder: &binder::Binder) -> Vec<CompletionItem> {
insert_text_format: None,
trigger_completion_after_insert: false,
})
.collect()
.collect();

if schema_qualifier_at_token(token).is_none() {
completions.extend(schema_completions(&binder));
}

completions
}

enum CompletionContext {
TableOnly,
Default(bool),
Default,
SelectClause(ast::SelectClause),
}

fn completion_context(token: SyntaxToken) -> CompletionContext {
let mut node = token.parent();
let mut is_nested = false;
let mut kind = None;
while let Some(current_node) = node {
if ast::Stmt::can_cast(current_node.kind())
&& current_node
.parent()
.is_some_and(|x| x.kind() == SyntaxKind::SOURCE_FILE)
{
is_nested = true;
}
if ast::Truncate::can_cast(current_node.kind()) || ast::Table::can_cast(current_node.kind())
{
if kind.is_none() {
kind = Some(CompletionContext::TableOnly)
};
}
if let Some(select_clause) = ast::SelectClause::cast(current_node.clone()) {
if kind.is_none() {
kind = Some(CompletionContext::SelectClause(select_clause))
};
fn completion_context(token: &SyntaxToken) -> CompletionContext {
if let Some(node) = token.parent() {
for a in node.ancestors() {
if ast::Truncate::can_cast(a.kind()) || ast::Table::can_cast(a.kind()) {
return CompletionContext::TableOnly;
}
if let Some(select_clause) = ast::SelectClause::cast(a.clone()) {
return CompletionContext::SelectClause(select_clause);
}
}
node = current_node.parent();
}
kind.unwrap_or_else(|| CompletionContext::Default(is_nested))
CompletionContext::Default
}

fn token_at_offset(file: &ast::SourceFile, offset: TextSize) -> Option<SyntaxToken> {
Expand All @@ -147,50 +167,35 @@ fn token_at_offset(file: &ast::SourceFile, offset: TextSize) -> Option<SyntaxTok
Some(token)
}

fn default_completions(at_top_level: bool) -> Vec<CompletionItem> {
let select_insert_text = if at_top_level {
"select $0;"
fn schema_qualifier_at_token(token: &SyntaxToken) -> Option<Schema> {
let schema_token = if token.kind() == SyntaxKind::DOT {
token.prev_token()
} else if token.kind() == SyntaxKind::IDENT
&& let Some(prev) = token.prev_token()
&& prev.kind() == SyntaxKind::DOT
{
prev.prev_token()
} else {
"select $0"
None
};

let table_insert_text = if at_top_level {
"table $0;"
} else {
"table $0"
};
schema_token
.filter(|tk| tk.kind() == SyntaxKind::IDENT)
.map(|tk| Schema(Name::from_string(tk.text().to_string())))
}

let mut completions = vec![
CompletionItem {
label: "select".to_owned(),
fn default_completions() -> Vec<CompletionItem> {
["select", "table", "truncate"]
.map(|stmt| CompletionItem {
label: stmt.to_owned(),
kind: CompletionItemKind::Keyword,
detail: None,
insert_text: Some(select_insert_text.to_owned()),
insert_text: Some(format!("{stmt} $0;")),
insert_text_format: Some(CompletionInsertTextFormat::Snippet),
trigger_completion_after_insert: false,
},
CompletionItem {
label: "table".to_owned(),
kind: CompletionItemKind::Keyword,
detail: None,
insert_text: Some(table_insert_text.to_owned()),
insert_text_format: Some(CompletionInsertTextFormat::Snippet),
trigger_completion_after_insert: true,
},
];

if at_top_level {
completions.push(CompletionItem {
label: "truncate".to_owned(),
kind: CompletionItemKind::Keyword,
detail: None,
insert_text: Some("truncate $0;".to_owned()),
insert_text_format: Some(CompletionInsertTextFormat::Snippet),
trigger_completion_after_insert: true,
});
}

completions
})
.into_iter()
.collect()
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
Expand Down Expand Up @@ -290,6 +295,20 @@ mod tests {
");
}

#[test]
fn completion_at_top_level() {
assert_snapshot!(completions("
create table t(a int);
$0
"), @r"
label | kind | detail | insert_text
----------+---------+--------+--------------
select | Keyword | | select $0;
table | Keyword | | table $0;
truncate | Keyword | | truncate $0;
");
}

#[test]
fn completion_in_string() {
completions_not_found("select '$0';");
Expand All @@ -306,9 +325,14 @@ mod tests {
create table users (id int);
truncate $0;
"), @r"
label | kind | detail | insert_text
-------+-------+--------+-------------
users | Table | |
label | kind | detail | insert_text
------------+--------+--------+-------------
pg_catalog | Schema | |
pg_temp | Schema | |
pg_toast | Schema | |
postgres | Schema | |
public | Schema | |
users | Table | |
");
}

Expand All @@ -326,10 +350,11 @@ truncate $0;
#[test]
fn completion_table_nested() {
assert_snapshot!(completions("select * from ($0)"), @r"
label | kind | detail | insert_text
--------+---------+--------+-------------
select | Keyword | | select $0
table | Keyword | | table $0
label | kind | detail | insert_text
----------+---------+--------+--------------
select | Keyword | | select $0;
table | Keyword | | table $0;
truncate | Keyword | | truncate $0;
");
}

Expand All @@ -339,9 +364,14 @@ truncate $0;
create table users (id int);
table $0;
"), @r"
label | kind | detail | insert_text
-------+-------+--------+-------------
users | Table | |
label | kind | detail | insert_text
------------+--------+--------+-------------
pg_catalog | Schema | |
pg_temp | Schema | |
pg_toast | Schema | |
postgres | Schema | |
public | Schema | |
users | Table | |
");
}

Expand All @@ -351,13 +381,31 @@ table $0;
create table t(a text, b int);
create function f() returns text as 'select 1::text' language sql;
select $0 from t;
"), @r"
label | kind | detail | insert_text
------------+----------+--------+-------------
a | Column | |
b | Column | |
f() | Function | |
pg_catalog | Schema | |
pg_temp | Schema | |
pg_toast | Schema | |
postgres | Schema | |
public | Schema | |
t | Table | |
");
}

#[test]
fn completion_with_schema_qualifier() {
assert_snapshot!(completions("
create function f() returns int8 as 'select 1' language sql;
create function foo.b() returns int8 as 'select 2' language sql;
select public.$0;
"), @r"
label | kind | detail | insert_text
-------+----------+--------+-------------
a | Column | |
b | Column | |
f | Function | |
t | Table | |
f() | Function | |
");
}
}
2 changes: 1 addition & 1 deletion crates/squawk_server/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ pub fn run() -> Result<()> {
document_symbol_provider: Some(OneOf::Left(true)),
completion_provider: Some(CompletionOptions {
resolve_provider: Some(false),
trigger_characters: None,
trigger_characters: Some(vec![".".to_owned()]),
all_commit_characters: None,
work_done_progress_options: WorkDoneProgressOptions {
work_done_progress: None,
Expand Down
Loading
Loading