README.md

Wormwood

Wormwood is a trivial, SQL-ish, flat-file, schemaless, read-only database. It attempts to be the simplest possible implementation of standard database architectural ideas.

Preconditions

Requires node 17 or greater.

To run wormwood

$ cd ts
$ npm i
$ npm start

To add data to wormwood

Insert a file <yourfilename>.clef into the /data directory, containing newline delimeted JSON objects, like this:

{"name":"One","i":1}
{"name":"Two","i":2}
{"name":"Three","i":3}
{"name":"Four","i":4}
{"name":"Five","i":5}
{"name":"Six","i":6}

then query your new data table:

select name,i from <yourfilename>

To create an index

Querying and indexing is only possible on expressions checking equality of a property to a constant.

To create an index on the country property of the offices data table:

sp_createIndex(offices,country)

Henceforth, queries for select country from offices where county = <constant> will use the index to be slightly faster.