From eea6aa7493b0327e65515bd4773c06960920ad50 Mon Sep 17 00:00:00 2001 From: Nuno Cruces Date: Fri, 9 Aug 2024 10:06:05 +0100 Subject: [PATCH] Docs. --- .github/workflows/repro.sh | 6 +----- embed/bcw2/README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 embed/bcw2/README.md diff --git a/.github/workflows/repro.sh b/.github/workflows/repro.sh index 665364e..94477ba 100755 --- a/.github/workflows/repro.sh +++ b/.github/workflows/repro.sh @@ -24,15 +24,11 @@ wait # Download and build SQLite sqlite3/download.sh embed/build.sh +embed/bcw2/build.sh # Download and build sqlite-createtable-parser util/vtabutil/parse/download.sh util/vtabutil/parse/build.sh -# Download and build the bedrock branch (bcw2 patches) -if [[ "$OSTYPE" == "linux"* ]]; then - embed/bcw2/build.sh -fi - # Check diffs git diff --exit-code \ No newline at end of file diff --git a/embed/bcw2/README.md b/embed/bcw2/README.md new file mode 100644 index 0000000..b7c1e16 --- /dev/null +++ b/embed/bcw2/README.md @@ -0,0 +1,16 @@ +# Embeddable Wasm build of SQLite + +This folder includes an embeddable Wasm build of SQLite 3.46.0, including the experimental +[BEGIN CONCURRENT](https://sqlite.org/src/doc/begin-concurrent/doc/begin_concurrent.md) and +[Wal2](https://www.sqlite.org/cgi/src/doc/wal2/doc/wal2.md) patches. + +> [!IMPORTANT] +> This package is experimental. +> It is built from the `bedrock` branch of SQLite, +> since that is _currently_ the most stable, maintained branch to include both features. + +> [!CAUTION] +> The Wal2 journaling mode creates databases that other versions of SQLite cannot access. + +The build is easily reproducible, and verifiable, using +[Artifact Attestations](https://github.com/ncruces/go-sqlite3/attestations). \ No newline at end of file