github

x2bool / xlite

  • вторник, 28 июня 2022 г. в 00:32:48
https://github.com/x2bool/xlite


SQLite extension to query Excel (.xlsx, .xls, .ods) files as virtual tables



XLite - query Excel (.xlsx, .xls) and Open Document spreadsheets (.ods) as SQLite virtual tables

XLite is a SQLite extension written in Rust. The main purpose of this library is to allow working with spreadsheets from SQLite exposing them as virtual tables.

How to build

cargo build --release

This step will produce libxlite.so or libxlite.dylib depending on your operation system.

How to use

Assuming you have sqlite3 command line tools installed, libxlite library in your current directory and some spreadsheet file on your disk (this sample uses an .xslx file exported from Google Sheets) load extension:

sqlite3 # will open SQLite CLI
> .load libxlite

This will load xlite module, now it can be used to create virtual tables.

Creating a virtual table:

CREATE VIRTUAL TABLE class_data USING xlite(
    FILENAME './path/to/example.xlsx',
    WORKSHEET 'Class Data',
    RANGE 'A2:F'
);

Explanation: this statement will create a virtual table based on the .xlsx file and the worksheet named "Class Data".

Optional RANGE parameter is used here to skip the first row in the table because in the sample spreadsheet it is used as a header. A2:F meaning is use columns from A to F but start from 2nd row.

Querying:

SELECT A, B, C, D, E, F from class_data;

Columns are named according to their name (index) in the spreadsheet.

SELECT COUNT(*), D FROM class_data GROUP BY D ORDER BY COUNT(*);

Theoretically any operation supported by SQLite can be executed on the spreadsheet as long as it is supported by the virtual table mechanism.

Dropping:

DROP TABLE class_data;

This statement will drop only the virtual table. Physical file won't be deleted.

Limitations

INSERT, UPDATE and DELETE statements are not supported right now.

About

This project is experimental, use at your own risk. The project is developed in my free time as a way to learn Rust and database systems.