Docs for TrueQuery 0.1.6View as Markdown
The receipt
Every task says what was checked, what was found and, just as plainly, what wasn't. This one is from truequery review samples/bad_orders.sql, a sample file of seven common SQL mistakes:
TrueQuery receipt
Checked 1 SQL file · contracts for 0 of 3 tables
Found 5 errors · 2 warnings
Not checked your data: TrueQuery reads files and never connects to your database
No contract customers, orders, staging_ordersLine by line#
| Line | What it tells you |
|---|---|
| Checked | The files the checks actually read, and how many of the tables they use have a contract. |
| Found | How many findings, by severity. They're listed above the receipt, each with its line and column. |
| Not checked | What this pass couldn't verify, and why. |
| No contract | Tables with no written contract, so nothing states what one row means. |
What "not checked" means#
It's the point of the receipt. A pass never claims more than was verified, so these are listed instead of being left out:
- Your data. TrueQuery reads files and never connects to your database, so it can't see column types, data or row counts. This line appears every time.
- Files it couldn't read. A file it couldn't parse is listed as not checked, never as clean. So is procedural code, like a PL/pgSQL function or a
BEGIN … ENDblock. - SQL built at run time. It can't be read from the file. See SQL inside Python.
- DataFrames from elsewhere. A DataFrame passed in from another file isn't followed. See pandas.
A limit that couldn't affect your files isn't listed, so the lines change with the code you checked.
In an answer for a person#
/truequery ask says the same thing in plain words instead of printing a receipt. See ask.