GIN index for arrays and JSONB in PostgreSQL - Mini Project: Build & Apply

Creating and Using GIN Indexes for Arrays and JSONB in PostgreSQL

📖 Scenario: You are managing a PostgreSQL database for a book store. The store keeps track of books with tags and additional metadata stored as JSONB. To speed up searches on tags and JSONB fields, you want to create GIN indexes.

🎯 Goal: Build a PostgreSQL table with array and JSONB columns, then create GIN indexes on these columns to optimize search queries.

📋 What You'll Learn

Create a table called books with columns id (integer primary key), title (text), tags (text array), and metadata (JSONB).

Insert three specific rows into the books table with given values.

Create a GIN index on the tags column.

Create a GIN index on the metadata column.

💡 Why This Matters

🌍 Real World

Many modern applications store tags as arrays and flexible data as JSONB in PostgreSQL. GIN indexes help speed up searches on these complex data types.

💼 Career

Database administrators and backend developers often create GIN indexes to improve query performance on array and JSONB columns in PostgreSQL.

1

Create the books table with array and JSONB columns

Write a SQL statement to create a table called books with these columns: id as an integer primary key, title as text, tags as a text array, and metadata as JSONB.

PostgreSQL

-- Write the CREATE TABLE statement for books with id, title, tags (text[]), and metadata (JSONB)
-- Your code here

Hint

Use SERIAL PRIMARY KEY for id. Define tags as TEXT[] and metadata as JSONB.

2

Insert three rows into the books table

Insert these three rows into books:
1. title: 'PostgreSQL Basics', tags: ['database', 'sql'], metadata: {'author': 'Alice', 'year': 2020}
2. title: 'Advanced SQL', tags: ['database', 'sql', 'advanced'], metadata: {'author': 'Bob', 'year': 2021}
3. title: 'JSON and Arrays', tags: ['json', 'arrays'], metadata: {'author': 'Carol', 'year': 2022}

PostgreSQL

CREATE TABLE books (
    id SERIAL PRIMARY KEY,
    title TEXT NOT NULL,
    tags TEXT[],
    metadata JSONB
);
-- Insert the three rows into books
-- Your code here

Hint

Use ARRAY[...] syntax for the tags array. Use JSON syntax inside single quotes for metadata.

3

Create a GIN index on the tags column

Write a SQL statement to create a GIN index named idx_books_tags on the tags column of the books table.

PostgreSQL

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

INSERT INTO books (title, tags, metadata) VALUES
('PostgreSQL Basics', ARRAY['database', 'sql'], '{"author": "Alice", "year": 2020}'),
('Advanced SQL', ARRAY['database', 'sql', 'advanced'], '{"author": "Bob", "year": 2021}'),
('JSON and Arrays', ARRAY['json', 'arrays'], '{"author": "Carol", "year": 2022}');
-- Create a GIN index on tags
-- Your code here

Hint

Use CREATE INDEX idx_books_tags ON books USING GIN (tags); to create the index.

4

Create a GIN index on the metadata JSONB column

Write a SQL statement to create a GIN index named idx_books_metadata on the metadata column of the books table.

PostgreSQL

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

INSERT INTO books (title, tags, metadata) VALUES
('PostgreSQL Basics', ARRAY['database', 'sql'], '{"author": "Alice", "year": 2020}'),
('Advanced SQL', ARRAY['database', 'sql', 'advanced'], '{"author": "Bob", "year": 2021}'),
('JSON and Arrays', ARRAY['json', 'arrays'], '{"author": "Carol", "year": 2022}');

CREATE INDEX idx_books_tags ON books USING GIN (tags);
-- Create a GIN index on metadata
-- Your code here

Hint

Use CREATE INDEX idx_books_metadata ON books USING GIN (metadata); to create the index.

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