GIN index for arrays and JSONB in PostgreSQL - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a GIN index in PostgreSQL?

A GIN (Generalized Inverted Index) index helps speed up searches on columns containing complex data types like arrays and JSONB by indexing their individual elements.

beginner

Why use a GIN index for JSONB columns?

Because JSONB stores nested data, a GIN index allows fast searching inside the JSON structure, like finding keys or values without scanning the whole table.

beginner

How do you create a GIN index on a JSONB column named 'data' in a table 'items'?

Use the SQL command:
CREATE INDEX idx_gin_data ON items USING GIN (data);

intermediate

What types of queries benefit most from GIN indexes on arrays or JSONB?

Queries that check if an array contains a value or if JSONB contains a key or value, for example using operators like @> or ?.

beginner

Can GIN indexes be used on regular text columns?

No, GIN indexes are designed for complex data types like arrays, JSONB, and full-text search, not for simple text columns.

What does GIN stand for in PostgreSQL indexing?

A General Index Node

B Generalized Inverted Index

C Global Indexed Network

D Generic Internal Notation

GIN stands for Generalized Inverted Index, which is used for indexing complex data types.

Which PostgreSQL data type commonly uses GIN indexes for faster queries?

A INTEGER

B VARCHAR

C JSONB

D DATE

JSONB columns benefit from GIN indexes because they store nested data structures.

Which SQL command creates a GIN index on a column named 'tags' in table 'products'?

A CREATE INDEX idx ON products USING GIN (tags);

B CREATE GIN INDEX idx ON products (tags);

C CREATE INDEX idx ON products (tags) USING GIN;

D CREATE INDEX idx USING GIN ON products (tags);

The correct syntax is: CREATE INDEX index_name ON table_name USING GIN (column_name);

Which operator is commonly used with GIN indexes on JSONB to check if one JSON contains another?

A @>

B <@

C ->

D ||

The '@>' operator checks if the left JSONB contains the right JSONB, and works efficiently with GIN indexes.

What is a key benefit of using GIN indexes on arrays?

A Automatic data compression

B Faster full table scans

C Smaller database size

D Faster searches for elements inside arrays

GIN indexes speed up searches for specific elements inside arrays by indexing each element.

Explain how a GIN index improves query performance on JSONB columns.

Think about how searching inside nested data can be slow without indexing.

Describe the steps to create and use a GIN index on an array column in PostgreSQL.

Focus on syntax and query patterns that use 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