v0.7.0

⚠️ Breaking change

This version requires a Ceramic node running Ceramic v5.2+, previous versions of Ceramic are no longer supported by ComposeDB v0.7.

New features

• Added support for the new SET account relation when defining models.
• Added support for the shouldIndex metadata flag, allowing to signal to indexers if documents should be indexed or not.
• Added support for immutable fields, defined using the new @immutable directive in the definition schema.
• Added support for optional relation fields.

Upgrading from a previous version

Runtime composite definitions will need to be generated again to work with v0.7 of the ComposeDB client.

v0.6.0

⚠️ Breaking changes

• This version requires a Ceramic node running Ceramic v3.x, Ceramic v2.x is no longer supported by ComposeDB v0.6.
• As for Ceramic v3, Node v20 is now the version of Node supported by ComposeDB v0.6.
• The indices keys in the encoded composite definition were incorrectly set by model name rather than ID in previous versions. This has been fixed now, but existing encoded composite definitions created before v0.6 will need to be manually updated to replace the model names by their ID in the indices object.

Other change

Added support for model interfaces

Model interfaces provide a higher-level abstraction for models using common fields.

Upgrading from a previous version

Runtime composite definitions will need to be generated again to work with v0.6 of the ComposeDB client.

v0.3

⚠️ Breaking changes

This version uses a different format of models, which is a breaking change from v0.2.x. Composites and models created with v0.2.x are not compatible with v0.3 and will need to be re-created.

Other changes

Added support for relations between documents

This allows to specify properties on a model as containing references to other documents that can be used to directly access the referenced document as well as querying the other side of the relation.

Added support Ceramic admin APIs to index

This allows the ComposeDB libraries and tools to notify the Ceramic node of models to index, rather than having to explicitly set them in Ceramic's configuration file.
The Ceramic node needs to be configured as documented to support these changes.

Developer Preview 1

First developer preview of ComposeDB - read the announcement post.