一个用于使用 JSON Schema 验证 JSON 对象的 SQLite 扩展。基于 sqlite-loadable-rs 和 jsonschema crate。

如果您的公司或组织认为此库有用，请考虑支持我的工作！

.load ./jsonschema0
select jsonschema_matches('{"maxLength": 5}', json_quote('alex'));

与 SQLite 的 CHECK 约束一起使用，以便在插入表之前验证 JSON 列。

create table students(
  -- ensure that JSON objects stored in the data column have "firstName" strings,
  -- "lastName" strings, and "age" integers that are greater than 0.
  data json check (
    jsonschema_matches(
      json('
        {
          "type": "object",
          "properties": {
            "firstName": {
              "type": "string"
            },
            "lastName": {
              "type": "string"
            },
            "age": {
              "type": "integer",
              "minimum": 0
            }
          }
        }
        '),
      data
    )
  )
);

insert into students(data)
  values ('{"firstName": "Alex", "lastName": "Garcia", "age": 100}');
-- ✓


insert into students(data)
  values ('{"firstName": "Alex", "lastName": "Garcia", "age": -1}');
-- Runtime error: CHECK constraint failed: jsonschema_matches

查找列中所有不匹配 JSON Schema 的值。

select
  rowid,
  jsonschema_matches(
    '{
      "type": "array",
      "items": {
        "type": "number"
      }
    }',
    foo
  ) as valid
from bar
where not valid;

语言	安装
Python	pip install sqlite-jsonschema
Datasette	datasette install datasette-sqlite-jsonschema
Node.js	npm install sqlite-jsonschema
Deno	deno.land/x/sqlite_jsonschema
Ruby	gem install sqlite-jsonschema
Github 发布
Rust	cargo add sqlite-jsonschema

sqlite-jsonschema 分发在 pip、npm 和 https://deno.land/x 上，供 Python、Node.js 和 Deno 程序员使用。此外还提供了预构建的扩展，可用于其他环境。

对于 Python 开发者，使用 sqlite-jsonschema Python 包

pip install sqlite-jsonschema

然后可以将 sqlite-jsonschema 扩展加载到 sqlite3 连接对象 (Connection object) 中。

import sqlite3
import sqlite_jsonschema

db = sqlite3.connect(':memory:')
sqlite_jsonschema.load(db)
db.execute('select jsonschema_version(), jsonschema()').fetchone()

有关详细信息，请参阅在 Python 中使用 sqlite-jsonschema。

对于 Node.js 开发者，使用 sqlite-jsonschema NPM 包

npm install sqlite-jsonschema

然后可以将 sqlite-jsonschema 扩展加载到 better-sqlite3 或 node-sqlite3 连接中。

import Database from "better-sqlite3";
import * as sqlite_jsonschema from "sqlite-jsonschema";

const db = new Database(":memory:");

db.loadExtension(sqlite_jsonschema.getLoadablePath());

const version = db.prepare("select jsonschema_version()").pluck().get();
console.log(version); // "v0.2.0"

有关详细信息，请参阅在 Node.js 中使用 sqlite-jsonschema。

对于 Deno 开发者，使用 x/sqlite_jsonschema Deno 模块和 x/sqlite3。

import { Database } from "https://deno.land/x/sqlite3@0.8.0/mod.ts";
import * as sqlite_jsonschema from "https://deno.land/x/sqlite_jsonschema/mod.ts";

const db = new Database(":memory:");

db.enableLoadExtension = true;
db.loadExtension(sqlite_jsonschema.getLoadablePath());

const [version] = db
  .prepare("select jsonschema_version()")
  .value<[string]>()!;

console.log(version);

有关详细信息，请参阅在 Deno 中使用 sqlite-jsonschema。

对于 Datasette，使用 datasette-sqlite-jsonschema 插件将 sqlite-jsonschema 函数包含到您的 Datasette 实例中。

datasette install datasette-sqlite-jsonschema

有关详细信息，请参阅在 Datasette 中使用 sqlite-jsonschema。

对于 sqlite3 命令行界面 (CLI)，可以从 发布页面下载预编译的扩展，或者自行构建。然后使用 .load 点命令。

.load ./jsonschema0
select jsonschema_version();
'v0.2.1'

如果您以与上述列表不同的方式使用 sqlite-jsonschema，则从 发布页面下载预编译的扩展并将其加载到您的环境中。从发布中下载 jsonschema0.dylib (适用于 MacOS)、jsonschema0.so (适用于 Linux) 或 jsonschema0.dll (适用于 Windows) 文件，并将其加载到您的 SQLite 环境中。

注意：文件名中的 0 (jsonschema0.dylib/ jsonschema0.so/jsonschema0.dll) 表示 sqlite-jsonschema 的主版本。目前 sqlite-jsonschema 版本低于 v1，因此未来的版本可能会有破坏性更改。

您使用的 SQLite 客户端库中很可能存在名为 "loadExtension" 或 "load_extension" 的方法。或者，作为最后的手段，使用 load_extension() SQL 函数。

确保您已安装 Rust、make 和 C 编译器。然后 git clone 此仓库并运行 make loadable-release。

git clone https://github.com/asg017/sqlite-jsonschema.git
cd sqlite-jsonschema
make loadable-release

完成后，根据您的操作系统，编译好的扩展将出现在 dist/release/ 下，文件名为 jsonschema0.so、jsonschema0.dylib 或 jsonschema0.dll。

有关每个 sqlite-jsonschema SQL 函数的详细信息，请参阅完整的 API 参考。

我 (Alex 👋🏼) 在这个项目和 许多其他开源项目上花费了大量时间和精力。如果您的公司或组织使用了这个库 (或者您感到慷慨)，那么请考虑支持我的工作，或者与朋友分享这个项目！

• sqlite-xsv，一个用于处理 CSV 的 SQLite 扩展
• sqlite-http，一个用于发起 HTTP 请求的 SQLite 扩展
• sqlite-loadable-rs，一个用 Rust 编写 SQLite 扩展的框架