fix: add @param type annotations to template SQL queries#402
Merged
Conversation
Template query files (hello_world.sql, mocked_sales.sql) lacked `-- @param` annotations, causing warnings during `appkit generate-types` on freshly scaffolded apps. Adding STRING and INT annotations silences the warnings and produces properly typed query parameters. Signed-off-by: Pawel Kosiec <pawel.kosiec@databricks.com>
2309622 to
4a614c4
Compare
calvarjorge
approved these changes
May 22, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
hello_world.sql,mocked_sales.sql) lacked-- @paramtype annotations, causing warnings duringappkit generate-typeson freshly scaffolded apps-- @param message STRINGtohello_world.sqland-- @param max_month_num INTtomocked_sales.sqlWhy
Prior to #251 (April 2026), the type generator replaced all
:paramplaceholders with a default string value ('') regardless of type — no annotation or inference system existed. That PR introduced-- @paramannotations, positional type inference (forLIMIT,OFFSET, arithmetic), and warnings for unresolved parameters. The template SQL files were created before this feature and never got annotations, so every freshly scaffolded app now shows these warnings on firstnpm run dev.Screenshots
Before
After
Test plan
databricks apps init --template ./template(analytics plugin selected)appkit generate-types— confirmed warnings appeared (before fix)pnpm testpasses (pre-existing unrelated failure inconfig.test.ts)