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

Appearance settings

agnivade/sqlargs

Open more actions menu

Repository files navigation

sqlargs Build Status

A vet analyzer which checks sql(only Postgres!) queries for correctness.

Background

Let's assume you have a query like:

db.Exec("insert into table (c1, c2, c3, c4) values ($1, $2, $3, $4)", p1, p2, p3, p4).

It's the middle of the night and you need to add a new column. You quickly change the query to -

db.Exec("insert into table (c1, c2, c3, c4, c5) values ($1, $2, $3, $4)", p1, p2, p3, p4, p5).

Everything compiles fine. Except it's not ! A $5 is missing. It can even go the other way round; you add the $5 but forget to add c5.

This is a semantic error which will eventually get caught while running the app. Not to mention, if there are tests. But sometimes I get lazy and don't write tests for all my sql queries. 😅

sqlargs will statically check for semantic errors like these and flag them beforehand.

Quick start

This is written using the go/analysis API. So you can plug this directly into go vet, or you can run it as a standalone tool too.

Install:

go get github.com/agnivade/sqlargs/cmd/sqlargs

And then run it on your repo:

go vet -vettool $(which sqlargs) ./... # Has to be >= 1.12
OR
sqlargs ./...

P.S.: This only works for Postgres queries. So if your codebase has queries which do not match with the postgres query parser, it might flag incorrect errors.

About

A vet analyzer which checks sql queries for correctness

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

Morty Proxy This is a proxified and sanitized view of the page, visit original site.