Total.js 5 API guide by task

Use these references to choose the native Total.js 5 API for your task. The examples target total5@0.0.19.

Native backend references

Area	Reference and examples
Installation, directories and startup	getting started, project structure, LOAD and NPMINSTALL, application bundles, release/debug modes
Global API and configuration	globals, configuration keys, configuration files
Routing and controller	route syntax, controller API, completion and conditional responses, upload lifecycle and query links, static cache invalidation
Actions and validation	action reference, input types, enums and format boundaries, numeric boundaries, hooks and admin guards, transport options, audit
Database queries	DATA, introductory DB/NEWDB, builder operations and driver contract, real SQLite CRUD and transactions, NoSQL, file storage
Messaging and platform protocols	WebSockets, TMS, OPENCLIENT protocol fixture, real OpenLDAP fixture
Flow and executable components	FlowStream, component testing, flow files and workers, native server components
Optional remote services	API drivers, TotalAPI and Componentator local boundaries
Full application	Taskboard reference: sessions, CSRF, owner-scoped NoSQL CRUD and browser assertions; exported app has separate restart/revocation checks

Additional existing recipes cover views/localization, email, encryption helpers, caching, file downloads, proxies, jobs, threads, HTTP clients, macros, image conversion, AI-model driver contracts and Python processes. Use the Total5 catalogue and per-page declared scope for their exact behavior. Python scripts, image converter programs and directory servers are separate environment requirements, not npm dependencies of the framework core.

Which QueryBuilder?

The native DB/NEWDB API builds an options object for a registered driver. DATA is the singleton entry point for independent operations; DB creates a queue. Queue ordering is not a transaction. The SQLite recipe implements a bounded application-owned driver and explicit connection-owned transactions.

The optional official querybuilderpg integration is a separate PostgreSQL package. Initialize a named connection with its connection string and pooling options, then use DATA. The application-owned SQLite driver is specific to SQLite.

Behavior in total5@0.0.19

Use these version-specific behaviors when writing application code:

• Compact Int accepts fractions and Number2 does not round to two places; SmallInt bounds differ from the familiar SQL range.
• Compact JSON and IP labels are read as plain strings; use explicit native JSON Schema subtypes when you need those formats enforced.
• For action csrf/encrypt/compress metadata, use explicit CSRF middleware and test the actual transport.
• For LDAP, decide authentication from your own check of the bind result.
• For query links use QUERIFY with a copied query.
• For QueryBuilder column selection, use fields with an application allowlist.