GIN index for arrays and JSONB in PostgreSQL

Introduction

A GIN index helps find items inside arrays or JSONB data quickly, making searches faster.

When you want to search for specific values inside an array column.

When you need to query parts of JSONB data efficiently.

When your table has many rows with array or JSONB columns and you want faster lookups.

When you often use operators like @> or ? on arrays or JSONB columns.

When you want to improve performance of complex queries on nested data.

Syntax

PostgreSQL

CREATE INDEX index_name ON table_name USING GIN (column_name);

GIN stands for Generalized Inverted Index, which is good for indexing composite data like arrays and JSONB.

You must have the "pg_trgm" or "btree_gin" extension installed for some advanced GIN index features.

Examples

Creates a GIN index on the 'tags' array column in the 'products' table.

PostgreSQL

CREATE INDEX idx_tags ON products USING GIN (tags);

Creates a GIN index on the 'data' JSONB column in the 'events' table.

PostgreSQL

CREATE INDEX idx_data ON events USING GIN (data);

Creates a GIN index on the 'content' JSONB column using jsonb_path_ops for faster path queries.

PostgreSQL

CREATE INDEX idx_jsonb_path ON documents USING GIN (content jsonb_path_ops);

Sample Program

This example creates a table with an array column, inserts some rows, creates a GIN index on the array column, and queries for rows containing a specific tag.

PostgreSQL

CREATE TABLE books (
  id SERIAL PRIMARY KEY,
  title TEXT,
  tags TEXT[]
);

INSERT INTO books (title, tags) VALUES
('Learn SQL', ARRAY['database', 'sql', 'learning']),
('JSON Guide', ARRAY['json', 'data', 'guide']),
('PostgreSQL Tips', ARRAY['postgresql', 'database', 'tips']);

CREATE INDEX idx_books_tags ON books USING GIN (tags);

-- Query to find books tagged with 'database'
SELECT id, title, tags FROM books WHERE tags @> ARRAY['database'];

Important Notes

GIN indexes speed up searches inside arrays and JSONB but can be slower to update when data changes.

They use more disk space than regular indexes because they store entries for each element inside the array or JSONB.

Use GIN indexes when you query with operators like @>, ?, or ?| on arrays or JSONB columns.

Summary

GIN indexes help search inside arrays and JSONB data quickly.

They are useful when you query for specific elements inside these complex types.

Creating a GIN index is simple and improves query speed but may slow down inserts and updates.

Practice

1. What is the main purpose of a GIN index in PostgreSQL when used with arrays or JSONB columns?

easy

A. To speed up searches for specific elements inside arrays or JSONB data

B. To compress the data stored in arrays or JSONB columns

C. To automatically update array or JSONB data when rows change

D. To enforce uniqueness on array or JSONB columns

Solution

1. Step 1: Understand GIN index purpose

   GIN indexes are designed to speed up searches inside complex data types like arrays and JSONB by indexing their elements.

2. Step 2: Compare options

   Options B, C, and D describe compression, automatic updates, and uniqueness enforcement, which are not the main roles of GIN indexes.

3. Final Answer:

   To speed up searches for specific elements inside arrays or JSONB data -> Option A

4. Quick Check:

   GIN index purpose = speed up element search [OK]

Hint: GIN indexes speed up element searches inside arrays/JSONB [OK]

Common Mistakes:

• Confusing GIN with data compression
• Thinking GIN enforces uniqueness
• Assuming GIN auto-updates data

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 HASH (data);

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

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

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

Solution

1. Step 1: Identify correct index type for JSONB

   GIN indexes are created using USING GIN and applied directly on the JSONB column.

2. Step 2: Check syntax correctness

   CREATE INDEX idx_data ON items USING GIN (data); uses correct syntax: CREATE INDEX idx_data ON items USING GIN (data); CREATE INDEX idx_data ON items USING GIN (data jsonb_path_ops); is invalid because jsonb_path_ops must be specified inside parentheses, e.g., data jsonb_path_ops is incorrect syntax here.

3. Final Answer:

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

4. Quick Check:

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

Hint: Use 'USING GIN (column)' to create GIN index on JSONB [OK]

Common Mistakes:

• Using BTREE or HASH instead of GIN
• Incorrect syntax with jsonb_path_ops
• Missing USING keyword

3. Given the table products with a JSONB column tags and a GIN index on tags, what will the following query return?

SELECT id FROM products WHERE tags @> '["organic"]';

medium

A. All product ids where the tags array contains the element 'organic'

B. All product ids where the tags array is exactly '["organic"]'

C. All product ids where the tags array contains any element

D. Syntax error due to incorrect JSONB operator

Solution

1. Step 1: Understand the JSONB containment operator @>

   The operator @> checks if the left JSONB contains the right JSONB. Here, it checks if tags contains the element 'organic'.

2. Step 2: Analyze the query result

   The query returns all product ids where the tags array includes 'organic' anywhere, not just exact match or any element.

3. Final Answer:

   All product ids where the tags array contains the element 'organic' -> Option A

4. Quick Check:

   tags @> '["organic"]' means contains 'organic' [OK]

Hint: Use @> to check if JSONB contains specific element [OK]

Common Mistakes:

• Thinking @> means exact match
• Confusing @> with existence of any element
• Assuming syntax error with @>

4. You created a GIN index on a JSONB column info but your queries using info @> '{"key": "value"}' are still slow. What is the most likely cause?

medium

A. GIN indexes do not support the @> operator

B. The queries are missing the WHERE clause

C. The GIN index was created without the jsonb_path_ops operator class

D. The JSONB column contains NULL values

Solution

1. Step 1: Understand GIN index operator classes

   GIN indexes on JSONB can use default or jsonb_path_ops operator class. The latter is optimized for existence queries using @>.

2. Step 2: Identify cause of slow queries

   If the index was created without jsonb_path_ops, the index may not efficiently support @> queries, causing slow performance.

3. Final Answer:

   The GIN index was created without the jsonb_path_ops operator class -> Option C

4. Quick Check:

   Missing jsonb_path_ops = slow @> queries [OK]

Hint: Use jsonb_path_ops for faster @> queries on JSONB [OK]

Common Mistakes:

• Assuming GIN doesn't support @>
• Ignoring operator class choice
• Blaming NULL values for index slowness

5. You want to create a GIN index on a table orders with a column items that stores an array of integers. Which statement correctly creates the index and optimizes queries checking if an integer is present in the array?

hard

A. CREATE INDEX idx_items_gin ON orders USING GIN (items gin_int_ops);

B. CREATE INDEX idx_items_gin ON orders USING GIN (items gin__int_ops);

C. CREATE INDEX idx_items_gin ON orders USING GIN (items gin__intarray_ops);

D. CREATE INDEX idx_items_gin ON orders USING GIN (items);

Solution

1. Step 1: Identify correct GIN index syntax for integer arrays

   For integer arrays, the default GIN index supports containment and membership queries without specifying operator classes.

2. Step 2: Validate options

   Options B, C, and D use invalid operator class names like gin__int_ops or gin__intarray_ops, which do not exist in PostgreSQL.

3. Final Answer:

   CREATE INDEX idx_items_gin ON orders USING GIN (items); -> Option D

4. Quick Check:

   Default GIN index on array column = CREATE INDEX idx_items_gin ON orders USING GIN (items); [OK]

Hint: Use default GIN index on array column without extra ops [OK]

Common Mistakes:

• Using non-existent operator classes
• Adding unnecessary syntax after column name
• Confusing GIN with other index types