Skip to content

Latest commit

 

History

History
81 lines (52 loc) · 3.2 KB

README.md

File metadata and controls

81 lines (52 loc) · 3.2 KB
Raw

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.

Download

build

The following prebuilt libraries are available for download:

release

Linux Windows MacOS
x86 libxlite.so.tar.gz️ xlite.dll.zip️ N/A
x86-64 libxlite.so.tar.gz️ xlite.dll.zip️ libxlite.dylib.zip
AArch64 (ARM64) libxlite.so.tar.gz️ libxlite.dylib.zip

This step will produce libxlite.so or libxlite.dylib or xlite.dll 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 you can load extension:

sqlite3 # will open SQLite CLI
> .load libxlite # or "xlite" on Windows

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

Creating a virtual table (this sample uses the .xslx file from the tests directory):

CREATE VIRTUAL TABLE test_data USING xlite (
    FILENAME './tests/abcdef_colnames.xlsx',
    WORKSHEET 'Sheet1',
    RANGE 'A2:F', -- optional
    COLNAMES '1' -- optional
);

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

Optional RANGE parameter is used here to skip the first row in the table. A2:F meaning is use columns from A to F but start from 2nd row.

Querying:

SELECT A, B, C, D, E, F FROM test_data;

Columns are named according to their name (index) in the spreadsheet, unless an optional COLNAMES argument is provided - in this case column names will be taken from the row of spreadsheet specified by this option.

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

All operations supported by SQLite can be executed on spreadsheets as long as it is supported by the virtual table mechanism.

Dropping:

DROP TABLE test_data;

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

How to build

cargo build --release

Limitations

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

About

This project is experimental and it is developed and maintained in my free time as a hobby project.