Kinto / kinto / 22177292786

100%

master: 100%

push

github

Use JSONB containment for GIN-friendly EQ filters (#3646)

* Use JSONB containment (@>) for EQ filters on scalar values

Rewrite _format_conditions to emit `data @> '{"field": value}'` instead
of `data->'field' = 'value'::jsonb` for equality filters on scalar data
fields (str, int, float, bool, None). This is semantically equivalent
for scalars but enables GIN index acceleration when a
`gin(data jsonb_path_ops)` index exists on the objects table.

Array and object EQ values still use the arrow extraction path to
preserve exact equality semantics (containment uses superset matching
for non-scalars).

Also normalizes _format_sorting JSONB accessor expressions to match
_format_conditions format (removing redundant parentheses around
placeholders), ensuring expression indexes work for both filter and
sort queries.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Use top-level containment for CONTAINS filters and document GIN index

Rewrite CONTAINS filters to use `data @> '{"field": [values]}'` instead
of `data->'field' @> '[values]'`. Top-level containment allows a GIN
index on the data column to accelerate these queries. The jsonb_typeof
guard is no longer needed since containment already returns false when
the field is not an array.

Add documentation to the Storage class docstring describing the
recommended GIN index, what it accelerates, what it doesn't, and
approximate sizing.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Document recommended, basic, and composite GIN index options

Expand the GIN index documentation with three options:

1. Recommended: partial index with WHERE resource_name = 'record'
   (smallest, scoped to actual records, works with psycopg2)
2. Basic: partial index with WHERE NOT deleted only
   (driver-independent fallback)
3. Composite: btree_gin extension with parent_id + resource_name
   in the GIN index (single index scan, no BitmapAnd needed)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>... (continued)

1532 of 1532 branches covered (100.0%)

43 of 43 new or added lines in 2 files covered. (100.0%)

7844 of 7844 relevant lines covered (100.0%)

3.0 hits per line