SQLite-Worker 使用教程

SQLite-Worker 使用教程

sqlite-worker A simple, and persistent, SQLite database for Web and Workers. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlite-worker

1. 项目介绍

SQLite-Worker 是一个基于 sql.js 和 sqlite-tag 的简单且持久的 SQLite 数据库，适用于 Web 和 Workers。它允许在 Web 和 Service Workers 中使用 SQLite 数据库，提供了一种方便的方式来处理数据的持久化。

2. 项目快速启动

引入 SQLite-Worker

在 Web 页面中，你可以通过原生 ESM (ECMAScript Modules) 引入 SQLite-Worker，也可以使用 CDN：

<script type="module">
  // 使用 unpkg CDN
  import { SQLiteWorker } from '//unpkg.com/sqlite-worker';
  
  // 初始化数据库
  SQLiteWorker({ name: 'my-db' })
    .then(async ({ all, get, query, raw }) => {
      // 数据库操作代码...
    });
</script>

如果本地已经预装了 dist 文件夹，你也可以这样引入：

<script type="module">
  import { SQLiteWorker } from './js/sqlite-worker/dist/index.js';
  
  // 初始化数据库
  SQLiteWorker({ name: 'my-db' })
    .then(async ({ all, get, query, raw }) => {
      // 数据库操作代码...
    });
</script>

数据库操作

以下是一个简单的数据库操作示例：

const table = raw`todos`;

// 创建表格
await query`CREATE TABLE IF NOT EXISTS ${table}(id INTEGER PRIMARY KEY, value TEXT)`;

// 查询数据总数
const { total } = await get`SELECT COUNT(id) as total FROM ${table}`;

// 如果表格为空，插入一些数据
if (total < 1) {
  await query`INSERT INTO ${table}(value) VALUES ('a')`;
  await query`INSERT INTO ${table}(value) VALUES ('b')`;
  await query`INSERT INTO ${table}(value) VALUES ('c')`;
}

// 查询所有数据
console.table(await all`SELECT * FROM ${table}`);

3. 应用案例和最佳实践

在 Service Worker 中使用

在 Service Worker 中使用 SQLite-Worker 时，你需要使用 importScripts 来加载模块：

// 加载 SQLite-Worker 的 dist 文件
importScripts('./dist/sw.js');

const dist = './dist/';

sqliteWorker({
  dist,
  name: 'my-db'
})
.then(async ({ all, get, query, raw, transaction }) => {
  // 数据库操作代码...
});

数据库同步

SQLite-Worker 支持 update 选项，可以用来同步远程数据库：

sqliteWorker({
  name: 'my-db',
  update: (uInt8Array) => {
    // 存储最新的 uInt8Array 数据
  }
});

这样，即使在客户端数据被删除或更改的情况下，也可以从存储的缓冲区恢复数据库状态。

4. 典型生态项目

目前，SQLite-Worker 社区提供了一些相关的生态项目，例如：

• sqlite-tag：一个用于 SQLite 的模板标签库，简化 SQL 查询的编写。
• sql.js：一个纯 JavaScript 实现的 SQLite 库。

这些项目可以与 SQLite-Worker 结合使用，以提供更丰富的功能和应用场景。

sqlite-worker A simple, and persistent, SQLite database for Web and Workers. 项目地址: https://gitcode.com/gh_mirrors/sq/sqlite-worker