Skip to content

Commit 9dca87d

Browse files
committed
DP-3506: Clarify sync_metadata docstring on automatic background sync
Metadata sync already runs automatically in the background; sync_metadata is a manual, emergency-only escape hatch, not a temporary stopgap awaiting automation.
1 parent 2f1a82f commit 9dca87d

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

  • packages/gooddata-sdk/src/gooddata_sdk/compute

packages/gooddata-sdk/src/gooddata_sdk/compute/service.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -339,8 +339,10 @@ def sync_metadata(self, workspace_id: str, async_req: bool = False) -> None:
339339
used by AI features like search and chat. The embeddings are created from the
340340
workspace's metadata model and are essential for accurate AI functionality.
341341
342-
Note: This is a temporary solution and will be removed in a future release when
343-
metadata synchronization becomes automatic.
342+
Note: Metadata synchronization already runs automatically in the background, so
343+
calling this method is not required under normal circumstances. It exists as a
344+
manual, emergency-only escape hatch for cases where an immediate synchronization
345+
is needed (e.g. troubleshooting), not as a temporary stopgap awaiting automation.
344346
345347
Args:
346348
workspace_id (str): Workspace identifier

0 commit comments

Comments
 (0)