sqlite-jsonschema 0.2.3

A SQLite extension for validating JSON documents
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

---
title: API Reference
order: 1
---

# API Reference

A full reference to every function and module that `sqlite-jsonschema` offers.

As a reminder, `sqlite-jsonschema` follows semver and is pre v1, so breaking changes are to be expected.

## SQL API

<h3 id="jsonschema_matches"><a href="#jsonschema_matches">#</a><code>jsonschema_matches(schema, document)</code></h3>

Returns `1` if the given `document` matches the given `schema`, where `schema` is a valid JSON Schema. Returns `0` otherwise.

```sql
select jsonschema_matches(
  '{"maxLength": 5}',
  json_quote('alex')
);
1

select jsonschema_matches(
  '{"maxLength": 5}',
  json_quote('alexxx')
);
0
```

<h3 id="jsonschema_version"><a href="#jsonschema_version">#</a><code>jsonschema_version()</code></h3>

Returns the semver version string of the current version of `sqlite-jsonschema`.

```sql
select jsonschema_version();
${RESULT_VERSION}
```

<h3 id="jsonschema_debug"><a href="#jsonschema_debug">#</a><code>jsonschema_debug()</code></h3>

Returns a debug string of various info about `sqlite-jsonschema`, including
the version string, build date, and commit hash.

```sql
select jsonschema_debug();
${RESULT_DEBUG}
```