Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/t9t/jooq-postgresql-json

jOOQ support for PostgreSQL json & jsonb
https://github.com/t9t/jooq-postgresql-json

java jooq jooq-generator json jsonb postgres postgresql

Last synced: 27 days ago
JSON representation

jOOQ support for PostgreSQL json & jsonb

Awesome Lists containing this project

README 

        
# ⚠ Unmaintained ⚠

Unfortunately, I no longer use jOOQ or `jooq-postgresql-json` myself, and so I don't feel comfortable maintaining this

library anymore. I will no longer test the library when new jOOQ versions come out, and I won't closely follow jOOQ

news anymore to keep an eye out for new features to integrate with.



See also: https://github.com/t9t/jooq-postgresql-json/issues/24.



# jOOQ PostgreSQL JSON support

Provides jOOQ support for [PostgreSQL JSON functions and operators](https://www.postgresql.org/docs/11/functions-json.html)

for `json` and `jsonb` fields.



**Requires at least Java 11.**



⚠ Since version 4.0.0 this library does not include a transitive Maven dependency on `jooq` any more, you have to

include both `jooq` and `jooq-postgresql-json` in your project to use it.



- [Include as a Maven dependency](#include-as-a-maven-dependency)

- [Usage](#usage)

  - [Kotlin extension functions](#kotlin)

- [PostgreSQL json operator support](#postgresql-json-operator-support)

- [Available PostgreSQL json processing functions](#available-postgresql-json-processing-functions)

- [References](#references)

- [Contributors](#contributors)

- [![Javadocs](https://javadoc.io/badge/com.github.t9t.jooq/jooq-postgresql-json.svg)](https://javadoc.io/doc/com.github.t9t.jooq/jooq-postgresql-json)



---



## Include as a Maven dependency

First, add the following Maven dependency:



```xml



  com.github.t9t.jooq

  jooq-postgresql-json

  4.0.0



```



`jooq-postgresql-json` does not include a transitive dependency on `jooq`, so you have to include that yourself as well.



### Version matrix



As for 4.0.0, this shows only which jOOQ versions are explicitly tested with this library. Minor version differences

should still be compatible and newer major versions of jOOQ might still work with older versions of this library if

nothing changed much in the jOOQ JSON APIs. New releases will only be created when incompatibilities with new jOOQ

versions are found and fixed.



See [the changelog](changelog.md) for more information about what is included in the various releases and the reason for

the breaking changes.



| Library version | jOOQ version | Note |

| --- | --- | --- |

| 4.0.0 | 3.16.x - 3.18.x | Breaking change, no longer includes a dependency on `jooq`. Tested with both jOOQ `3.16.20` (JDK 11 and 17), and `3.17.14` and `3.18.5` (JDK 17 only). |

| 3.2.3 | 3.16.7 |

| 3.2.2 | 3.16.6 |

| 3.2.1 | 3.16.5 |

| 3.2.0 | 3.16.3 |

| 3.1.2 | 3.15.5 |

| 3.1.1 | 3.15.4 |

| 3.1.0 | 3.15.1 |

| 3.0.0 | 3.14.12 | Breaking change, upgraded from Java 8 to Java 11. Java 8 no longer supported. |



## Usage



Use

the [`JsonDSL`](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/JsonDSL.html)

and [`JsonbDSL`](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/JsonbDSL.html)

classes to access the JSON functions and operators.



For example, to extract a JSON nested property value as text from a `json` field:



```java

/* Sample JSON:

{

  "data": {

    "productCode": "Z-5521"

  }

}

*/

String productCode = dsl.select(JsonDSL.extractPathText(MY_TABLE.DATA_FIELD, "data", "productCode"))

    .from(MY_TABLE).fetchOneInto(String.class);

``` 



Or for example using the `@>` operator to update a row of which a `jsonb` field contains a certain id:



```java

/* Sample JSON:

{

  "id": "1337",

  "name": "The Hitchhiker's Guide to the Galaxy"

}

*/

dsl.update(MY_TABLE)

    .set(MY_TABLE.RATING, 100)

    .where(JsonbDSL.contains(MY_TABLE.DATA_FIELD, JsonbDSL.field("{\"id\": \"1337\"}")))

    .execute()

``` 



- [`JsonDSL` Javadoc](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/JsonDSL.html)

- [`JsonbDSL` Javadoc](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/JsonbDSL.html)



### Kotlin



Kotlin extension functions are available for `Field` and `Field`. That means that instead of something

like `JsonDSL.extractPathText(MY_TABLE.DATA_FIELD, "data", "productCode")` you can instead write:

`MY_TABLE.DATA_FIELD.extractPathText("data", "productCode")`.



The extension functions are available in the following packages:



- [`com.github.t9t.jooq.json.json`](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/json)

- [`com.github.t9t.jooq.json.jsonb`](https://javadoc.io/static/com.github.t9t.jooq/jooq-postgresql-json/4.0.0/com/github/t9t/jooq/json/jsonb)



The names of extension functions match the names of the methods on `JsonDSL` and `JsonbDSL`, except for `concat` and

`contains`, which are called `concatJson` and `containsJson` respectively to prevent clashes with existing methods

of `Field`.



## PostgreSQL json operator support

Reference: https://www.postgresql.org/docs/11/functions-json.html



Operators available for both `json` (through `JsonDSL`) and `jsonb` (through `JsonbDSL`):



| Op | Operand | Description | Method |

| --- | --- | --- | --- |

| `->` | `int` | Get array element | `arrayElement()` |

| `->` | `text` | Get object field | `fieldByKey()` |

| `->>` | `int` | Get array element as text | `arrayElementText()` |

| `->>` | `text` | Get object field as text | `fieldByKeyText()` |

| `#>` | `text[]` | Get object at path | `objectAtPath()` |

| `#>>` | `text[]` | Get object at path as text | `objectAtPathText()` |



Operators available only for `jsonb` (through `JsonbDSL`):



| Op | Operand | Description | Method |

| --- | --- | --- | --- |

| `@>` | `jsonb` | Does contain value? | `contains()` |

| `<@` | `jsonb` | Are entries contained? | `containedIn()` |

| `?` | `text` | Does the key exist? | `hasKey()` |

| ?| | `text[]` | Does any key exist? | `hasAnyKey()` |

| `?&` | `text[]` | Do all keys exist? | `hasAllKeys()` |

| || | `jsonb` | Concatenate values | `concat()` |

| `-` | `text` | Delete key or element | `delete()` |

| `-` | `text[]` | Delete multiple keys or elements | `delete()` |

| `-` | `int` | Delete array element | `deleteElement()` |

| `#-` | `text[]` | Delete field for path | `deletePath()` |



## Available PostgreSQL json processing functions

Reference: https://www.postgresql.org/docs/11/functions-json.html#FUNCTIONS-JSON-PROCESSING-TABLE



Processing functions available for both `json` (through `JsonDSL`) and `jsonb` (through `JsonbDSL`):



| Function | Return type | Description | Method |

| --- | --- | --- | --- |

| `json(b)_array_length` | `int` | Get length of JSON array | `arrayLength()` |

| `json(b)_extract_path` | `json`/`jsonb` | Extract object at path (same as `#>`) | `extractPath()` |

| `json(b)_extract_path_text` | `text` | Extract object at path as text (same as `#>>`) | `extractPathText()` |

| `json(b)_typeof` | `text` | Get the type of a JSON field | `typeOf()` |

| `json(b)_strip_nulls` | `json`/`jsonb` | Remove object fields with `null` values | `stripNulls()` |



Functions only available for `jsonb` (through `JsonbDSL`):



| Function | Return type | Description | Method |

| --- | --- | --- | --- |

| `jsonb_pretty` | `text` | Pretty format JSON field | `pretty()` |



## References

- [jOOQ.org](https://www.jooq.org/)

- [PostgreSQL JSON data types](https://www.postgresql.org/docs/current/datatype-json.html)



## Contributors

- [@davinkevin](https://github.com/davinkevin) was kind enough to implement Kotlin extension functions ([#11](https://github.com/t9t/jooq-postgresql-json/issues/11) and [#12](https://github.com/t9t/jooq-postgresql-json/pull/12))!