replikativ / datahike

A fast, immutable, distributed & compositional Datalog engine for everyone.
https://datahike.io
Eclipse Public License 1.0
1.62k stars 95 forks source link

Add some missing information to schema docs #564

Closed JohnnyJayJay closed 1 year ago

JohnnyJayJay commented 1 year ago

SUMMARY

This PR adds some more information to the schema.md documentation file. In its current state, the file can be misleading with regards to the set of features supported by datahike. I stumbled across this today when I made a schema that used tuple attributes and couldn't find a mention of this in this documentation file. The way it's described there led me to believe that they're not supported (yet), even though they are.

The only thing I've done here is add tuple-related optional key descriptions/mentions as well as :db.isComponent to the schema description section and :db.type/tuple to the table of supported types.

Checks

Neither a bugfix nor a feature, so no predefined checks.

ADDITIONAL INFORMATION

/