From 5dcb0f3b7d975046c5ab40711fc6eb5c74ab99cd Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 13 Dec 2024 13:30:07 +0100 Subject: [PATCH] catalog-backend: update description of disableRelationsCompatibility post testing Signed-off-by: Patrik Oldsberg --- .changeset/curly-teachers-marry.md | 2 +- plugins/catalog-backend/config.d.ts | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.changeset/curly-teachers-marry.md b/.changeset/curly-teachers-marry.md index ad22613612..9bf771f4d1 100644 --- a/.changeset/curly-teachers-marry.md +++ b/.changeset/curly-teachers-marry.md @@ -2,4 +2,4 @@ '@backstage/plugin-catalog-backend': minor --- -Added a new `catalog.disableRelationsCompatibility` configuration option that avoids JSON deserialization and serialization if possible when reading entities. This can significantly improve the overall performance of the catalog, but it removes the backwards compatibility processing that ensures that both `entity.relation[].target` and `entity.relation[].targetRef` are present in returned entities. +Added a new `catalog.disableRelationsCompatibility` configuration option that avoids JSON deserialization and serialization if possible when reading entities. This significantly reduces the memory usage of the catalog, and slightly increases performance, but it removes the backwards compatibility processing that ensures that both `entity.relation[].target` and `entity.relation[].targetRef` are present in returned entities. diff --git a/plugins/catalog-backend/config.d.ts b/plugins/catalog-backend/config.d.ts index be6104ac84..384765f92e 100644 --- a/plugins/catalog-backend/config.d.ts +++ b/plugins/catalog-backend/config.d.ts @@ -142,9 +142,9 @@ export interface Config { * Disables the compatibility layer for relations in returned entities that * ensures that all relations objects have both `target` and `targetRef`. * - * Enabling this option can very significantly improve the performance of - * the catalog, but may break consumers that rely on the existence of - * `target` in the relations objects. + * Enabling this option significantly reduces the memory usage of the + * catalog, and slightly increases performance, but may break consumers that + * rely on the existence of `target` in the relations objects. */ disableRelationsCompatibility?: boolean;