Custom Queries
How SQL views become GraphQL queries — the concept that underpins everything else. Start here →
Guides Overview
Comprehensive guides for building, deploying, and optimizing FraiseQL applications.
New to FraiseQL? Start with Custom Queries to learn how FraiseQL resolves GraphQL fields directly from PostgreSQL views — the core concept everything else builds on.
Getting Started
Section titled “Getting Started”- Custom Queries — Learn how SQL views become GraphQL queries; start here
- Error Handling — Return structured errors from SQL functions and handle them in resolvers
- Authentication — JWT, OAuth, API keys, and custom auth middleware
Architecture & Design
Section titled “Architecture & Design”- Schema Design — Best practices for naming, types, and view organisation
- Multi-Tenancy — Row-level security and per-tenant isolation patterns
- Advanced Patterns — Soft deletes, audit trails, and schema versioning
- Projection Tables — Materialised read models and CQRS with PostgreSQL
- Threaded Comments — Recursive CTEs and nested GraphQL types
Operations
Section titled “Operations”- Testing — Unit, integration, and contract tests for FraiseQL resolvers
- Performance — Query optimisation, indexes, and connection pooling
- Performance Benchmarks — Reproducible comparisons vs Prisma, Apollo, and Hasura
- Deployment — Docker, Kubernetes, and cloud deployment checklist
Integration
Section titled “Integration”- Observers — React to database events with LISTEN/NOTIFY observers
- Observer & Webhook Patterns — Webhooks and fan-out from observer events
- Custom Resolvers — Override generated resolvers with custom Python logic
- Custom Scalars — Define and serialise custom GraphQL scalar types
- Apollo Sandbox Security — Lock down GraphQL introspection in production
- Federation & NATS Integration — Multi-database federation over NATS
- Federation Configuration — Detailed federation setup and routing rules
- Advanced Federation — Cross-service queries and federated subscriptions
- Advanced NATS — Durable consumers, JetStream, and NATS clustering
Reference
Section titled “Reference”- FAQ — Frequently asked questions with runnable answers
- Troubleshooting — Diagnose and fix common runtime errors
By Use Case
Section titled “By Use Case”Building APIs
Section titled “Building APIs”- Start with Custom Queries
- Add Error Handling
- Implement Testing
- Review Schema Design
Going to Production
Section titled “Going to Production”- Plan Deployment
- Set up Authentication
- Configure Performance
- Monitor with Benchmarks
Multi-Tenant Applications
Section titled “Multi-Tenant Applications”- Learn Multi-Tenancy architecture
- Implement Advanced Patterns
- Set up Federation if needed
- Test with Testing guide
Quick Reference
Section titled “Quick Reference”| Guide | Purpose | Audience |
|---|---|---|
| Custom Queries | Connect SQL views to GraphQL | All developers |
| Schema Design | Structure your data model | All developers |
| Advanced Patterns | Enterprise patterns | Experienced developers |
| Multi-Tenancy | SaaS architectures | SaaS developers |
| Testing | Ensure code quality | QA engineers, developers |
| Performance | Optimise queries | DevOps, backend developers |
| Deployment | Go to production | DevOps engineers |
| Authentication | Secure your API | Backend developers |
| Error Handling | Handle errors gracefully | All developers |
| FAQ | Common questions | All users |
Most Important Guides
Section titled “Most Important Guides”Error Handling
Return structured errors from PostgreSQL functions and surface them cleanly in GraphQL. Error Handling →
Multi-Tenancy
Row-level security and per-tenant isolation for SaaS applications. Multi-Tenancy →
Performance
Indexes, connection pooling, and query optimisation for production workloads. Performance →
Next Steps
Section titled “Next Steps”New to FraiseQL?
Getting Started — Introduction and first steps
Specific problem?
Troubleshooting — Common issues and solutions
Need examples?
Examples — Browse code examples