Skip to content

Native PostgreSQL extension to validate jsonb

License

Notifications You must be signed in to change notification settings

lexicoi/is_jsonb_valid

 
 

Repository files navigation

Is jsonb valid

Build Status

is_jsonb_valid is a native PostgreSQL extension to validate json schemas following Draft4. The extension exposes only one function is_jsonb_valid(schema jsonb, data jsonb) which returns a boolean depending on the success of the validation.

Examples:

SELECT is_jsonb_valid('{"type": "number"}', '1');
> t
SELECT is_jsonb_valid('{"type": "object"}', '1');
> f

It passes all JSON-Schema-Test-Suite, with the notable exception of $refRemote.

Testing and Installation

Make sure that you have PostgreSQL 9.6 or newer (check ci.yml for supported versions). In the directory of the project do:

make install && make installcheck

This will compile the extension and run the tests. Later in psql run:

CREATE EXTENSION is_jsonb_valid;

You can also run tests without installing postgres.

docker run -it --rm --mount "type=bind,src=$(pwd),dst=/repo" pgxn/pgxn-tools     sh -c 'cd /repo && pg-start 12 && pg-build-test'

Benchmarking

Benchmarking is always tricky, I've tried to check against a real world example, in particular tweets. The only other extension that I know for this purpose is postgres-json-schema. For more information on how to run the benchmarks check ./tools/README.md

Numbers of tweets is_jsonb_valid (ms) postgres-json-schema (ms) Improvement (times)
10 34.270 192.678 5.6
100 206.378 1975.543 9.6
10000 8911.354 203172.464 22.8

Disclaimer

This project is a based on postgres-json-schema. It has been written from scratch in C (original was written in SQL).

About

Native PostgreSQL extension to validate jsonb

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 90.5%
  • JavaScript 8.2%
  • Makefile 1.3%