用于使用 JSON 模式验证 JSON 对象的 SQLite 扩展。基于sqlite-loadable-rs
和jsonschema
箱。
如果您的公司或组织发现这个库有用,请考虑支持我的工作!
.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 架构不匹配的所有值。
select
rowid,
jsonschema_matches(
' {
"type": "array",
"items": {
"type": "number"
}
} ' ,
foo
) as valid
from bar
where not valid;
语言 | 安装 | |
---|---|---|
Python | pip install sqlite-jsonschema | |
数据集 | datasette install datasette-sqlite-jsonschema | |
Node.js | npm install sqlite-jsonschema | |
德诺 | deno.land/x/sqlite_jsonschema | |
红宝石 | gem install sqlite-jsonschema | |
Github 发布 | ||
锈 | 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 对象中。
import sqlite3
import sqlite_jsonschema
db = sqlite3 . connect ( ':memory:' )
sqlite_jsonschema . load ( db )
db . execute ( 'select jsonschema_version(), jsonschema()' ). fetchone ()
有关详细信息,请参阅将sqlite-jsonschema
与 Python 结合使用。
对于 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"
有关详细信息,请参阅将sqlite-jsonschema
与 Node.js 结合使用。
对于 Deno 开发人员,请将 x/sqlite_jsonschema Deno 模块与x/sqlite3
结合使用。
import { Database } from "https://deno.land/x/[email protected]/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 ) ;
有关详细信息,请参阅将sqlite-jsonschema
与 Deno 结合使用。
对于 Datasette,请使用datasette-sqlite-jsonschema
插件将sqlite-jsonschema
函数包含到 Datasette 实例中。
datasette install datasette-sqlite-jsonschema
有关详细信息,请参阅将sqlite-jsonschema
与 Datasette 结合使用。
sqlite3
CLI对于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 扩展的框架