Skip to content

Commit 2b244b0

Browse files
authored
Merge pull request #86 from objectstack-ai/copilot/evaluate-query-syntax-optimization
2 parents 3afe141 + 619ab62 commit 2b244b0

File tree

6 files changed

+847
-0
lines changed

6 files changed

+847
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,18 @@ ObjectQL's driver architecture supports custom database implementations. Potenti
147147

148148
---
149149

150+
## 🔍 Query Approaches
151+
152+
ObjectQL supports three distinct query interfaces, each optimized for different scenarios:
153+
154+
* **JSON-DSL (Core):** AI-friendly protocol, server-side logic, cross-driver compatibility
155+
* **REST API:** Simple CRUD operations, mobile apps, third-party integrations
156+
* **GraphQL:** Complex data graphs, modern SPAs, efficient multi-table fetching
157+
158+
**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.
159+
160+
---
161+
150162
## 🛠️ Validation & Logic
151163

152164
ObjectQL includes a powerful validation engine that runs universally.

docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ const guideSidebar = [
2626
{ text: 'Data Modeling', link: '/guide/data-modeling' },
2727
{ text: 'Unified ID Migration', link: '/guide/migration-id-field' },
2828
{ text: 'Querying Data', link: '/guide/querying' },
29+
{ text: 'Query Best Practices', link: '/guide/query-best-practices' },
2930
{ text: 'Formulas & Rules Syntax', link: '/guide/formulas-and-rules' },
3031
{ text: '↳ Quick Reference', link: '/guide/formulas-and-rules-quick-ref' },
3132
{ text: 'Business Logic (Hooks)', link: '/guide/logic-hooks' },

docs/api/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ ObjectQL uses a **unified `id` field** as the primary key across all database dr
2929
| **GraphQL** | Modern frontends with complex data requirements | `POST /api/graphql` | [Read Guide](./graphql.md) |
3030
| **Metadata** | Admin interfaces, schema discovery | `/api/metadata/*` | [Read Guide](./metadata.md) |
3131

32+
> **🚀 Want to optimize your queries?**
33+
> 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.
34+
3235
## Quick Links
3336

3437
### Core Concepts

0 commit comments

Comments
 (0)