tursodatabase / tursodatabase/libsql
Document how to integrate apps with libSQL with Wasm support
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 17.2k
- Forks
- 531
- Avg merge
- 1h 12m
- Merged PRs (30d)
- 1
Description
Due to the fact that our WebAssembly runtime is implemented in Rust, it's also not part of the customary sqlite3.c amalgamation file. Instead, users are expected to either:
- integrate directly with our Rust bindings crate, if libSQL is integrated into a Rust project, or
- statically link with a
.libs/libwblibsql.alibrary, either compiled from source or precompiled, or - link dynamically by using the dynamic flavor of the library, or building from source with
./configure --enable-wasm-runtime
These steps might be obvious enough for libSQL maintainers, but aren't for users, so they need to be clearly documented and easily available.
Refs #116
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the libsql-wasmtime-bindings crate, the .libs/libwblibsql.a library, the precompiled release, and the ./configure --enable-wasm-runtime command described in the issue. Document the Rust, static-linking, and dynamic-linking paths in an accessible project documentation location, with enough steps for users to integrate libSQL with Wasm.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, rust, wasm
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100