https://github.com/agnivade/sqlargs

A vet analyzer which checks sql queries for correctness
https://github.com/agnivade/sqlargs

go postgres sql vet

Last synced: 7 days ago
JSON representation

A vet analyzer which checks sql queries for correctness

• Host: GitHub
• URL: https://github.com/agnivade/sqlargs
• Owner: agnivade
• License: mit
• Created: 2018-12-26T07:07:30.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-02-27T06:58:17.000Z (almost 6 years ago)
• Last Synced: 2025-02-02T04:31:51.347Z (19 days ago)
• Topics: go, postgres, sql, vet
• Language: Go
• Size: 28.3 KB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sqlargs [![Build Status](https://travis-ci.org/agnivade/sqlargs.svg?branch=master)](https://travis-ci.org/agnivade/sqlargs)

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. :sweat_smile:

`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.__