Skip to content

Conversation

@Jash271
Copy link
Contributor

@Jash271 Jash271 commented Oct 22, 2025

Description

Enable automatic GIN index creation for text array metadata fields in the PostgreSQL vector store. This allows fast array membership queries using PostgreSQL operators (?|, ?&, @>) without requiring raw SQL workarounds.

Changes:

  • Extended PGType to support text[] array type
  • Modified get_data_model() to create GIN indices for array fields and BTREE indices for scalar fields
  • Cast metadata to JSONB in GIN index creation for compatibility with both JSON and JSONB columns
  • Added comprehensive tests covering GIN index creation, CONTAINS, ANY, ALL operators, and mixed BTREE/GIN queries
  • Tests use PostgreSQL system catalogs (pg_class, pg_am) for type-safe index verification

This maintains backward compatibility - existing BTREE indices continue working, and GIN indices are only created when text[] is specified in indexed_metadata_keys.

Fixes #20128

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

  • Yes
  • No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.

  • I added new unit tests to cover this change
  • I believe this change is already covered by existing unit tests

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran uv run make format; uv run make lint to appease the lint gods

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Oct 22, 2025
Fixes run-llama#20128

Enable automatic GIN index creation for text array metadata fields in the PostgreSQL vector store. This allows fast array membership queries using PostgreSQL operators (?|, ?&, @>) without requiring raw SQL workarounds.

Changes:
- Extended PGType to support text[] array type
- Modified get_data_model() to create GIN indices for array fields and BTREE indices for scalar fields
- Cast metadata to JSONB in GIN index creation for compatibility with both JSON and JSONB columns
- Added comprehensive tests covering GIN index creation, CONTAINS, ANY, ALL operators, and mixed BTREE/GIN queries
- Tests use PostgreSQL system catalogs (pg_class, pg_am) for type-safe index verification

This maintains backward compatibility - existing BTREE indices continue working, and GIN indices are only created when text[] is specified in indexed_metadata_keys.
@Jash271 Jash271 force-pushed the postgres-gin-index-array-support branch from 9a44924 to cf737ce Compare October 22, 2025 12:04
Copy link
Member

@AstraBert AstraBert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm :)

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 23, 2025
@AstraBert AstraBert merged commit c1c6304 into run-llama:main Oct 23, 2025
10 of 11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request]: Add GIN index support for text array metadata fields in PostgreSQL vector store

2 participants