Sqawk
Sqawk is an Awk-like program that uses SQL and can combine data from multiple files. It is powered by SQLite.
An example
Sqawk is invoked like this:
sqawk -foo bar script baz=qux filename
where script is your SQL.
Here is an example of what it can do:
## List all login shells used on the system.
sqawk -ORS '\n' 'select distinct shell from passwd order by shell' FS=: columns=username,password,uid,gui,info,home,shell table=passwd /etc/passwdor, equivalently,
## Do the same thing.
sqawk 'select distinct a7 from a order by a7' FS=: /etc/passwdSqawk lets you be verbose to better document your script but aims to provide good defaults that save you keystrokes in interactive use.
Skip down for more examples.
Table of contents
Installation
Sqawk requires Tcl 8.6 or newer, Tcllib, and SQLite version 3 bindings for Tcl installed.
To install these dependencies on Debian and Ubuntu run the following command:
sudo apt install tcl tcllib libsqlite3-tcl
On Fedora, RHEL, and CentOS:
sudo dnf install tcl tcllib sqlite-tcl
On FreeBSD with pkgng:
sudo pkg install tcl86 tcllib tcl-sqlite3
sudo ln -s /usr/local/bin/tclsh8.6 /usr/local/bin/tclsh
On Windows 7 or later install Magicsplat Tcl/Tk for Windows.
On macOS use MacPorts:
sudo port install tcllib tcl-sqlite3
Once you have the dependencies installed on *nix, run
git clone https://github.com/dbohdan/sqawk
cd sqawk
make
make test
sudo make install
or on Windows,
git clone https://github.com/dbohdan/sqawk
cd sqawk
assemble.cmd
tclsh tests.tcl
Usage
sqawk [globaloptions] script [option=value ...] < filename
or
sqawk [globaloptions] script [option=value ...] filename1 [[option=value ...] filename2 ...]
One of the filenames can be - for standard input.
SQL
A Sqawk script consists of one or more statements in the SQLite version 3 dialect of SQL.
The default table names are a for the first input file, b for the second, c for the third, and so on. You can change the table name for any file with a file option. The table name is used as the prefix in the column names of the table. By default, the columns are named a1, a2, etc. in table a; b1, b2, etc. in b; and so on. For each record, a0 is the text of the whole record (one line of input with the default awk parser and the default record separator of \n). anr in a, bnr in b, and so on contains the record number and is the primary key of its respective table. anf, bnf, and so on contain the field count for a given record.
Options
Global options
These options affect all files.
-FS value
Example: -FS '[ \t]+'
The input field separator regular expression for the default awk parser (for all files).
-RS value
Example: -RS '\n'
The input record separator regular expression for the default awk parser (for all files).
-OFS value
Example: -OFS ' '
The output field separator string for the default awk serializer.
-ORS value
Example: -ORS '\n'
The output record separator string for the default awk serializer.
-NF value
Example: -NF 10
The maximum number of fields per record. The corresponding number of columns is added to the target table at the start (e.g., a0, a1, a2,Β ...Β , a10 for ten fields). Increase this if you run Sqawk with -MNF error and get errors like table x has no column named x51.
-MNF value
Examples: -MNF expand, -MNF crop, -MNF error
The NF mode. This option tells Sqawk what to do if a record exceeds the maximum number of fields: expand, the default, increases NF automatically and add columns to the table during import; crop truncates the record to NF fields (that is, the fields for which there aren't enough table columns are omitted); error makes Sqawk quit with an error message like table x has no column named x11.
-dbfile value
Example: -dbfile test.db
The SQLite database file in which Sqawk will store the parsed data. Defaults to the special filename :memory:, which instructs SQLite to hold the data in RAM only. Using an actual file instead of :memory: is slower but makes it possible to process larger datasets. The database file is opened if it exists and created if it doesn't. Once Sqawk creates the file, you can open it in other application, including the sqlite3 CLI. If you run Sqawk more than once with the same database file it reuses the tables each time. By default it uses a for the first file, b for the second, etc. For example, sqawk -dbfile test.db 'select 0' foo; sqawk -dbfile test.db 'select 1' bar inserts the data from both foo and bar into the table a in test.db; you can avoid this with sqawk -dbfile test.db 'select 0' table=foo foo; sqawk -dbfile test.db 'select 1' table=bar bar. If you want to, you can also insert the data from both files into the same table in one invocation: sqawk 'select * from a' foo table=a bar.
-noinput
Do not read from standard input if Sqawk is given no filename arguments.
-output value
Example: -output awk
The output format. See Output formats.
-v
Print the Sqawk version and exit.
-1
Do not split records into fields. The same as -FS 'x^'. (x^ is a regular expression that matches nothing.) Improves the performance somewhat for when you only want to operate on whole records (lines).
Output formats
The following are the possible values for the command line option -output. Some formats have format options to further customize the output. The options are appended to the format name and separated from the format name and each other with commas, e.g., -output json,kv=1,pretty=1.
awk
Options: none
Example: -output awk
The default serializer, awk, mimics its namesake Awk. When it is selected, the output consists of the rows returned by your query separated with the output record separator (-ORS). Each row in turn consists of columns separated with the output field separator (-OFS).
csv
Options: none
Example: -output csv
Output CSV.
json
Options: kv (default true), pretty (default false)
Example: -output json,pretty=0,kv=0
Output the result of the query as JSON. If kv (short for "key-value") is true, the result is an array of JSON objects with the column names as keys; if kv is false, the result is an array of arrays. The values are all represented as strings in either case. If pretty is true, each object (but not array) is indented for readability.
table
Options: alignments or align, margins, style
Examples: -output table,align=center left right, -output table,alignments=c l r
Output plain text tables. The table serializer uses Tabulate to format the output as a table using box-drawing characters. Note that the default Unicode table output does not display correctly in cmd.exe on Windows even after chcp 65001. Use style=loFi to draw tables with plain ASCII characters instead.
tcl
Options: kv (default false), pretty (default false)
Example: -output tcl,kv=1
Output raw Tcl data structures. With the tcl serializer Sqawk outputs a list of lists if kv is false and a list of dictionaries with the column names as keys if kv is true. If pretty is true, print every list or dictionary on a separate line.
Per-file options
These options are set before a filename and only affect one file.
columns
Examples: columns=id,name,sum, columns=id,a long name with spaces
Give custom names to the table columns for the next file. If there are more columns than custom names, the columns after the last with a custom name are named automatically in the same way as with the option header=1 (see below). Custom column names override names taken from the header. If you give a column an empty name, it is named automatically or retains its name from the header.
datatypes
Example: datatypes=integer,real,text
Set the datatypes for the columns, starting with the first (a1 if your table is a). The datatype for each column for which the datatype is not explicitly given is INTEGER. The datatype of a0 is always TEXT.
format
Example: format=csv csvsep=;
Set the input format for the next file. See Input formats.
header
Example: header=1
Can be 0/false/no/off or 1/true/yes/on. Use the first row of the file as a source of column names. If the first row has five fields, then the first five columns will have custom names and all the following columns will have automatically generated names (e.g., name, surname, title, office, phone, a6, a7, ...).
prefix
Example: prefix=x
The column name prefix in the table. Defaults to the table name. For example, with table=foo and prefix=bar you have columns named bar1, bar2, bar3, etc. in table foo.
table
Example: table=foo
The table name. By default, tables are named a, b, c, etc. Specifying, for example, table=foo for the second file only results in the tables having the names a, foo, c, ...
F0
Examples: F0=no, F0=1
Can be 0/false/no/off or 1/true/yes/on. Enable the zeroth column of the table that stores the whole record. Disabling this column lowers memory/disk usage.
NF
Example: NF=20
The same as the global option -NF but for one file (table).
MNF
Example: MNF=crop
The same as the global option -MNF but for one file (table).
Input formats
A format option (format=x) selects the input parser with which Sqawk parses the next file. Formats can have multiple synonymous names or multiple names that configure the parser in different ways. Selecting an input format can enable additional per-file options that only work for that format.
awk
Format options: FS, RS, trim, fields
Option examples: RS=\n, FS=:, trim=left, fields=1,2,3-5,auto
The default input parser. Splits the input first into records then into fields using regular expressions. The options FS and RS work the same as -FS and -RS respectively but only apply to one file. The option trim removes whitespace at the beginning of each line of input (trim=left), at its end (trim=right), both (trim=both), or neither (trim=none, default). The option fields configures how the fields of the input are mapped to the columns of the corresponding database table. This option lets you discard some of the fields, which can save memory, and to merge the contents of others. For example, fields=1,2,3-5,auto tells Sqawk to insert the contents of the first field into the column a1 (assuming table a), the second field into a2, the third through the fifth field into a3, and the rest of the fields starting with the sixth into the columns a4, a5, and so on, one field per column. If you merge several fields, the whitespace between them is preserved.
csv, csv2, csvalt
Format options: csvsep, csvquote
Option example: format=csv csvsep=, 'csvquote="'
Parse the input as CSV. Using format=csv2 or format=csvalt enables the alternate mode meant for parsing CSV files exported by Microsoft Excel. csvsep sets the field separator; it defaults to ,. csvquote selects the character with which the fields that contain the field separator are quoted; it defaults to ". Note that some characters (like numbers and most letters) can't be be used as csvquote.
json
Format options: kv (default true), lines (default false)
Option example: format=json kv=false
Parse the input as JSON or JSON Lines. The value for kv and lines can be 0/false/no/off or 1/true/yes/on. If lines is false, the input is treated as a JSON array of either objects (kv=1) or arrays (kv=0). If lines is true, the input is treated as a text file with a JSON array or object (depending on kv) on every line.
When kv is false, each array becomes a record and each of its elements a field. If the table for the input file is a, its column a0 contains the concatenation of every element of the array, a1 contains the first element, a2 the second element, and so on. When kv is true, the first record contains every unique key found in all of the objects. This is intended for use with the file option header=1. The keys are in the same order they are in the first object of the input. (We treat JSON objects as ordered.) If some keys aren't in the first object but are in subsequent objects, they follow those that are in the first object in alphabetical order. Records from the second on contain the values of the input objects. These values are mapped to fields according to the order of the keys in the first record.
Every value in an object or an array is converted to text when parsed. JSON given to Sqawk should only have one level of nesting ([[],[],[]] or [{},{},{}]). What happens with more deeply nested JSON is undefined. Currently it is converted to text as Tcl dictionaries and lists.
tcl
Format options: kv (default false), lines (default false)
Option example: format=tcl kv=true
The value for kv can be 0/false/no/off or 1/true/yes/on. If lines is false, the input is treated as a Tcl list of either lists (kv=0) or dictionaries (kv=1). If lines is true, it is treated as a text file with a Tcl list or dictionary (depending on kv) on every line.
When kv is false, each list becomes a record and each of its elements a field. If the table for the file is a, its column a0 contains the full list, a1 contains the first element, a2 the second element, and so on. When kv is true, the first record contains every unique key found in all of the dictionaries. This is intended for use with the file option header=1. The keys are in the same order they are in the first dictionary of the input. (Tcl dictionaries are ordered.) If some keys aren't in the first dictionary but are in the subsequent ones, they follow those that are in the first dictionary in alphabetical order. Records from the second on contain the values of the input dictionaries. They are mapped to fields according to the order of the keys in the first record.
More examples
Sum up numbers
find . -iname '*.jpg' -type f -printf '%s\n' | sqawk 'select sum(a1)/1024.0/1024 from a'
Line count
sqawk -1 'select count(*) from a' < file.txt
Find lines that match a pattern
ls | sqawk -1 'select a0 from a where a0 like "%win%"'
Shuffle lines
sqawk -1 'select a1 from a order by random()' < file
Pretty-print data as a table
ps | sqawk -output table \
'select a1,a2,a3,a4 from a' \
trim=left \
fields=1,2,3,4-end
Sample output
βββββββ¬ββββββ¬βββββββββ¬ββββββββββββββββ
β PID β TTY β TIME β CMD β
βββββββΌββββββΌβββββββββΌββββββββββββββββ€
β11476βpts/3β00:00:00β ps β
βββββββΌββββββΌβββββββββΌββββββββββββββββ€
β11477βpts/3β00:00:00βtclkit-8.6.3-mkβ
βββββββΌββββββΌβββββββββΌββββββββββββββββ€
β20583βpts/3β00:00:02β zsh β
βββββββ΄ββββββ΄βββββββββ΄ββββββββββββββββ
Convert input to JSON objects
ps a | sqawk -output json,pretty=1 \
'select PID, TTY, STAT, TIME, COMMAND from a' \
trim=left \
fields=1,2,3,4,5-end \
header=1
Sample output
[{
"PID" : "1171",
"TTY" : "tty7",
"STAT" : "Rsl+",
"TIME" : "191:10",
"COMMAND" : "/usr/lib/xorg/Xorg -core :0 -seat seat0 -auth /var/run/lightdm/root/:0 -nolisten tcp vt7 -novtswitch"
},{
"PID" : "1631",
"TTY" : "tty1",
"STAT" : "Ss+",
"TIME" : "0:00",
"COMMAND" : "/sbin/agetty --noclear tty1 linux"
}, <...>, {
"PID" : "26583",
"TTY" : "pts/1",
"STAT" : "R+",
"TIME" : "0:00",
"COMMAND" : "ps a"
},{
"PID" : "26584",
"TTY" : "pts/1",
"STAT" : "R+",
"TIME" : "0:00",
"COMMAND" : "tclsh /usr/local/bin/sqawk -output json,pretty=1 select PID, TTY, STAT, TIME, COMMAND from a trim=left fields=1,2,3,4,5-end header=1"
}]
Find duplicate lines
Print duplicate lines and how many times they are repeated.
sqawk -1 -OFS ' -- ' 'select a0, count(*) from a group by a0 having count(*) > 1' < file
Sample output
13 -- 2
16 -- 3
83 -- 2
100 -- 2
Remove blank lines
sqawk -1 -RS '[\n]+' 'select a0 from a' < file
Sum up numbers with the same key
sqawk -FS , -OFS , 'select a1, sum(a2) from a group by a1' data
This is the equivalent of the Awk code
awk 'BEGIN {FS = OFS = ","} {s[$1] += $2} END {for (key in s) {print key, s[key]}}' data
Input
1015,5
1015,4
1035,17
1035,11
1009,1
1009,4
1026,9
1004,5
1004,5
1009,1
Output
1004,10
1009,6
1015,9
1026,9
1035,28
Combine data from two files
Commands
This example joins the data from two metadata files generated from the happypenguin.com 2013 data dump. You do not need to download the data dump to try the query; MD5SUMS and du-bytes are included in the directory examples/hp/.
# Generate input files -- see below
cd happypenguin_dump/screenshots
md5sum * > MD5SUMS
du -b * > du-bytes
# Perform query
sqawk 'select a1, b1, a2 from a inner join b on a2 = b2 where b1 < 10000 order by b1' MD5SUMS du-bytes
Input files
MD5SUMS
d2e7d4d1c7587b40ef7e6637d8d777bc 0005.jpg
4e7cde72529efc40f58124f13b43e1d9 001.jpg
e2ab70817194584ab6fe2efc3d8987f6 0.0.6-settings.png
9d2cfea6e72d00553fb3d10cbd04f087 010_2.jpg
3df1ff762f1b38273ff2a158e3c1a6cf 0.10-planets.jpg
0be1582d861f9d047f4842624e7d01bb 012771602077.png
60638f91b399c78a8b2d969adeee16cc 014tiles.png
7e7a0b502cd4d63a7e1cda187b122b0b 017.jpg
[...]
du-bytes
136229 0005.jpg
112600 001.jpg
26651 0.0.6-settings.png
155579 010_2.jpg
41485 0.10-planets.jpg
2758972 012771602077.png
426774 014tiles.png
165354 017.jpg
[...]
Output
d50700db41035eb74580decf83f83184 615 z81.png
e1b64d03caf4615d54e9022d5b13a22d 677 init.png
a0fb29411c169603748edcc02c0e86e6 823 agendaroids.gif
3b0c65213e121793d4458e09bb7b1f58 970 screen01.gif
05f89f23756e8ea4bc5379c841674a6e 999 retropong.png
a49a7b5ac5833ec365ed3cb7031d1d84 1458 fncpong.png
80616256c790c2a831583997a6214280 1516 el2_small.jpg
[...]
1c8a3cb2811e9c20572e8629c513326d 9852 7.png
c53a88c68b73f3c1632e3cdc7a0b4e49 9915 choosing_building.PNG
bf60508db16a92a46bbd4107f15730cd 9946 glad_shot01.jpg
License
MIT.
squawk.jpg photograph by Terry Foote at English Wikipedia. It is licensed under CC BY-SA 3.0.