fix: force gin for olap lists by grutt · Pull Request #4403 · hatchet-dev/hatchet

grutt · 2026-07-10T22:16:17Z

Description

Adds GIN and updates queries to favor GINS if tenant entitlement flag is enabled.
Introduces a new AND filter which is more performant and preferred. Sets UI to use this by default.

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

What's Changed

Adds a tenant entitlement for strict additional metadata filters.
Routes workflow-run and task-list metadata filters through jsonb containment when the entitlement is enabled.
Adds OLAP GIN indexes and a migration for existing run/task partitions.
Updates sqlc models and entitlement upsert/read paths for the new flag.

Checklist

Changes have been:

Tested (unit, integration, or manually with steps specified)
Linted and formatted
Documented (where applicable)
Added to CHANGELOG (where applicable) -- see Keep a Changelog

🤖 AI Disclosure

I acknowledge that an LLM was used in the creation of this Pull Request, in accordance with Hatchet's AI_POLICY.md.
Details: Cursor was used to draft the PR description and fix a Go lint shadowing issue before opening the PR.

vercel · 2026-07-10T22:16:23Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
hatchet-docs	Ready	Preview, Comment	Jul 14, 2026 8:15pm

github-actions · 2026-07-13T19:42:08Z

Benchmark results

goos: linux
goarch: amd64
pkg: github.com/hatchet-dev/hatchet/pkg/scheduling/v1
cpu: AMD Ryzen 9 7950X3D 16-Core Processor          
                                         │ /tmp/old.txt │            /tmp/new.txt            │
                                         │    sec/op    │    sec/op     vs base              │
RateLimiter-8                              54.30µ ± 12%   52.35µ ± 26%       ~ (p=0.937 n=6)
Scheduler_Replenish_DenseSharedActions-8   14.05m ±  1%   13.80m ±  1%  -1.74% (p=0.004 n=6)
geomean                                    873.5µ         850.1µ        -2.68%

                                         │ /tmp/old.txt │            /tmp/new.txt            │
                                         │     B/op     │     B/op      vs base              │
RateLimiter-8                              137.7Ki ± 0%   137.7Ki ± 0%       ~ (p=0.154 n=6)
Scheduler_Replenish_DenseSharedActions-8   11.69Mi ± 0%   11.69Mi ± 0%       ~ (p=0.699 n=6)
geomean                                    1.254Mi        1.254Mi       -0.00%

                                         │ /tmp/old.txt │            /tmp/new.txt             │
                                         │  allocs/op   │  allocs/op   vs base                │
RateLimiter-8                               1.022k ± 0%   1.022k ± 0%       ~ (p=1.000 n=6) ¹
Scheduler_Replenish_DenseSharedActions-8    17.46k ± 0%   17.46k ± 0%       ~ (p=0.913 n=6)
geomean                                     4.224k        4.224k       -0.00%
¹ all samples are equal

_{Compared against main (c686cf5)}

grutt · 2026-07-13T20:49:39Z

mrkaye97 · 2026-07-13T21:05:40Z

 	spanContext, span := telemetry.NewSpan(ctx.Request().Context(), "v1-workflow-runs-list")
 	defer span.End()

+	strictAdditionalMetadata := false


not sure I understand the naming here - what's the difference between strict metadata and using the "and" operator here?

updated name... but i want to drop this later this week anyway before we lose context on this whole thing

mrkaye97 · 2026-07-13T21:06:00Z

+-- +goose StatementBegin
+
+ALTER TABLE tenant_entitlement
+ADD COLUMN IF NOT EXISTS strict_additional_metadata_filters BOOLEAN NOT NULL DEFAULT FALSE;


let's rm IF NOT EXISTS (and IF EXISTS in the down)

already ran via script... i think this is fine for now

fwiw, this is about the local dev experience, not really about any risk in prod - having IF NOT EXISTS on things like this just masks bugs with no real value: either we don't need it (the schema is up to date with the migrations), or if we do need it, the schema isn't, which is a bug

mrkaye97 · 2026-07-13T21:06:41Z

+CREATE INDEX IF NOT EXISTS ix_v1_tasks_olap_additional_metadata_gin
+    ON ONLY v1_tasks_olap USING gin (additional_metadata jsonb_path_ops);
+
+CREATE INDEX IF NOT EXISTS ix_v1_runs_olap_additional_metadata_gin
+    ON ONLY v1_runs_olap USING gin (additional_metadata jsonb_path_ops);


rm if not exists for these too? I'd prefer if we deployed by running your script, and once it completed, we create the parent index

mrkaye97 · 2026-07-13T21:10:07Z

-		params.Values = append(params.Values, value.(string))
-		countParams.Keys = append(countParams.Keys, key)
-		countParams.Values = append(countParams.Values, value.(string))
+	if opts.StrictAdditionalMetadata && len(opts.AdditionalMetadata) > 0 {


should this check the operator and not this strict flag?

mrkaye97 · 2026-07-13T21:12:58Z

+const countTasksMetadataContainsAll = `-- name: CountTasksMetadataContainsAll :one
+WITH filtered AS (
+    SELECT


the split queries here kind of suck - is there no other way that doesn't require all this duplication?

not that ensures we use the right indexes afict

github-actions · 2026-07-13T21:20:02Z

⚠️ Optional test failure: The load-deadlock job failed on this PR (optimistic-scheduling=false). This check is non-mandatory and does not block merging, but may be worth investigating. View logs

github-actions · 2026-07-14T19:55:51Z

⚠️ Optional test failure: The old-engine-new-sdk (TypeScript) job failed on this PR. This check is non-mandatory and does not block merging, but may be worth investigating. View logs

fix: force gin for olap lists

9a16eb9

github-actions Bot added the engine Related to the core Hatchet engine label Jul 10, 2026

vercel Bot deployed to Preview July 10, 2026 22:19 View deployment

drop gin from migration

bc920ed

vercel Bot deployed to Preview July 10, 2026 22:27 View deployment

fix: only one db

569ea02

vercel Bot deployed to Preview July 10, 2026 22:31 View deployment

grutt added 2 commits July 10, 2026 18:33

drop all migrations

5303c5d

parallel gin

bace22a

vercel Bot deployed to Preview July 11, 2026 10:56 View deployment

grutt added 2 commits July 11, 2026 06:57

force query plan

f89ba40

gin backed or

6e64cfb

vercel Bot deployed to Preview July 11, 2026 11:18 View deployment

chore: minimal migration

4014b90

vercel Bot deployed to Preview July 13, 2026 19:44 View deployment

grutt added 2 commits July 13, 2026 15:58

Merge remote-tracking branch 'origin/main' into fix--force-gin-for-olap

faeb830

feat: expose option on the api

22307c4

github-actions Bot added the dashboard Related to the Hatchet dashboard label Jul 13, 2026

vercel Bot deployed to Preview July 13, 2026 20:32 View deployment

leeent

ad0d4f6

grutt requested a review from mrkaye97 July 13, 2026 20:49

vercel Bot deployed to Preview July 13, 2026 20:52 View deployment

generate

586a746

vercel Bot deployed to Preview July 13, 2026 21:11 View deployment

mrkaye97 reviewed Jul 13, 2026

View reviewed changes

Merge branch 'main' into fix--force-gin-for-olap

39711e7

vercel Bot deployed to Preview July 14, 2026 19:47 View deployment

fix local tooling

adbd107

vercel Bot deployed to Preview July 14, 2026 20:01 View deployment

var name

eecef92

grutt requested a review from mrkaye97 July 14, 2026 20:12

vercel Bot deployed to Preview July 14, 2026 20:15 View deployment

mrkaye97 approved these changes Jul 14, 2026

View reviewed changes

mrkaye97 merged commit a73d6aa into main Jul 14, 2026
60 checks passed

mrkaye97 deleted the fix--force-gin-for-olap branch July 14, 2026 20:28

Uh oh!

Conversation

grutt commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

What's Changed

Checklist

Uh oh!

vercel Bot commented Jul 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 13, 2026

Benchmark results

Uh oh!

grutt commented Jul 13, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jul 13, 2026

Uh oh!

github-actions Bot commented Jul 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

grutt commented Jul 10, 2026 •

edited

Loading

vercel Bot commented Jul 10, 2026 •

edited

Loading