Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add more jsonb functions #2701

Merged
merged 4 commits into from
Oct 21, 2024
Merged

add more jsonb functions #2701

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
165ba21
add jsonb_exists_any and fix sidebar issue
hengm3467 Oct 16, 2024
e4595c1
add a few more jsonb functions
hengm3467 Oct 18, 2024
677703f
Merge branch 'main' into bug-fixes-20241016
hengm3467 Oct 18, 2024
321c095
Update sql-function-json.md
hengm3467 Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 97 additions & 1 deletion docs/sql/functions-operators/sql-function-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,50 @@ SELECT jsonb_build_object(variadic array['foo', '1', '2', 'bar']);
{"2": "bar", "foo": 1}
```

### `jsonb_contains`

Checks if the left `jsonb` value contains the right `jsonb` value. This function is similar to the `@>` operator.

```sql title=Syntax
jsonb_contains ( jsonb, jsonb ) → boolean
```

```sql title=Example
SELECT jsonb_contains('{"a": 1, "b": 2, "c": 3}'::jsonb, '{"b": 2}'::jsonb);
------RESULT
true

SELECT jsonb_contains('["foo", "bar", "baz"]'::jsonb, '["bar"]'::jsonb);
------RESULT
true

SELECT jsonb_contains('{"a": {"b": "c"}}'::jsonb, '{"b": "c"}'::jsonb);
------RESULT
false
```

### `jsonb_contained`

Checks if the left `jsonb` value is contained within the right `jsonb` value. This function is similar to the `<@` operator.

```sql title=Syntax
jsonb_contained ( jsonb, jsonb ) → boolean
```

```sql title=Example
SELECT jsonb_contained('{"b": 2}'::jsonb, '{"a": 1, "b": 2, "c": 3}'::jsonb);
------RESULT
true

SELECT jsonb_contained('["bar"]'::jsonb, '["foo", "bar", "baz"]'::jsonb);
------RESULT
true

SELECT jsonb_contained('{"b": "c"}'::jsonb, '{"a": {"b": "c"}}'::jsonb);
------RESULT
false
```

### `jsonb_each`

Expands the top-level JSON object into a set of key-value pairs.
Expand Down Expand Up @@ -125,9 +169,61 @@ SELECT * FROM jsonb_each_text('{"a":"foo", "b":"bar"}'::jsonb);

```

### `jsonb_exists`

Checks if the specified string exists as a top-level array element or object key within the given JSON value. This function is equivalent to the `?` operator.

```sql title=Syntax
jsonb_exists ( jsonb, text ) → boolean
```

```sql title=Example
SELECT jsonb_exists('{"a": 1, "b": 2, "c": 3}'::jsonb, 'b');
------RESULT
true

SELECT jsonb_exists('["foo", "bar", "baz"]'::jsonb, 'bar');
------RESULT
true

SELECT jsonb_exists('"foo"'::jsonb, 'foo');
------RESULT
true

SELECT jsonb_exists('{"a": {"b": "c"}}'::jsonb, 'b');
------RESULT
false
```

### `jsonb_exists_all`

Checks if all of the strings in the specified text array exist as top-level array elements or object keys within the given JSON value. This function is equivalent to the `?&` operator.

```sql title=Syntax
jsonb_exists_all ( jsonb, text[] ) → boolean
```

```sql title=Example
SELECT jsonb_exists_all('{"a": 1, "b": 2, "c": 3}'::jsonb, ARRAY['a', 'b']);
------RESULT
true

SELECT jsonb_exists_all('["foo", "bar", "baz"]'::jsonb, ARRAY['foo', 'bar']);
------RESULT
true

SELECT jsonb_exists_all('{"a": {"b": "c"}}'::jsonb, ARRAY['a', 'b']);
------RESULT
false

SELECT jsonb_exists_all('"foo"'::jsonb, ARRAY['foo', 'bar']);
------RESULT
false
```

### `jsonb_exists_any`

Checks if any of the strings in the specified text array exist as top-level array elements or object keys within the given JSON value.
Checks if any of the strings in the specified text array exist as top-level array elements or object keys within the given JSON value. This function is equivalent to the `?|` operator.

```sql title=Syntax
jsonb_exists_any ( jsonb, text[] ) → boolean
Expand Down
121 changes: 120 additions & 1 deletion versioned_docs/version-2.0/sql/functions-operators/sql-function-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,49 @@ SELECT jsonb_build_object(variadic array['foo', '1', '2', 'bar']);
------RESULT
{"2": "bar", "foo": 1}
```
### `jsonb_contains`

Checks if the left `jsonb` value contains the right `jsonb` value. This function is similar to the `@>` operator.

```sql title=Syntax
jsonb_contains ( jsonb, jsonb ) → boolean
```

```sql title=Example
SELECT jsonb_contains('{"a": 1, "b": 2, "c": 3}'::jsonb, '{"b": 2}'::jsonb);
------RESULT
true

SELECT jsonb_contains('["foo", "bar", "baz"]'::jsonb, '["bar"]'::jsonb);
------RESULT
true

SELECT jsonb_contains('{"a": {"b": "c"}}'::jsonb, '{"b": "c"}'::jsonb);
------RESULT
false
```

### `jsonb_contained`

Checks if the left `jsonb` value is contained within the right `jsonb` value. This function is similar to the `<@` operator.

```sql title=Syntax
jsonb_contained ( jsonb, jsonb ) → boolean
```

```sql title=Example
SELECT jsonb_contained('{"b": 2}'::jsonb, '{"a": 1, "b": 2, "c": 3}'::jsonb);
------RESULT
true

SELECT jsonb_contained('["bar"]'::jsonb, '["foo", "bar", "baz"]'::jsonb);
------RESULT
true

SELECT jsonb_contained('{"b": "c"}'::jsonb, '{"a": {"b": "c"}}'::jsonb);
------RESULT
false
```

### `jsonb_each`

Expand Down Expand Up @@ -123,6 +166,83 @@ SELECT * FROM jsonb_each_text('{"a":"foo", "b":"bar"}'::jsonb);
b | bar

```
### `jsonb_exists`

Checks if the specified string exists as a top-level array element or object key within the given JSON value. This function is similar to the `?` operator.

```sql title=Syntax
jsonb_exists ( jsonb, text ) → boolean
```

```sql title=Example
SELECT jsonb_exists('{"a": 1, "b": 2, "c": 3}'::jsonb, 'b');
------RESULT
true

SELECT jsonb_exists('["foo", "bar", "baz"]'::jsonb, 'bar');
------RESULT
true

SELECT jsonb_exists('"foo"'::jsonb, 'foo');
------RESULT
true

SELECT jsonb_exists('{"a": {"b": "c"}}'::jsonb, 'b');
------RESULT
false
```

### `jsonb_exists_all`

Checks if all of the strings in the specified text array exist as top-level array elements or object keys within the given JSON value. This function is similar to the `?&` operator.

```sql title=Syntax
jsonb_exists_all ( jsonb, text[] ) → boolean
```

```sql title=Example
SELECT jsonb_exists_all('{"a": 1, "b": 2, "c": 3}'::jsonb, ARRAY['a', 'b']);
------RESULT
true

SELECT jsonb_exists_all('["foo", "bar", "baz"]'::jsonb, ARRAY['foo', 'bar']);
------RESULT
true

SELECT jsonb_exists_all('{"a": {"b": "c"}}'::jsonb, ARRAY['a', 'b']);
------RESULT
false

SELECT jsonb_exists_all('"foo"'::jsonb, ARRAY['foo', 'bar']);
------RESULT
false
```

### `jsonb_exists_any`

Checks if any of the strings in the specified text array exist as top-level array elements or object keys within the given JSON value. This function is similar to the `?|` operator.

```sql title=Syntax
jsonb_exists_any ( jsonb, text[] ) → boolean
```

```sql title=Example
SELECT jsonb_exists_any('{"a": 1, "b": 2, "c": 3}'::jsonb, ARRAY['b', 'd']);
------RESULT
true

SELECT jsonb_exists_any('["foo", "bar", "baz"]'::jsonb, ARRAY['baz', 'qux']);
------RESULT
true

SELECT jsonb_exists_any('"foo"'::jsonb, ARRAY['foo', 'bar']);
------RESULT
true

SELECT jsonb_exists_any('{"a": {"b": "c"}}'::jsonb, ARRAY['b', 'd']);
------RESULT
false
```

### `jsonb_exists_any`

Expand Down Expand Up @@ -631,7 +751,6 @@ This operator checks if the left `jsonb` value contains the right `jsonb` value.
'{"foo": {"bar": "baz"}}'::jsonb @> '{"bar": "baz"}'::jsonb → f

'{"foo": {"bar": "baz"}}'::jsonb @> '{"foo": {}}'::jsonb → t
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ``` is still needed, otherwise the code snippet is not wrapped correctly. 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like I duplicated the exists_any function


### `jsonb <@ jsonb → boolean`

Expand Down
Loading