Skip to main content

SA Engine reference

This is the reference documentation for SA Engine. It contains the OSQL language reference guide, the OSQL API reference categorized under different topics, the REST API and documents describing the APIs for building plugins -- or embedding SA Engine as a callable application -- in different languages.

OSQL Reference

The OSQL reference covers the exact definitions of OSQL statements. It has information on how to define types, create objects of defined types. Definitions of the different kinds of queries (calls, predicates, vector queries, etc). How to define functions and second order functions. The OSQL syntax. And so on.


The Topics section covers most of the OSQL API. It describes different "topics" and lists all function definitions related to each topic. Not all topics have a description. Topics without description only list the function definitions related to that topic.


The REST API describes how you can control SA Engine using REST requests.

Plugin/client APIs

You can write plugins to SA Engine in a multitude of languages (C, C++, Lisp, Java, etc) and you can also embed SA Engine as a client in these languages as well. This makes extending SA Engine with custom plugins very easy. And it also facilitates using SA Engine as part of your own application. The plugin/client APIs section contains documents describing the plugin and client APIs.