README.md

Backend documentation

This is the documentation entry point for frontend developers, backend maintainers, and operators. The implementation is a backend-only SQL Server API: clients send one allowlisted JSON action to the api/index.php entry script and receive one standard JSON envelope. Its URL is /api/index.php from a repository web root or /index.php when api/ itself is the document root.

Start here

1. Introduction — scope and core concepts.
2. HTTP API — transport and the Universal JSON Contract.
3. Action reference — all 16 public actions.
4. JSON request reference — exact accepted fields and shapes.
5. Response reference — success, write, and error envelopes.
6. Frontend integration — turning UI state into requests.

Querying

• JSON Query Mode
• Query examples
• SQL → API JSON Generator
• Query function reference
• Filtering, sorting, and pagination
• Set operations
• Metadata and routines

Server-owned SQL

• SQL Resource Mode
• SQL Resource configuration
• SQL Resource files and examples

Writes

• CRUD / Write API
• Write resource configuration

Boundaries and operations

• Validation, errors, and security
• Capability matrix — the authoritative quick comparison.
• Current limitations
• Architecture
• Database configuration
• Hosting
• Roadmap
• Changelog

Terminology

• JSON Query Mode builds a validated SELECT from client-supplied structure.
• SQL Resource Mode discovers and executes server-owned, read-only SQL files; the client supplies a safe resource ID and optional validated execution metadata.
• Write API performs registered single-object INSERT, UPDATE, DELETE, or UPSERT.
• Universal JSON Contract is the shared request dispatch and response envelope.
• Execution metadata declares approved SQL Resource output controls and narrowly constrained source/HAVING mappings; it never contains arbitrary SQL.

Documentation describes the current implementation. Planned work belongs only in Roadmap; it is not part of the public contract.