ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

rainbow_csv

by mechatroner ST3

:rainbow: Sublime Text Package: Highlight columns in CSV and TSV files and run queries in SQL-like language

Labels csv, tsv, highlight

Details

Installs

  • Total 10K
  • Win 4K
  • OS X 4K
  • Linux 2K
Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31
Windows 2 3 10 16 10 14 11 7 6 8 15 14 18 8 3 1 11 11 15 12 12 4 4 14 32 11 17 10 6 3 10 18 11 8 6 5 6 10 9 18 13 10 4 3 10 15
OS X 5 3 8 10 9 16 10 5 4 15 15 10 11 10 5 4 3 12 9 11 14 2 5 4 8 7 7 10 6 7 8 14 13 6 6 3 6 10 14 13 13 12 5 3 9 14
Linux 4 0 3 3 5 5 7 4 1 7 5 7 6 6 3 4 2 3 4 7 5 3 1 2 12 4 9 2 3 4 3 7 12 5 5 1 0 3 5 2 7 5 2 0 0 5

Readme

Source
raw.​githubusercontent.​com

logo

Rainbow CSV

Main features

  • Highlight columns in *.csv, *.tsv and other separated files in different rainbow colors.
  • Provide info about columns on mouse hover.
  • Check consistency of CSV files (CSVLint)
  • Align columns with spaces and Shrink (trim spaces from fields)
  • Execute SQL-like RBQL queries.

screenshot

Usage

Rainbow CSV has content-based csv/tsv autodetection mechanism. This means that package will analyze plain text files even if they do not have “.csv” or “.tsv” extension.

Rainbow highlighting can also be manually enabled from Sublime context menu (see the demo gif below):
1. Select a character that you want to use as a delimiter with mouse. Delimiter can be any non-alphanumeric printable ASCII symbol, e.g. semicolon
2. Right mouse click: context menu -> Rainbow CSV -> Enable …

You can also disable rainbow highlighting and go back to the original file highlighting using the same context menu.
This feature can be used to temporary rainbow-highlight even non-table files.

Manual Rainbow Enabling/Disabling demo gif:
demo

Rainbow CSV also lets you execute SQL-like queries in RBQL language, see the demo gif below:
demo gif

To Run RBQL query press F5 or select “Rainbow CSV” -> “Run RBQL query” option from the file context menu.

Difference between “Standard” and “Simple” dialects

When manually enabling rainbow highlighting from the context menu, you have to choose between “Standard” and “Simple” dialect.
* Standard dialect will treat quoted separator as a single field. E.g. line sell,"15,128",23% will be treated as 3 columns, because the second comma is quoted. This dialect is used by Excel.
* Simple dialect doesn't care about double quotes: the number of highlighted fields is always N + 1 where N is the number of separators.

Key mappings

Key Action
F5 Start query editing for the current csv file

Commands

Rainbow CSV: CSVLint

The linter checks the following:
* consistency of double quotes usage in CSV rows
* consistency of number of fields per CSV row

Rainbow CSV: Run RBQL query

Run RBQL query for the current file.
Unlike F5 button it will work even if the current file is not a CSV table: in this case only 2 variables “a1” and “NR” will be available.

Rainbow CSV: Align CSV columns with spaces

Align CSV columns with spaces in the current file

Rainbow CSV: Shrink CSV table

Remove leading and trailing spaces from all fields in the current file

Configuration

To adjust plugin configuration:
1. Go to “Preferences” -> “Package Settings” -> “Rainbow CSV” -> “Settings”.
2. On the right side change the settings like you'd like.

Configuration parameters

“enable_rainbow_csv_autodetect”

Enable content-based separator autodetection. Files with “.csv” and “.tsv” extensions are always highlighted no matter what is the value of this option.

“rainbow_csv_autodetect_dialects”

List of CSV dialects to autodetect.
If “enable_rainbow_csv_autodetect” is set to false this setting is ignored

“rainbow_csv_max_file_size_bytes”

Disable Rainbow CSV for files bigger than the specified size. This can be helpful to prevent poor performance and crashes with very large files.
Manual separator selection will override this setting for the current file.
E.g. to disable on files larger than 100 MB, set "rainbow_csv_max_file_size_bytes": 100000000

“auto_adjust_rainbow_colors”

Auto adjust rainbow colors for Packages/User/RainbowCSV.sublime-color-scheme
Rainbow CSV will auto-generate color theme with high-contrast colors to make CSV columns more distinguishable.
You can disable this setting and manually customize Rainbow CSV color scheme at Packages/User/RainbowCSV.sublime-color-scheme
Do not customize Packages/User/RainbowCSV.sublime-color-scheme without disabling the setting, it will be rewritten by the plugin

“rbql_backend_language”

RBQL backend language.
Supported values: “Python”, “JS”
In order to use RBQL with JavaScript (JS) you need to have Node JS installed and added to your system path.

“rbql_output_format”

Format of RBQL result set tables.
Supported values: “tsv”, “csv”, “input”
* input: same format as the input table * tsv: tab separated values. * csv: is Excel-compatible and allows quoted commas.

Example: to always use “tsv” as output format add this line to your settings file: "rbql_output_format": "tsv",

“rbql_encoding”

RBQL encoding for files and queries.
Supported values: “latin-1”, “utf-8”

References

  • This Sublime Text plugin is an adaptation of Vim's rainbow_csv plugin

RBQL (Rainbow Query Language) Description

RBQL is a technology which provides SQL-like language that supports SELECT and UPDATE queries with Python or JavaScript expressions.
RBQL is distributed with CLI apps, text editor plugins, Python and JS libraries and can work in web browsers.
RBQL core module is very generic and can process all kind of objects and record formats, but most popular RBQL implementation works with CSV files.

Official Site

Main Features

  • Use Python or JavaScript 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 (record number) identifier
  • Supports all main SQL keywords
  • Supports aggregate functions and GROUP BY queries
  • 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 consecutive queries
  • Number of tables in all JOIN queries is always 2 (input table and join table), use consecutive queries to join 3 or more tables

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

RBQL variables

RBQL for CSV files provides the following variables which you can use in your queries:

  • a1, a2,…, a{N}
    Variable type: string
    Description: value of i-th field in the current record in input table
  • b1, b2,…, b{N}
    Variable type: string
    Description: value of i-th field in the current record in join table B
  • NR
    Variable type: integer
    Description: Record number (1-based)
  • NF
    Variable type: integer
    Description: Number of fields in the current record
  • a.name, b.Person_age, … a.{good_alphanumeric_column_name}
    Variable type: string
    Description: Value of the field referenced by it's “name”. You can use this notation if the field in the first (header) CSV line has a “good” alphanumeric name
  • a[“object id”], a['9.12341234'], b[“%$ !! 10 20”]a[“arbitrary column name!”]
    Variable type: string
    Description: Value of the field referenced by it's “name”. You can use this notation to reference fields by arbitrary values in the first (header) CSV line, even when there is no header at all

Notes:

  • You can mix all variable types in a single query, example:

select a1, b2 JOIN /path/to/b.csv ON a['Item Id'] == b.Identifier WHERE NR > 1 and int(a.Weight) * 100 > int(b["weight of the item"]) * Referencing fields by header names does not automatically skip the header line (you can use where NR > 1 trick to skip it) * If you want to use RBQL as a library for your own app you can define your own custom variables and do not have to support the above mentioned CSV-related variables.

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, ARRAY_AGG, MIN, MAX, SUM, AVG, VARIANCE, MEDIAN

Limitation: aggregate functions inside Python (or JS) expressions are not supported. Although you can use expressions inside aggregate functions.
E.g. MAX(float(a1) / 1000) - valid; MAX(a1) / 1000 - invalid.
There is a workaround for the limitation above for ARRAY_AGG function which supports an optional parameter - a callback function that can do something with the aggregated array. Example:
select a2, ARRAY_AGG(a1, lambda v: sorted(v)[:5]) group by a2 - Python; select a2, ARRAY_AGG(a1, v => v.sort().slice(0, 5)) group by a2 - JS

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”.
Limitation: JOIN statements must have the following form: (/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.

UNNEST() operator

UNNEST(list) takes a list/array as an argument and repeats the output record multiple times - one time for each value from the list argument.
Example: SELECT a1, UNNEST(a2.split(';'))

User Defined Functions (UDF)

RBQL supports User Defined Functions
You can define custom functions and/or import libraries in two special files:
* ~/.rbql_init_source.py - for Python * ~/.rbql_init_source.js - for JavaScript

Examples of RBQL queries

With Python expressions

  • select top 100 a1, int(a2) * 10, len(a4) where a1 == "Buy" order by int(a2) desc
  • select * order by random.random() where NR > 1 - skip header record and random sort
  • select len(a.vehicle_price) / 10, a2 where NR > 1 and a['Vehicle type'] in ["car", "plane", "boat"] limit 20 - referencing columns by names from header record, skipping the header and using Python's “in” to emulate SQL's “in”
  • update set a3 = 'NPC' where a3.find('Non-playable character') != -1
  • select NR, * - enumerate records, 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 - example of join query
  • select MAX(a1), MIN(a1) where a.Name != 'John' group by a2, a3 - example of aggregate query

With JavaScript expressions

  • select top 100 a1, a2 * 10, a4.length where a1 == "Buy" order by parseInt(a2) desc
  • select * order by Math.random() where NR > 1 - skip header record and random sort
  • select top 20 a.vehicle_price.length / 10, a2 where NR > 1 and ["car", "plane", "boat"].indexOf(a['Vehicle type']) > -1 limit 20 - referencing columns by names from header record and skipping the header
  • update set a3 = 'NPC' where a3.indexOf('Non-playable character') != -1
  • select NR, * - enumerate records, NR is 1-based
  • select a1, b1, b2 inner join ./countries.txt on a2 == b1 order by a1, a3 - example of join query
  • select MAX(a1), MIN(a1) where a.Name != 'John' group by a2, a3 - example of aggregate query

FAQ

How do I skip header record in CSV files?

You can use the following trick: add ... where NR > 1 ... to your query

And if you are doing math operation you can modify your query like this, example:
select int(a3) * 1000, a2 -> select int(a3) * 1000 if NR > 1 else a3, a2

How does RBQL work?

RBQL parses SQL-like user query, creates a new python or javascript 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(',')
    if %%%W_Expression%%%:
        out_fields = [%%%S_Expression%%%]
        print ','.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(',')
    if a[0] != 'SELL':
        out_fields = [a[2], int(a[3]) + 100, len(a[1])]
        print ','.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.  
Adding support of TOP/LIMIT keywords is trivial and to support "ORDER BY" we can introduce an intermediate array.  



### References

* [RBQL: Official Site](https://rbql.org/)
RBQL is integrated with Rainbow CSV extensions in [Vim](https://github.com/mechatroner/rainbow_csv), [VSCode](https://marketplace.visualstudio.com/items?itemName=mechatroner.rainbow-csv), [Sublime Text](https://packagecontrol.io/packages/rainbow_csv) editors.
* [RBQL in npm](https://www.npmjs.com/package/rbql): `$ npm install -g rbql`
* [RBQL in PyPI](https://pypi.org/project/rbql/): `$ pip install rbql`