tursodatabase/libsql

Document how to integrate apps with libSQL with Wasm support

Open

#121 opened on Jan 26, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)C (16,744 stars) (490 forks)batch import
documentationgood first issue

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.a library, 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

Tech stack
crustsqlwasm
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Rust basicsC compilationSQLite API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Examine existing documentation in the repository (README or docs folder). Review the referenced Rust crate (libsql wasmtime bindings) and precompiled library releases. Document the three integration methods with step by step instructions, including building from source with enable wasm runtime. Refer to issue #116 for additional context.