sqlite3 WebAssembly 和 JavaScript 文档索引

此网站是 SQLite 项目 WebAssembly 和 JavaScript 相关 API 文档的所在地，这些 API 允许在支持 WASM 的现代浏览器中使用 sqlite3。这些组件最初在 3.40 版本中发布为公开测试版，并计划在 3.41 版本中成为 API 稳定版本，这取决于社区的反馈。

免责声明：此网站需要现代的、支持 JavaScript 的浏览器才能完全使用。此网站使用客户端存储来存储某些浏览首选项（如亮/暗模式切换），但不会在服务器端存储任何用户信息，除了已登录的开发人员。此网站仅与其他系统共享的用户信息是此网站自身开发人员的公开 SCM 相关信息。

网站概览

关于 sqlite3 WASM 子项目:

• 📰 项目新闻
• 💬 常见问题解答
• 🚧 待办事项 和（未）计划的功能
• ☎ 技术支持 提供，并欢迎反馈，请通过 sqlite 论坛。拥有 商业 SQLite 支持合同 的用户可以使用其通常的支持渠道。

使用此项目

• 👣 三步 HOWTO 演示了如何包含和运行 sqlite3 WASM 模块及其相关的 JavaScript API。

• 💾 下载 可通过主项目下载页面获得。

  • 📸 预发布快照 不时更新
  • 📦 npm 模块

• 🛠 构建 sqlite3 WASM 及其相关的 JS 代码。

  • Emscripten 构建细节

• 📇 API 索引 描述了各种 API 变体以及如何加载和访问它们。

  • 🧑‍🍳 菜谱 用于客户端级代码的食谱
  • 💾 持久存储 选项
  • 🤓 使用 C 结构体 在 JS API 中
  • 🧱 创建 虚拟表 和 JS 中的表值函数
  • 💣 API 更改 可能会影响客户端
  • 🔭 模块符号应用程序 从 JavaScript/WASM 模块生成 sqlite3 API 符号列表。

关于此文档

• 📜 许可证
• 🚧 文档和仓库维护

现实应用

已知使用此项目的第三方项目包括（按其添加到此列表的顺序）...

• SQLime 提供数据库浏览器界面。
• Evolu Evolu 是一个本地优先平台，专为隐私、易用性和没有供应商锁定而设计。
• SQLiteNext 演示了将此项目与 next.js 集成的示例。
• sqlite-wasm-esm 演示了如何使用此项目与 Vite 工具链。
• sqlite-wasm-http 提供了一个 SQLite VFS，它允许对直接通过 HTTP 提供的服务数据库进行只读访问。

相关作品

（按我们知晓它们的顺序）...

• Alon Zakai 的 sql.js 是第一个已知的在 Web 浏览器中直接使用 sqlite3 的例子，可以追溯到 2012 年，不包括 WebSQL（它是一个本机级功能，很久以前就从大多数浏览器中删除了）。
• Roy Hashimoto 的 wa-sqlite 是第一个已知的 OPFS 存储 sqlite3 数据库的实现。
• James Long 的 absurd-js 演示了将 sqlite3 数据库存储在 IndexedDB 数据库中的方法。
• postgres-wasm 在浏览器中运行一个 Postgres 数据库服务器。
• Jaccwabyt 是一个用于通过 JS 代码操作 WASM 托管 C 结构体的小型 JS 库，专门为支持此项目中的 OPFS sqlite3_vfs 实现而创建。此项目嵌入了一个副本，但不会将其公开给客户端应用程序。
• CoWasm 是“服务器和浏览器协作 WebAssembly”。他们的演示应用程序 包括 sqlite3 shell 应用程序的 WASM 构建。
• Evan Brass 的构建 使用 WASI SDK 构建，而不是 Emscripten，并演示了一些此项目 WASM 构建中没有的新功能。

第三方文档和文章

以下链接引用了第三方发布的关于 SQLite WASM 的文章和文档

• 将 WebSQL 移植到 OPFS，由 Google Chrome 开发团队撰写
• VMWare OCTO 团队撰写了关于 为 WASI 构建 SQLite3 的文章