rainbow_csv
šRainbow CSV - Sublime Text Package: Highlight columns in CSV and TSV files and run queeries in SQL-like language
Details
Installs
- Total 49K
- Win 22K
- Mac 19K
- Linux 8K
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 | Oct 30 | Oct 29 | Oct 28 | Oct 27 | Oct 26 | Oct 25 | Oct 24 | Oct 23 | Oct 22 | Oct 21 | Oct 20 | Oct 19 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 12 | 10 | 7 | 5 | 10 | 6 | 0 | 0 | 0 | 1 | 4 | 13 | 11 | 8 | 4 | 14 | 5 | 6 | 10 | 0 | 0 | 16 | 15 | 4 | 8 | 17 | 11 | 13 | 9 | 13 | 1 | 2 | 4 | 12 | 17 | 16 | 14 | 2 | 1 | 12 | 21 | 18 | 12 | 20 | 2 | 1 |
Mac | 10 | 11 | 7 | 5 | 7 | 2 | 0 | 0 | 0 | 0 | 7 | 15 | 10 | 6 | 8 | 11 | 2 | 6 | 11 | 0 | 0 | 13 | 10 | 4 | 3 | 9 | 11 | 14 | 17 | 16 | 4 | 9 | 9 | 8 | 7 | 13 | 8 | 5 | 5 | 6 | 4 | 17 | 8 | 6 | 2 | 3 |
Linux | 3 | 4 | 1 | 1 | 7 | 1 | 0 | 0 | 0 | 0 | 4 | 4 | 3 | 1 | 0 | 2 | 2 | 1 | 2 | 0 | 0 | 4 | 4 | 4 | 3 | 6 | 5 | 4 | 4 | 4 | 1 | 0 | 2 | 8 | 4 | 6 | 6 | 1 | 2 | 4 | 6 | 6 | 7 | 6 | 3 | 6 |
Readme
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.
Usage
Rainbow CSV has content-based csv/tsv autodetection mechanism. This means that the 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 (or sequence of characters) that you want to use as a delimiter with the cursor
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 temporarily rainbow-highlight even non-table files.
Manual Rainbow Enabling/Disabling demo gif:
Rainbow CSV also lets you execute SQL-like queries in RBQL language, see the demo gif below:
To Run RBQL query press F5 or select āRainbow CSVā -> āRun RBQL queryā option from the file context menu.
Key mappings
Key | Action |
---|---|
F5 | Start query editing for the current CSV file |
Commands
Rainbow CSV: Enable Simple
Before running the command you need to select the separator (single or multiple characters) with your cursor Set the selected character as the separator and enables syntax highlighting. Sublime will generate the syntax file if it doesn't exist. Simple dialect completely ignores double quotes: i.e. separators can not be escaped in double quoted fields
Rainbow CSV: Enable Standard
Same as the Enable Simple command, but separators can be escaped in double quoted fields.
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
To configure the extension, click āPreferencesā -> āPackage Settingsā -> āRainbow CSVā -> āSettingsā
āallow_newlines_in_fieldsā
Allow quoted multiline fields as defined in RFC-4180
ā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
āuse_custom_rainbow_colorsā
Use custom high-contrast rainbow colors instead of colors provided by your current color scheme. When you enable this option, āauto_adjust_rainbow_colorsā also gets enabled by default.
ā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
, you can use the following RainbowCSV.sublime-color-scheme file as a starting point for your customizations.
Do NOT manually customize Packages/User/RainbowCSV.sublime-color-scheme without disabling this setting, the plugin will just rewrite it in that case.
This option has effect only if āuse_custom_rainbow_colorsā is set to true
ārbql_backend_languageā
RBQL backend language.
Supported values: āPythonā, āJSā
To use RBQL with JavaScript (JS) you need to have Node JS installed and added to your system path.
ārbql_with_headersā
Default: false
RBQL will treat first records in all input and join files as headers.
You can set this value to true if most of the CSV files you deal with have headers.
You can override this setting on the query level by either adding WITH (header)
or WITH (noheader)
to the end of the query.
ā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 an eval-based SQL-like query engine for (not only) CSV file processing. It provides SQL-like language that supports SELECT queries with Python or JavaScript expressions.
RBQL is best suited for data transformation, data cleaning, and analytical queries.
RBQL is distributed with CLI apps, text editor plugins, Python and JS libraries.
Main Features
- Use Python or JavaScript expressions inside SELECT, UPDATE, WHERE and ORDER BY statements
- Supports multiple input formats
- Result set of any query immediately becomes a first-class table on its own
- No need to provide FROM statement in the query when the input table is defined by the current context.
- Supports all main SQL keywords
- Supports aggregate functions and GROUP BY queries
- Supports user-defined functions (UDF)
- Provides some new useful query modes which traditional SQL engines do not have
- Lightweight, dependency-free, works out of the box
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
- AS
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 header 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 header
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.
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 its file path or by its name - an arbitrary string which the 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 the left table āAā doesn't have exactly one matching key in the right table āBā.
Table B path can be either relative to the working dir, relative to the main table or absolute.
Limitation: JOIN statements can't contain Python/JS expressions and must have the following form: (/path/to/table.tsv | table_name ) ON aā¦ == bā¦ [AND aā¦ == bā¦ [AND ā¦ ]]
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(';'))
LIKE() function
RBQL does not support LIKE operator, instead it provides ālike()ā function which can be used like this:
SELECT * where like(a1, 'foo%bar')
WITH (header) and WITH (noheader) statements
You can set whether the input (and join) CSV file has a header or not using the environment configuration parameters which could be --with_headers
CLI flag or GUI checkbox or something else.
But it is also possible to override this selection directly in the query by adding either WITH (header)
or WITH (noheader)
statement at the end of the query.
Example: select top 5 NR, * with (header)
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 a.id, a.weight / 1000 AS weight_kg
SELECT * ORDER BY random.random()
- random sortSELECT len(a.vehicle_price) / 10, a2 WHERE int(a.vehicle_price) < 500 and a['Vehicle type'] in ["car", "plane", "boat"] limit 20
- referencing columns by names from 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-basedSELECT * WHERE re.match(".*ab.*", a1) is not None
- select entries where first column has āabā patternSELECT a1, b1, b2 INNER JOIN ./countries.txt ON a2 == b1 ORDER BY a1, a3
- example of join querySELECT MAX(a1), MIN(a1) WHERE a.Name != 'John' GROUP BY a2, a3
- example of aggregate querySELECT *a1.split(':')
- Using Python3 unpack operator to split one column into many. Do not try this with other SQL engines!
With JavaScript expressions
SELECT TOP 100 a1, a2 * 10, a4.length WHERE a1 == "Buy" ORDER BY parseInt(a2) DESC
SELECT a.id, a.weight / 1000 AS weight_kg
SELECT * ORDER BY Math.random()
- random sortSELECT TOP 20 a.vehicle_price.length / 10, a2 WHERE parseInt(a.vehicle_price) < 500 && ["car", "plane", "boat"].indexOf(a['Vehicle type']) > -1 limit 20
- referencing columns by names from headerUPDATE SET a3 = 'NPC' WHERE a3.indexOf('Non-playable character') != -1
SELECT NR, *
- enumerate records, NR is 1-basedSELECT a1, b1, b2 INNER JOIN ./countries.txt ON a2 == b1 ORDER BY a1, a3
- example of join querySELECT MAX(a1), MIN(a1) WHERE a.Name != 'John' GROUP BY a2, a3
- example of aggregate querySELECT ...a1.split(':')
- Using JS ādestructuring assignmentā syntax to split one column into many. Do not try this with other SQL engines!
References
Rainbow CSV and similar plugins in other editors:
- Rainbow CSV extension in Vim
- Rainbow CSV extension in Visual Studio Code
- rainbow-csv package in Atom
- rainbow_csv plugin in gedit - doesn't support quoted commas in csv
- rainbow_csv_4_nedit in NEdit
- CSV highlighting in Nano
- Rainbow CSV in IntelliJ IDEA
RBQL:
- RBQL: Official Site
- RBQL is integrated with Rainbow CSV extensions in Vim, VSCode, Sublime Text and Atom editors.
- RBQL in npm:
$ npm install -g rbql
- RBQL in PyPI:
$ pip install rbql