> This page location: JSON Functions > jsonb_to_record > Full Neon documentation index: https://neon.com/docs/llms.txt # PostgreSQL jsonb_to_record() Function **Summary**: in this tutorial, you will learn how to use the PostgreSQL `jsonb_to_record()` function to convert a JSON object into a PostgreSQL record type. ## Introduction to the PostgreSQL JSONB jsonb_to_record() function The `jsonb_to_record()` function allows you to convert a [JSON](../postgresql-tutorial/postgresql-json) object into a PostgreSQL record type. Here's the basic syntax of the `jsonb_to_record()` function: ```sql jsonb_to_record(json_object) as record_type (column1 type, column2 type,...) ``` In this syntax: - First, specify a JSON object (`json_object`) of type JSONB that you want to convert into a record type. - Second, define the `record_type` with a list of columns that have the same names as the keys in the JSON object. The record may have fewer columns than the number of keys in the JSON object. If the names of the columns of the `record_type` are not the same as the names of the keys in the JSON object, they will be ignored. The function `jsonb_to_record()` returns a record type representing the structure of a JSON object. If the `json_object` is null, the `jsonb_to_record()` function returns null. ## PostgreSQL jsonb_to_record() function examples Let's take some examples of using the `jsonb_to_record()` function. ### 1) Basic PostgreSQL jsonb_to_record() function examples The following example uses the `jsonb_to_record()` function to convert a JSON object into a record: ```sql SELECT * FROM jsonb_to_record( '{"id": 1, "name": "Alice", "age": 30}' ) AS person (id INT, name TEXT, age INT); ``` Output: ```text id | name | age ----+-------+----- 1 | Alice | 30 (1 row) ``` The following example converts a JSON object into a record type but with fewer keys: ```sql SELECT * FROM jsonb_to_record( '{"id": 1, "name": "Alice", "age": 30}' ) AS person (id INT, name TEXT); ``` Output: ```text id | name ----+------- 1 | Alice (1 row) ``` ### 2) Using jsonb_to_record() function with user-defined type First, create a new custom type called `pet` with two fields `type` and `name`: ```sql CREATE TYPE pet AS (type VARCHAR, name VARCHAR); ``` Second, use the pet type with the `jsonb_to_record()` function: ```sql SELECT * FROM jsonb_to_record( '{"id": 1, "name": "Alice", "age": 30, "pets": [{"type":"cat", "name": "Ellie"}, {"type":"dog", "name": "Birdie"}]}' ) AS person (id INT, name TEXT, pets pet[]); ``` Output: ```text id | name | pets ----+-------+-------------------------------- 1 | Alice | {"(cat,Ellie)","(dog,Birdie)"} (1 row) ``` ## Summary - Use the `jsonb_to_record()` function to convert a JSON object into a PostgreSQL record type. --- ## Related docs (JSON Functions) - [Extracting JSON Data](https://neon.com/postgresql/postgresql-json-functions/postgresql-json-extract) - [JSONB Operators](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb-operators) - [jsonb_agg](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_agg) - [jsonb_array_elements](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_array_elements) - [jsonb_array_elements_text](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_array_elements_text) - [jsonb_array_length](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_array_length) - [jsonb_build_array](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_build_array) - [jsonb_build_object](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_build_object) - [jsonb_each](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_each) - [jsonb_each_text](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_each_text) - [jsonb_extract_path](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_extract_path) - [jsonb_extract_path_text](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_extract_path_text) - [jsonb_insert](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_insert) - [jsonb_object](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_object) - [jsonb_object_agg](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_object_agg) - [jsonb_object_keys](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_object_keys) - [JSON Path](https://neon.com/postgresql/postgresql-json-functions/postgresql-json-path) - [jsonb_path_exists](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_path_exists) - [jsonb_path_query](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_path_query) - [jsonb_path_query_array](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_path_query_array) - [jsonb_path_query_first](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_path_query_first) - [jsonb_pretty](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_pretty) - [jsonb_set](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_set) - [jsonb_strip_nulls](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_strip_nulls) - [jsonb_populate_record](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_populate_record) - [jsonb_populate_recordset](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_populate_recordset) - [jsonb_typeof](https://neon.com/postgresql/postgresql-json-functions/postgresql-jsonb_typeof) - [row_to_json](https://neon.com/postgresql/postgresql-json-functions/postgresql-row_to_json) - [to_jsonb](https://neon.com/postgresql/postgresql-json-functions/postgresql-to_jsonb)