https://github.com/rkusa/sqlite-vfs

Build SQLite virtual file systems (VFS) by implementing a simple Rust trait.
https://github.com/rkusa/sqlite-vfs

sqlite vfs

Last synced: 3 months ago
JSON representation

Build SQLite virtual file systems (VFS) by implementing a simple Rust trait.

• Host: GitHub
• URL: https://github.com/rkusa/sqlite-vfs
• Owner: rkusa
• License: other
• Created: 2022-01-11T16:38:11.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-08T09:49:57.000Z (over 2 years ago)
• Last Synced: 2024-10-10T18:14:11.664Z (4 months ago)
• Topics: sqlite, vfs
• Language: Rust
• Homepage: https://docs.rs/sqlite-vfs
• Size: 61.5 KB
• Stars: 84
• Watchers: 3
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `sqlite-vfs`

Build SQLite virtual file systems (VFS) by implementing a simple Rust trait.

[Documentation](https://docs.rs/sqlite-vfs) | [Example](https://github.com/rkusa/wasm-sqlite/blob/main/wasm/src/vfs.rs)

This library is build for my own use-case. It doesn't expose everything a SQLite VFS provides (e.g. memory mapped files). Feel free to propose additions if the current state doesn't work for your use-case.

## Status

This library is still in _prototype_ state and not ready to be used (except for maybe prototypes). While progress will be slow, it is actively worked on.

- ✅ It passes most of SQLite's TCL test harness.

  - ⚠️ CI only runs `full.test` and not `all.test`.

  - ⚠️ [Some tests](./test-vfs/patch.sh) are skipped.

- ✅ Successfully runs experiments like [`do-sqlite`](https://github.com/rkusa/do-sqlite).

- ⚠️ It uses `unsafe` Rust, which hasn't been peer-reviewed yet.

- ⚠️ It is not used in any production-capacity yet.

## Limitations

- WAL is not supported (but in progress)

- Memory mapping not supported (`xFetch`/`xUnfetch`)

- Loading extensions not supported (`xDl*`)

- Tests run only on UNIX right now (due to `std::os::unix` usage in tests)

- Directory sync is not supported

- Sector size is always 1024

- Custom device characteristic are not supported (`xDeviceCharacteristics`)