Introduction

These pages explain how HFF query features behave and how to use them from Go. For a staged service walkthrough, start with the tutorials. For use-case recipes, see the cookbook. Backend-specific configuration and support are documented under Backends, and exact signatures and API contracts are collected in the Reference.

• Configure an engine and validate records
• Compile a query
• Schemas and immutable values
• Using the Go API: compose schemas, engine compilation, local filters, adapters, and SQL translation in a service.
• Serialized configuration: represent engine schemas and PostgreSQL bindings as versioned, validated JSON data.
• Converting Go values: explicitly map Go records to an HFF schema without changing HFF's value or type semantics.
• Scalar and string methods
• List and object methods
• List callbacks and transformations
• JSON parsing and serialization
• Timestamps, durations, and time zones

Implementation status

The local backend supports the documented common operations, built-in method families, callbacks, JSON and temporal conversions, and local extension evaluators. PostgreSQL support and its current limits are listed in the PostgreSQL backend reference. A successful compile does not imply that every backend can build the program.