rbql 0.5.0

Rainbow Query Language

RBQL is a technology which provides SQL-like language that supports SELECT and UPDATE queries with Python expressions.

Official Site

Installation:

$ pip install rbql

Usage example:

$ rbql-py --query "select a1, a2 order by a1" --delim , < input.csv

Usage example (interactive mode):

In interactive mode rbql-py will show input table preview so it is easier to type SQL-like query.

$ rbql-py --input input.csv --output result.csv

Using rbql as python library

If you want to use rbql module as python library for your project read the integration docs.

Main Features

• Use Python expressions inside SELECT, UPDATE, WHERE and ORDER BY statements
• Result set of any query immediately becomes a first-class table on it's own
• Supports input tables with inconsistent number of fields per record
• Output records appear in the same order as in input unless ORDER BY is provided
• Each record has a unique NR (line number) identifier
• Supports all main SQL keywords
• Provides some new useful query modes which traditional SQL engines do not have
• Supports both TOP and LIMIT keywords
• Supports user-defined functions (UDF)
• Works out of the box, no external dependencies

Limitations:

• RBQL doesn't support nested queries, but they can be emulated with 2 or more consecutive queries.

Supported SQL Keywords (Keywords are case insensitive)

• SELECT
• UPDATE
• WHERE
• ORDER BY ... [ DESC | ASC ]
• [ LEFT | INNER ] JOIN
• DISTINCT
• GROUP BY
• TOP N
• LIMIT N

All keywords have the same meaning as in SQL queries. You can check them online

Special variables

Variable Name	Variable Type	Variable Description
a1, a2,..., a{N}	string	Value of i-th column
b1, b2,..., b{N}	string	Value of i-th column in join table B
NR	integer	Line number (1-based)
NF	integer	Number of fields in line

UPDATE statement

UPDATE query produces a new table where original values are replaced according to the UPDATE expression, so it can also be considered a special type of SELECT query. This prevents accidental data loss from poorly written queries.
UPDATE SET is synonym to UPDATE, because in RBQL there is no need to specify the source table.

Aggregate functions and queries

RBQL supports the following aggregate functions, which can also be used with GROUP BY keyword:
COUNT(), MIN(), MAX(), SUM(), AVG(), VARIANCE(), MEDIAN(), _FOLD()

Additionally RBQL supports DISTINCT COUNT keyword which is like DISTINCT, but adds a new column to the "distinct" result set: number of occurrences of the entry, similar to uniq -c unix command.
SELECT DISTINCT COUNT a1 is equivalent to SELECT a1, COUNT(a1) GROUP BY a1

Limitations

• Aggregate function are CASE SENSITIVE and must be CAPITALIZED.
• Aggregate functions inside Python expressions are not supported. Although you can use expressions inside aggregate functions. E.g. MAX(float(a1) / 1000) - valid; MAX(a1) / 1000 - invalid

JOIN statements

Join table B can be referenced either by it's file path or by it's name - an arbitary string which user should provide before executing the JOIN query.
RBQL supports STRICT LEFT JOIN which is like LEFT JOIN, but generates an error if any key in left table "A" doesn't have exactly one matching key in the right table "B".

Limitations

• JOIN statements must have the following form: <JOIN_KEYWORD> (/path/to/table.tsv | table_name ) ON ai == bj

SELECT EXCEPT statement

SELECT EXCEPT can be used to select everything except specific columns. E.g. to select everything but columns 2 and 4, run: SELECT * EXCEPT a2, a4
Traditional SQL engines do not support this query mode.

FOLD() and UNFOLD()

FOLD()

FOLD is an aggregate function which accumulates all values into a list.
By default it would return the list joined by pipe | character, but you can provide a callback function to change this behavior.
FOLD is very similar to GROUP_CONCAT function in MySQL
Example: select a2, FOLD(a1, lambda v: ';'.join(sorted(v))) group by a2

UNFOLD()

UNFOLD() is a function-like query mode which will do the opposite to FOLD().
UNFOLD() accepts a list as an argument and will repeat the output record multiple times - one time for each value from the list argument.
Example: SELECT a1, UNFOLD(a2.split(';'))
Traditional SQL engines can't operate with lists (arrays) and do not support FOLD() and UNFOLD()

User Defined Functions (UDF)

RBQL supports User Defined Functions
You can define custom functions and/or import libraries in a special file: ~/.rbql_init_source.py

Examples of RBQL queries

• select top 100 a1, int(a2) * 10, len(a4) where a1 == "Buy" order by int(a2)
• select * order by random.random() - random sort, this is an equivalent of bash command sort -R
• select top 20 len(a1) / 10, a2 where a2 in ["car", "plane", "boat"] - use Python's "in" to emulate SQL's "in"
• select len(a1) / 10, a2 where a2 in ["car", "plane", "boat"] limit 20
• update set a3 = 'US' where a3.find('of America') != -1
• select * where NR <= 10 - this is an equivalent of bash command "head -n 10", NR is 1-based')
• select a1, a4 - this is an equivalent of bash command "cut -f 1,4"
• select * order by int(a2) desc - this is an equivalent of bash command "sort -k2,2 -r -n"
• select NR, * - enumerate lines, NR is 1-based
• select * where re.match(".*ab.*", a1) is not None - select entries where first column has "ab" pattern
• select a1, b1, b2 inner join ./countries.txt on a2 == b1 order by a1, a3 - an example of join query
• select distinct count len(a1) where a2 != 'US'
• select MAX(a1), MIN(a1) where a2 != 'US' group by a2, a3

FAQ

How does RBQL work?

RBQL parses SQL-like user query, creates a new python worker module, then imports and executes it.

Explanation of simplified Python version of RBQL algorithm by example.

1. User enters the following query, which is stored as a string Q:

    SELECT a3, int(a4) + 100, len(a2) WHERE a1 != 'SELL'

2. RBQL replaces all a{i} substrings in the query string Q with a[{i - 1}] substrings. The result is the following string:

    Q = "SELECT a[2], int(a[3]) + 100, len(a[1]) WHERE a[0] != 'SELL'"

3. RBQL searches for "SELECT" and "WHERE" keywords in the query string Q, throws the keywords away, and puts everything after these keywords into two variables S - select part and W - where part, so we will get:

    S = "a[2], int(a[3]) + 100, len(a[1])"
    W = "a[0] != 'SELL'"

4. RBQL has static template script which looks like this:

    for line in sys.stdin:
        a = line.rstrip('\n').split('\t')
        if %%%W_Expression%%%:
            out_fields = [%%%S_Expression%%%]
            print '\t'.join([str(v) for v in out_fields])

5. RBQL replaces %%%W_Expression%%% with W and %%%S_Expression%%% with S so we get the following script:

    for line in sys.stdin:
        a = line.rstrip('\n').split('\t')
        if a[0] != 'SELL':
            out_fields = [a[2], int(a[3]) + 100, len(a[1])]
            print '\t'.join([str(v) for v in out_fields])

6. RBQL runs the patched script against user's data file:

    ./tmp_script.py < data.tsv > result.tsv

Result set of the original query (SELECT a3, int(a4) + 100, len(a2) WHERE a1 != 'SELL') is in the "result.tsv" file. It is clear that this simplified version can only work with tab-separated files.

Is this technology reliable?

It should be: RBQL scripts have only 1000 - 2000 lines combined (depending on how you count them) and there are no external dependencies. There is no complex logic, even query parsing functions are very simple. If something goes wrong RBQL will show an error instead of producing incorrect output, also there are currently 5 different warning types.

References

• rbql-js CLI App for Node.js - npm
• rbql-py CLI App in python
• Rainbow CSV extension with integrated RBQL in Visual Studio Code
• Rainbow CSV extension with integrated RBQL in Vim
• Rainbow CSV extension with integrated RBQL in Sublime Text 3