Skip to content

Commit 3511043

Browse files
committed
docs: boringSQL stack links
1 parent f0ccdda commit 3511043

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ ActiveRecord, SQLAlchemy, Prisma, Sequelize) produce many queryids for
1010
one logical query shape. `qshape` collapses those variants to a single
1111
canonical fingerprint and aggregates their timing.
1212

13+
`qShape` is part of the [boringSQL](https://boringsql.com) stack alongside [RegreSQL](https://github.com/boringSQL/regresql), [Fixturize](https://github.com/boringSQL/fixturize) and [dryrun](https://github.com/boringSQL/dryrun).
14+
1315
## Measured corpus reduction
1416

1517
Typical reduction on an ORM-heavy `pg_stat_statements` snapshot is
@@ -60,6 +62,16 @@ writes `{"clusters":[...]}` to stdout sorted by descending
6062
`total_exec_time_ms`. Passing `-` (or omitting the SQL arg) to
6163
`normalize` / `fingerprint` reads stdin.
6264

65+
`qshape` also harvests structured comments (sqlcommenter, marginalia,
66+
sqlc / boringSQL headers, bare comments) into per-cluster `owners` and
67+
`regresql_meta` fields.
68+
69+
## Learn more
70+
71+
- **[boringSQL](https://boringsql.com)**, the blog and project home
72+
- **[RegreSQL](https://github.com/boringSQL/regresql)**, regression testing for PostgreSQL queries
73+
- **[Fixturize](https://github.com/boringSQL/fixturize)** and **[dryrun](https://github.com/boringSQL/dryrun)**, companion tools in the suite
74+
6375
## License
6476

6577
BSD 2-Clause.

0 commit comments

Comments
 (0)