Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/x2bool/xlite
Query Excel spredsheets (.xlsx, .xls, .ods) using SQLite
https://github.com/x2bool/xlite
excel ods sql sqlite sqlite-extension sqlite-virtual-table sqlite3 xls xlsx
Last synced: 12 days ago
JSON representation
Query Excel spredsheets (.xlsx, .xls, .ods) using SQLite
- Host: GitHub
- URL: https://github.com/x2bool/xlite
- Owner: x2bool
- License: mit
- Created: 2022-06-25T03:48:57.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-19T04:23:50.000Z (over 1 year ago)
- Last Synced: 2024-10-15T12:05:52.273Z (26 days ago)
- Topics: excel, ods, sql, sqlite, sqlite-extension, sqlite-virtual-table, sqlite3, xls, xlsx
- Language: Rust
- Homepage:
- Size: 51.8 KB
- Stars: 1,252
- Watchers: 10
- Forks: 47
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-sqlite - github.com/x2bool/xlite - SQLite extension to query Excel (.xlsx, .xls, .ods) files as virtual tables (Extensions)
README
# 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](https://sqlite.org/vtab.html).
### Download
The following prebuilt libraries are available for [download](https://github.com/x2bool/xlite/releases):
| | Linux | Windows | MacOS |
|--|--|--|--|
| x86 | [libxlite.so.tar.gz](https://github.com/x2bool/xlite/releases/latest/download/libxlite-linux-x86.tar.gz)️ | [xlite.dll.zip](https://github.com/x2bool/xlite/releases/latest/download/xlite-windows-x86.zip)️ | N/A |
| x86-64 | [libxlite.so.tar.gz](https://github.com/x2bool/xlite/releases/latest/download/libxlite-linux-x64.tar.gz)️ | [xlite.dll.zip](https://github.com/x2bool/xlite/releases/latest/download/xlite-windows-x64.zip)️ | [libxlite.dylib.zip](https://github.com/x2bool/xlite/releases/latest/download/libxlite-macos-x64.zip) |
| AArch64 (ARM64) | [libxlite.so.tar.gz](https://github.com/x2bool/xlite/releases/latest/download/libxlite-linux-aarch64.tar.gz)️ | | [libxlite.dylib.zip](https://github.com/x2bool/xlite/releases/latest/download/libxlite-macos-aarch64.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:
```bash
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):
```sql
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:
```sql
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.
```sql
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:
```sql
DROP TABLE test_data;
```
This statement will drop only the virtual table. Physical file won't be deleted.
### How to build
```bash
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.