Storage-agnostic SQL query engine over a pluggable catalog SPI
0

Configure Feed

Select the types of activity you want to include in your feed.

OCaml 99.0%
Dune 0.3%
Other 0.6%
57 1 0

Clone this repository

https://git.vm.fail/gazagnaire.org/ocaml-catalog https://git.vm.fail/did:plc:r7ag6uops6oiygz2fpd4cwln
ssh://git@git.recoil.org:2222/gazagnaire.org/ocaml-catalog ssh://git@git.recoil.org:2222/did:plc:r7ag6uops6oiygz2fpd4cwln

For self-hosted knots, clone URLs may differ based on your setup.


README.md

catalog#

Storage-agnostic SQL query engine over a pluggable catalog SPI.

The relational query engine and the backend SPI it runs over, factored out so any store -- a B-tree, a columnar Parquet file, an Irmin tree -- becomes SQL-queryable by presenting a catalog (columns, rows, point lookup), without duplicating the engine. Modelled on SQLite virtual tables, SQL-MED foreign-data wrappers, and DataFusion's TableProvider.

Install#

opam install catalog

If opam cannot find the package, it may not yet be released in the public opam-repository. Add the overlay repository, then install it:

$ opam repo add samoht https://tangled.org/gazagnaire.org/opam-overlay.git
$ opam update
$ opam install catalog

API#

  • Catalog -- engine entry point.
  • Spi -- the backend interface a store implements to become queryable.
  • Ir -- the query intermediate representation the engine executes.
  • Value -- the runtime value type.

See the .mli files under lib/ for the documented interface.

License#

ISC. See LICENSE.md.