A SQLite vtable extension to read Parquet files
Go to file
Dan Forsberg e432e746c0 Fix CFLAGS ref 2020-11-11 11:24:05 +00:00
build Fix CFLAGS ref 2020-11-11 11:24:05 +00:00
parquet Switch to Arrow and Ubuntu packages 2020-10-19 12:48:20 +01:00
parquet-generator Escape column names in CREATE 2018-07-08 10:37:18 -04:00
tests more tests 2018-07-05 21:42:10 -04:00
.gitignore All-in-one build command 2018-06-24 21:11:07 -04:00
.travis.yml travis: code coverage, maybe? 2018-07-05 18:47:33 -04:00
LICENSE Initial commit 2018-03-02 18:37:08 -05:00
README.md Update README.md 2018-10-02 11:42:43 -04:00
build-sqlite Update SQLite3 version 2020-10-19 13:00:54 +01:00
make-linux amazon linux pre-reqs and CFLAG 2020-10-27 15:06:01 +00:00
make-linux-pgo Add `make-linux-pgo` 2018-06-27 22:23:22 -04:00
travis-linux travis: set COVERAGE for tests 2018-07-05 20:12:24 -04:00

README.md

sqlite-parquet-vtable

Build Status codecov

A SQLite virtual table extension to expose Parquet files as SQL tables. You may also find csv2parquet useful.

This blog post provides some context on why you might use this.

Installing

Download

You can fetch a version built for Ubuntu 16.04 at https://s3.amazonaws.com/cldellow/public/libparquet/libparquet.so.xz

Building

./make-linux

The first run will git clone a bunch of libraries, patch them to be statically linkable and build them.

Subsequent builds will only build the parquet virtual table extension.

Building (release)

Run ./make-linux-pgo to build an instrumented binary, run tests to collect real-life usage samples, then build an optimized binary. PGO seems to give a 5-10% reduction in query times.

Tests

Run:

tests/create-queries-from-templates
tests/test-all

Use

$ sqlite/sqlite3
sqlite> .load build/linux/libparquet
sqlite> CREATE VIRTUAL TABLE demo USING parquet('parquet-generator/99-rows-1.parquet');
sqlite> SELECT * FROM demo;
...if all goes well, you'll see data here!...

Note: if you get an error like:

sqlite> .load build/linux/libparquet
Error: parquet/libparquet.so: wrong ELF class: ELFCLASS64

You have the 32-bit SQLite installed. To fix this, do:

sudo apt-get remove --purge sqlite3
sudo apt-get install sqlite3:amd64

Supported features

Row group filtering

Row group filtering is supported for strings and numerics so long as the SQLite type matches the Parquet type.

e.g. if you have a column foo that is an INT32, this query will skip row groups whose statistics prove that it does not contain relevant rows:

SELECT * FROM tbl WHERE foo = 123;

but this query will devolve to a table scan:

SELECT * FROM tbl WHERE foo = '123';

This is laziness on my part and could be fixed without too much effort.

Row filtering

For common constraints, the row is checked to see if it satisfies the query's constraints before returning control to SQLite's virtual machine. This minimizes the number of allocations performed when many rows are filtered out by the user's criteria.

Memoized slices

Individual clauses are mapped to the row groups they match.

eg going on row group statistics, which store minimum and maximum values, a clause like WHERE city = 'Dawson Creek' may match 80% of row groups.

In reality, it may only be present in one or two row groups.

This is recorded in a shadow table so future queries that contain that clause can read only the necessary row groups.

Types

These Parquet types are supported:

  • INT96 timestamps (exposed as milliseconds since the epoch)
  • INT8/INT16/INT32/INT64
  • UTF8 strings
  • BOOLEAN
  • FLOAT
  • DOUBLE
  • Variable- and fixed-length byte arrays

These are not currently supported:

  • UINT8/UINT16/UINT32/UINT64
  • DECIMAL