A JSON Schema validator for Postgres implemented in Rust
This repo is a lightweight connection between the following excellent packages:
-
PGX framework for developing PostgreSQL extensions in Rust (pgx crate)
-
jsonschema-rs Rust schema validation library (jsonschema crate)
Supported drafts:
- Draft 7 (except optional idn-hostname)
- Draft 6
- Draft 4 (except optional bignum)
Partially supported drafts (some keywords are not implemented):
- Draft 2019-09
- Draft 2020-12
Bonus support added for:
- JSON Type Definition (JTD) via the jtd crate
- Apache Avro via the avro_rs crate
# Install Rust
# https://www.rust-lang.org/tools/install
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Install PGX
cargo install cargo-pgx
cargo pgx init
# Download this repo
curl -L 'https://github.com/jefbarn/pgx_json_schema/archive/refs/tags/0.1.0.tar.gz' \
| tar -xz --strip-components=1
# Build and install the extension package
cargo pgx package
# Enable the extension in your database
create extension pgx_json_schema;select * from json_schema_is_valid('{"maxLength": 5}'::jsonb, '"foobar"'::jsonb);
json_schema_is_valid
----------------------
f
select * from json_schema_get_errors('{"maxLength": 5}'::jsonb, '"foobar"'::jsonb);
error_value | description | details | instance_path | schema_path
------------+--------------------------------------+------------------------+---------------+-------------
"foobar" | "foobar" is longer than 5 characters | MaxLength { limit: 5 } | | /maxLength
NOTE: The jtd library only reports the position of the validation errors, not a description.
select jtd_is_valid('{
"properties": {
"name": { "type": "string" },
"age": { "type": "uint32" },
"phones": {
"elements": {
"type": "string"
}
}
}
}'::jsonb, '{
"age": "43",
"phones": ["+44 1234567", 442345678]
}'::jsonb);
jtd_is_valid
--------------
f
select instance_path, schema_path from jtd_get_errors('{
"properties": {
"name": { "type": "string" },
"age": { "type": "uint32" },
"phones": {
"elements": {
"type": "string"
}
}
}
}', '{
"age": "43",
"phones": ["+44 1234567", 442345678]
}'::jsonb);
instance_path | schema_path
---------------+----------------------------------
/age | /properties/age/type
| /properties/name
/phones/1 | /properties/phones/elements/type
NOTE: The avro library only does complete validation, there is no way to list the errors.
select avro_is_valid('{
"type": "record",
"name": "test",
"fields": [
{"name": "a", "type": "long", "default": 42},
{"name": "b", "type": "string"}
]
}'::jsonb, '{
"a": 27,
"b": "foo"
}'::jsonb);
avro_is_valid
---------------
t