Skip to content

Add query best practices documentation #86

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.

Sign up for GitHub

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

Merged
huangyiirene merged 5 commits into from
Jan 15, 2026
Merged

Add query best practices documentation #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e9c2f2
Initial plan
Copilot Jan 15, 2026
d1ff542
Add comprehensive query syntax alternatives and optimization document…
Copilot Jan 15, 2026
97e4fde
Add Chinese translation of query syntax alternatives guide
Copilot Jan 15, 2026
812b9f3
Rename to query best practices and remove Chinese version
Copilot Jan 15, 2026
619ab62
Address code review feedback: fix mutations, add legend, clarify exam…
Copilot Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,18 @@ ObjectQL's driver architecture supports custom database implementations. Potenti

---

## 🔍 Query Approaches

ObjectQL supports three distinct query interfaces, each optimized for different scenarios:

* **JSON-DSL (Core):** AI-friendly protocol, server-side logic, cross-driver compatibility
* **REST API:** Simple CRUD operations, mobile apps, third-party integrations
* **GraphQL:** Complex data graphs, modern SPAs, efficient multi-table fetching

**Looking for best practices?** Check out the [Query Best Practices Guide](./docs/guide/query-best-practices.md) for detailed comparisons, performance strategies, and optimization techniques.

---

## 🛠️ Validation & Logic

ObjectQL includes a powerful validation engine that runs universally.
Expand Down
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const guideSidebar = [
{ text: 'Data Modeling', link: '/guide/data-modeling' },
{ text: 'Unified ID Migration', link: '/guide/migration-id-field' },
{ text: 'Querying Data', link: '/guide/querying' },
{ text: 'Query Best Practices', link: '/guide/query-best-practices' },
{ text: 'Formulas & Rules Syntax', link: '/guide/formulas-and-rules' },
{ text: '↳ Quick Reference', link: '/guide/formulas-and-rules-quick-ref' },
{ text: 'Business Logic (Hooks)', link: '/guide/logic-hooks' },
Expand Down
3 changes: 3 additions & 0 deletions docs/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ ObjectQL uses a **unified `id` field** as the primary key across all database dr
| **GraphQL** | Modern frontends with complex data requirements | `POST /api/graphql` | [Read Guide](./graphql.md) |
| **Metadata** | Admin interfaces, schema discovery | `/api/metadata/*` | [Read Guide](./metadata.md) |

> **🚀 Want to optimize your queries?**
> Check out the [Query Best Practices Guide](../guide/query-best-practices.md) for performance optimization strategies, detailed comparisons, and recommendations to help you choose the best approach for your use case.

## Quick Links

### Core Concepts
Expand Down
Loading
Loading