Skip to content

docs(zql): document JSON path filters - #327

Merged
arv merged 3 commits into
mainfrom
arv/docs-json-filters
Nov 6, 2026
Merged

arv merged 3 commits into
mainfrom
arv/docs-json-filters

Conversation

@arv

@arv arv commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Adds a JSON Filters section to the ZQL page, under Where. It covers:

  • Using json(column, ...path) inside a cmp() callback.
  • Path segments: a string reads an object key, a number reads an array index, and the two never cross over.
  • Path completion and value types for columns with a custom JSON type.
  • Type-strict comparisons, with a short table of examples.
  • Single-type IN / NOT IN lists.
  • Missing keys and JSON null, both found with IS / IS NOT.

Timing: this documents a feature that hasn't shipped yet. It should merge together with the Zero release that includes JSON path filters.


Generated by Claude Code

Copilot AI lite review requested due to automatic review settings October 20, 2026 15:42
@vercel

vercel Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
zero-docs Ready Ready Preview Oct 29, 2026 10:41am UTC

Request Review

arv commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

Verify Signed Commit Authors fails because the PR's one commit (91e5f2a65) is signed with the authoring session's SSH key, which isn't on the allowed list. The fix is for the author to re-sign that commit with their own key and force-push. There is nothing to fix in the content.


Generated by Claude Code

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

Moderate documentation inconsistencies and a stale search index must be addressed before approval.

3 open issues
What changed in this PR

Documents upcoming JSON path filtering support in ZQL.

Changes:

  • Adds JSON path syntax and traversal semantics.
  • Documents typed comparisons, IN/NOT IN, and missing/null behavior.
  • Adds examples under the Where section.
File Summary
contents/​docs/​zql.mdx Adds the JSON Filters section. Requires search-index regeneration, clarification of null/type comparison rules, and correction of top-level examples.

Review effort: Lite

Comment thread contents/docs/zql.mdx Resolved
Comment thread contents/docs/zql.mdx Resolved
Comment thread contents/docs/zql.mdx Resolved

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

An active documentation inconsistency remains in contents/docs/zql.mdx regarding how invalid JSON path steps resolve and whether they can match null.

1 open issue
3 resolved since last review

Review effort: Lite

Comment thread contents/docs/zql.mdx Resolved
arv added 3 commits October 29, 2026 11:40
Add a JSON Filters section under Where: the json() helper in cmp(),
string vs number path segments, typed paths, type-strict comparisons,
homogeneous IN lists, and how missing keys and JSON null behave.

Claude-Session: https://claude.ai/code/session_013VzyesbmCjvSPN6qKkKz9X
The type-strict rule applies to non-null values (a null never matches
!=), and IS / IS NOT also compare against null. Regenerate
assets/search-index.json so the new JSON Filters section is searchable.

Claude-Session: https://claude.ai/code/session_013VzyesbmCjvSPN6qKkKz9X
@arv
arv force-pushed the arv/docs-json-filters branch from 8435fd2 to 886570f Compare October 29, 2026 10:40
@arv
arv added this pull request to the merge queue Nov 6, 2026
Merged via the queue into main with commit 737bdf4 Nov 6, 2026
6 checks passed
@arv
arv deleted the arv/docs-json-filters branch November 6, 2026 11:07
arv added a commit that referenced this pull request Nov 6, 2026
This reverts commit 737bdf4 (#327). JSON path filters are not in a
released Zero version yet.

Claude-Session: https://claude.ai/code/session_013VzyesbmCjvSPN6qKkKz9X
arv added a commit that referenced this pull request Nov 6, 2026
This reverts commit 737bdf4 (#327). JSON path filters are not in a
released Zero version yet.

This branch was successfully deployed

1 active deployment
Preview — 886570f0 Deployed Oct 29, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants