Compatibility Config
Introduction
The CompatibilityConfig object is a metadata object that defines the compatibility configuration of the Hasura metadata.
How CompatibilityConfig works
Lifecycle
By default, all projects are created with a default CompatibilityConfig object in the globals subgraph. It can be defined in any subgraph of your choice, but only once across your supergraph.
The date
field in the CompatibilityConfig object specifies the date after which any backwards incompatible changes
made to Hasura DDN won't impact the metadata.
Examples
Bypass relation_comparisons
NDC Capability
Date: 2024-09-03
Description: Enables bypassing the relation_comparisons
NDC capability for relationship predicates. This allows
you to use relationships in boolean expressions even if the data connector lacks compatibility. When the capability is
available, relationship predicates are resolved directly within the native data connector for more efficient processing.
If not, the predicates are handled at the API layer.
Require GraphQL Config
Date: 2024-06-30
Description: Enforce the need for GraphQL Config.
Metadata structure
v2_CompatibilityConfig
The compatibility configuration of the Hasura metadata.
Key | Value | Required | Description |
---|---|---|---|
kind | CompatibilityConfig | true | |
date | string | true | Any backwards incompatible changes made to Hasura DDN after this date won't impact the metadata. |