Repository navigation
Home
Technical documentation for VoidQL, a policy-driven SQL handler for TypeScript backends.
VoidQL brings authorization, field and row permissions, payload validation, workflow rules, and SQL construction into one declarative layer. A request is checked against the policy for its table, operation, and role before the corresponding Drizzle operation executes.
Warning
VoidQL is experimental. The public package, stable API contract, versioned releases, and production compatibility matrix are not available yet. Use the repository and demo for evaluation; expect breaking changes.
| I want to… | Start here |
|---|---|
| Understand the idea | The VoidQL mental model |
| Try a concrete request | Explore the demo |
| Write policy configuration | Build with VoidQL |
| Find exact syntax | DSL reference |
| Solve a common access problem | Recipes |
| Understand internals | Understand the engine |
| Evaluate risk and boundaries | Security |
| Contribute | Develop VoidQL |
| Layer | Question answered |
|---|---|
| Operation | May this role perform GET, POST, PUT, or DELETE? |
| Fields | Which columns may be read, written, or returned? |
| Rows | Which records may the operation target? |
| Payload | Is the proposed data allowed? |
| Workflow | Is this state change valid now? |
| Execution | Which triggers and transactional steps run around the operation? |
This Wiki uses three status labels:
- Implemented — supported by the supplied source or tests.
- Experimental — implemented, but API stability and compatibility are not guaranteed.
- Planned — product direction only; not documented as callable functionality.
Start with Choose Your Path →