Available in versions: Dev (3.20) | Latest (3.19) | 3.18

JSON object attribute access with -> or ->>

Applies to ✅ Open Source Edition   ✅ Express Edition   ✅ Professional Edition   ✅ Enterprise Edition

JSON object attributes can be accessed by key as follows:

SELECT
  '{"a":1}'::json->'a'
create.select(jsonGetAttribute(json("{\"a\":1}"), "a"))
      .fetch();

The result would look like this:

+--------------------+
| json_get_attribute |
+--------------------+
| 1                  |
+--------------------+

The API is PostgreSQL inspired, and as such, there are two ways of accessing attributes:

Dialect support

This example using jOOQ:

jsonGetAttribute(json("{\"a\":1}"), "a")

Translates to the following dialect specific expressions:

Aurora Postgres, CockroachDB, Postgres, YugabyteDB

(CAST('{"a":1}' AS json)->'a')

ClickHouse

JSONExtractRaw('{"a":1}', 'a')

DB2

coalesce(
  json_query(
    '{"a":1}',
    ('$.' || CAST('a' AS varchar(3998)))
  ),
  nvl2(
    json_query(
      '{"a":1}',
      ('$.' || CAST('a' AS varchar(3998))) EMPTY ARRAY ON EMPTY
    ),
    NULL,
    'null'
  )
)

MariaDB, MySQL

json_extract(
  '{"a":1}',
  concat('$.', 'a')
)

Oracle

json_query(
  '{"a":1}',
  '$.a'
)

Snowflake

get(parse_json('{"a":1}'), 'a')

SQLite

('{"a":1}'->'a')

Trino

json_extract(
  json_parse('{"a":1}'),
  ('$.' || 'a')
)

ASE, Access, Aurora MySQL, BigQuery, Derby, DuckDB, Exasol, Firebird, H2, HSQLDB, Hana, Informix, MemSQL, Redshift, SQLDataWarehouse, SQLServer, Sybase, Teradata, Vertica

/* UNSUPPORTED */

(These are currently generated with jOOQ 3.20, see #10141), or translate your own on our website

References to this page

Feedback

Do you have any feedback about this page? We'd love to hear it!

The jOOQ Logo