Indexing JSONB with GIN in PostgreSQL - Step-by-Step Execution

Concept Flow - Indexing JSONB with GIN

Create Table with JSONB Column

↓

Insert JSONB Data

↓

Create GIN Index on JSONB Column

↓

Query Using JSONB Operators

↓

PostgreSQL Uses GIN Index to Speed Up Search

↓

Return Results

This flow shows how to create a table with a JSONB column, add a GIN index on it, and then run queries that use the index to quickly find matching JSON data.

Execution Sample

PostgreSQL

CREATE TABLE products (id serial PRIMARY KEY, info JSONB);
INSERT INTO products (info) VALUES
  ('{"name": "apple", "color": "red"}'),
  ('{"name": "banana", "color": "yellow"}');
CREATE INDEX idx_gin_info ON products USING GIN (info);
SELECT * FROM products WHERE info @> '{"color": "red"}';

Create a table with JSONB data, insert two products, create a GIN index on the JSONB column, then query for products where color is red.

Execution Table

Step	Action	Details	Result
1	Create Table	Table 'products' with 'info' JSONB column created	Table ready
2	Insert Row 1	Insert JSONB {'name': 'apple', 'color': 'red'}	Row inserted
3	Insert Row 2	Insert JSONB {'name': 'banana', 'color': 'yellow'}	Row inserted
4	Create GIN Index	Index 'idx_gin_info' created on 'info' column	Index ready
5	Query	Select rows where info contains {'color': 'red'}	Uses GIN index to find matching rows
6	Return Result	Row with 'apple' returned	Query result: 1 row

💡 Query completes after using GIN index to efficiently find matching JSONB data

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 5	Final
products table	empty	1 row (apple)	2 rows (apple, banana)	2 rows (apple, banana)	2 rows (apple, banana)	2 rows (apple, banana)
GIN index	none	none	none	created on info	used for query	used for query
Query result	none	none	none	none	1 row (apple)	1 row (apple)

Key Moments - 3 Insights

Why do we create a GIN index on the JSONB column?

The GIN index helps PostgreSQL quickly find rows where the JSONB data matches a condition, as shown in step 5 where the query uses the index to find the 'apple' row efficiently.

What does the operator '@>' mean in the query?

The '@>' operator means 'contains'. In the query (step 5), it checks if the JSONB column contains the key-value pair {'color': 'red'}, which matches the 'apple' row.

Does the GIN index store the whole JSON document?

No, the GIN index stores keys and values in a way that allows fast searching for parts of the JSON, not the entire document, which is why it speeds up queries like in step 5.

Visual Quiz - 3 Questions

Look at the execution table, what is the state of the 'products' table after step 3?

A 2 rows with 'apple' and 'banana'

B 1 row with 'apple'

C Empty

D 3 rows with 'apple', 'banana', and another

💡 Hint

Check the 'products table' row in variable_tracker after step 3

At which step is the GIN index created?

A Step 2

B Step 5

C Step 4

D Step 6

💡 Hint

Look at the 'Action' column in execution_table where index creation is mentioned

If we query for color 'yellow' instead of 'red', what would change in the execution table?

A No rows would be returned

B Step 5 would find the 'banana' row instead of 'apple'

C The GIN index would not be used

D The table would have more rows

💡 Hint

Consider how the query condition affects which rows match in step 5

Concept Snapshot

PostgreSQL JSONB GIN Index:
- Create table with JSONB column
- Insert JSON data
- Create GIN index on JSONB column
- Query using '@>' operator to check containment
- GIN index speeds up JSONB key/value searches
- Use for fast filtering on JSONB fields

Full Transcript

This visual execution trace shows how to use a GIN index on a JSONB column in PostgreSQL. First, a table named 'products' is created with a JSONB column called 'info'. Then two rows are inserted with JSON data representing products 'apple' and 'banana'. Next, a GIN index is created on the 'info' column to speed up queries. When a query searches for products where the JSONB data contains the key-value pair 'color' equal to 'red', PostgreSQL uses the GIN index to quickly find the matching row with 'apple'. The trace shows each step, the state of the table and index, and how the query result is returned efficiently. Key points include understanding the '@>' operator for containment and how the GIN index stores JSON keys and values for fast searching.

Practice

1. What is the main purpose of creating a GIN index on a JSONB column in PostgreSQL?

easy

A. To convert JSONB data into plain text for easier reading

B. To compress the JSONB data to save disk space

C. To automatically backup JSONB data to another table

D. To speed up queries that search for specific keys or values inside the JSONB data

Solution

1. Step 1: Understand GIN index purpose

   GIN indexes are designed to speed up searches inside complex data types like JSONB by indexing keys and values.

2. Step 2: Identify the benefit for JSONB queries

   Queries using operators like @> that check for existence of keys or values run faster with GIN indexes.

3. Final Answer:

   To speed up queries that search for specific keys or values inside the JSONB data -> Option D

4. Quick Check:

   GIN index = faster JSONB key/value search [OK]

Hint: GIN indexes speed up JSONB key/value searches [OK]

Common Mistakes:

• Thinking GIN compresses JSONB data
• Confusing GIN with backup or conversion tools
• Assuming GIN indexes speed up all query types

2. Which of the following is the correct syntax to create a GIN index on a JSONB column named data in a table items?

easy

A. CREATE INDEX idx_data ON items USING GIN (data);

B. CREATE INDEX idx_data ON items USING BTREE (data);

C. CREATE INDEX idx_data ON items USING GIN (data (jsonb_path_ops));

D. CREATE INDEX idx_data ON items USING HASH (data);

Solution

1. Step 1: Recall correct GIN index syntax

   The standard way to create a GIN index on a JSONB column is: CREATE INDEX index_name ON table_name USING GIN (column_name);

2. Step 2: Check options for correctness

   CREATE INDEX idx_data ON items USING GIN (data); matches the correct syntax. CREATE INDEX idx_data ON items USING BTREE (data); uses BTREE which is not suitable for JSONB. CREATE INDEX idx_data ON items USING GIN (data (jsonb_path_ops)); has incorrect syntax (extra parentheses around jsonb_path_ops). CREATE INDEX idx_data ON items USING HASH (data); uses HASH which is not valid for JSONB indexing.

3. Final Answer:

   CREATE INDEX idx_data ON items USING GIN (data); -> Option A

4. Quick Check:

   Correct GIN index syntax = CREATE INDEX idx_data ON items USING GIN (data); [OK]

Hint: Use USING GIN with column name in parentheses [OK]

Common Mistakes:

• Using BTREE or HASH instead of GIN
• Incorrect syntax with extra keywords
• Missing parentheses around column name

3. Given a table products with a JSONB column attributes and a GIN index on it, what will this query return?

SELECT * FROM products WHERE attributes @> '{"color": "red"}';

medium

A. All rows where the JSONB column contains the key "color" with value "red"

B. All rows where the JSONB column contains any key named "color"

C. All rows where the JSONB column contains the value "red" anywhere

D. Syntax error due to incorrect JSON format

Solution

1. Step 1: Understand the @> operator

   The @> operator checks if the left JSONB contains the right JSONB as a subset, meaning the key-value pair must exist exactly.

2. Step 2: Analyze the query condition

   The condition attributes @> '{"color": "red"}' means the JSONB column must have a key "color" with value "red".

3. Final Answer:

   All rows where the JSONB column contains the key "color" with value "red" -> Option A

4. Quick Check:

   @> means contains key-value pair exactly [OK]

Hint: Use @> to find exact key-value pairs in JSONB [OK]

Common Mistakes:

• Thinking @> matches only keys, not values
• Assuming it matches any occurrence of value
• Confusing JSON syntax causing errors

4. You created a GIN index on a JSONB column but your queries are still slow. What is the most likely cause?

medium

A. The GIN index does not support JSONB data types

B. The index was created without specifying the JSONB column

C. The queries are not using the @> operator

D. The table has no rows

Solution

1. Step 1: Understand when GIN index helps

   GIN indexes on JSONB columns speed up queries that use operators like @> which check for containment.

2. Step 2: Identify why queries remain slow

   If queries do not use @> or other supported operators, the index won't be used, causing slow performance.

3. Final Answer:

   The queries are not using the @> operator -> Option C

4. Quick Check:

   GIN index helps only with supported operators [OK]

Hint: Use @> operator to leverage GIN index speedup [OK]

Common Mistakes:

• Assuming GIN indexes speed up all JSONB queries
• Not verifying query operator usage
• Thinking GIN index doesn't support JSONB

5. You want to create a GIN index on a JSONB column info in table users to optimize queries checking for existence of specific keys only, ignoring values. Which index operator class should you use?

hard

A. jsonb_ops

B. jsonb_path_ops

C. btree_gin

D. hash_ops

Solution

1. Step 1: Understand GIN operator classes for JSONB

   PostgreSQL provides two main operator classes for JSONB GIN indexes: jsonb_ops (default) indexes keys and values, and jsonb_path_ops indexes only keys for existence queries.

2. Step 2: Choose operator class for key existence queries

   Since the goal is to optimize queries checking for key existence only, jsonb_path_ops is the best choice as it creates a smaller, faster index for this purpose.

3. Final Answer:

   jsonb_path_ops -> Option B

4. Quick Check:

   Key-only queries use jsonb_path_ops [OK]

Hint: Use jsonb_path_ops for key-existence queries [OK]

Common Mistakes:

• Using default jsonb_ops which indexes values too
• Choosing unrelated operator classes like btree_gin
• Confusing hash_ops with GIN operator classes