Technical Documentation of the API and Its Types for Contributors

[Henry-Johnson-100]

Hello, I am interested in making some Haskell bindings to the C API for this project but I would like to know if there is any technical documentation on what exactly the structure of return types are?

All of the functions return some JSON object which I have included some Haskell encodings to the best of my approximation but I don't know for sure if this encompasses all of the possible return types and what state they might return in. For instance, is the "ok" field the only one that appears in every possible result? Could there be an error state that doesn't contain a "related" field? I'm not sure what the stable interface for these functions are or if there is one other than that they return a JSON object.

These are the types I've come up with just from messing around with my current bindings:

data CozoOkay = CozoOkay
  { headers :: [Text]
  , next :: Maybe Value
  , rows :: [[Value]]
  , took :: Double
  }

data CozoBad = CozoBad
  { causes :: [Value]
  , code :: Text
  , display :: Text
  , message :: Text
  , related :: Value
  , severity :: Text
  }

For some of the fields like "next" and "related", I'm not actually sure what types these should contain as I've never seen them contain anything other than a null or empty value.

If this information is available anywhere I would love to take a look, if it's not then perhaps I could make a contribution to the documentation with some of this information as I think it could be helpful for anyone using language API's.

Lastly I would like to thank you for your work. I have been looking for a database just like this on-and-off for ages and only recently stumbled upon cozo and it's very exciting to me to learn about.