Skip to content

Queries (Reading Data) #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Conversation

l0g1x
Copy link

@l0g1x l0g1x commented May 30, 2025

Overview

NOT READY TO MERGE

This PR attempts to begin to break down the numerous important concepts related to querying data using zero. Majority of content in this PR has already been written before, but has been reorganized/grouped for easier accessibility - particularly for users (like myself) that find themselves frequently re-referencing the docs.

This is only a prototype right now, as the content of the new pages where generated using an LLM that referenced the existing 'Reading Data With ZQL' page (/docs/reading-data)

Queries (Reading Data)

  • ZQL Fundamentals
  • Clauses
  • Filtering
  • Relationships
  • Lifecycles & Performance
  • Data Synchronization
  • Advanced Patterns
  • ZQL Reference

@aboodman if you approve of this page structure, i'm happy to invest more time and ensure all the actual content of each page is correct - given that they were generated.

Copy link

vercel bot commented May 30, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
zero-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 30, 2025 0:29am

@tantaman
Copy link
Contributor

@aboodman - I remember seeing you post about organization in the discord. Did you have an opinion here?

@l0g1x - what's the main advantage to this, in your eyes, over the existing right hand bar?

CleanShot 2025-06-12 at 09 47 23

@l0g1x
Copy link
Author

l0g1x commented Jun 12, 2025

discord thread here: https://discord.com/channels/830183651022471199/1378684414166568991 , which i still need to reply to with additional context on my last message regarding shadcn.

Regarding the right side mini-nav, i think the reason i don't find myself using it is that its a layout for docs that i'm used to. Not saying that its all that bad, but with how much text is in that photo it requires more time to scan through it all.

The analogy here would be similar to creating good postgres indexes in your upstream database lol if you setup it up correctly, it makes the lookups faster.

If im working on building a query, i've found myself first focusing on including data (relationships) and then excluding data (filters). So if im in the middle of trying to remember the API for the filtering functions, i'd expect/want to do the following:

  1. type zero.rocicorp.dev into a new tab
  2. scan for 'Queries'
  3. scan for 'Filtering'
  4. scan all the available functions i can use, looking for the function name that seems like the one i want
  5. read the details of said function

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