API documentation

The API documentation covers every package the published artifact, com.darkcollective.relix:relix, exports, and nothing else. Every class it describes is one a program depending on that artifact can use.

Start with com.darkcollective.relix.embed: Relix is a session, and Relation is a query you can inspect, optimise and run. The other packages are the types those two hand back — the syntax tree, schemas, values, plans and events — and the interfaces a function library or connector implements.

For a narrative route through the same API, with examples that are compiled and run on every build, read the programming guide.