SYNC CATALOG

Refreshes the compute node's permission token and catalog metadata from the control plane.

Category: catalogDeltaForge extension

Syntax

SYNC CATALOG

Description

## Overview Refreshes the compute node's permission token and catalog metadata from the control plane. After creating, registering, or modifying catalog objects, the compute node's local caches may be stale. SYNC CATALOG forces a refresh so that subsequent queries see the latest catalog state. ## Behavior - Sets the needs_catalog_sync flag on the execution result, which triggers the compute node to request a fresh permission token from the control plane on the next operation. - The refresh includes updated table registrations, zone and schema definitions, and permission grants. - The command itself completes immediately with a confirmation message. The actual cache refresh occurs asynchronously when the next query is issued. - No parameters are accepted. The command always refreshes the full catalog state. - SYNC CATALOG is a local operation on the compute node. It does not push changes to the control plane; it pulls the latest state from it. ## Compatibility SYNC CATALOG is a DeltaForge extension. It bridges the gap between catalog changes made via the control plane API and the compute node's local query engine state.

Examples

-- Force-refresh peer compute nodes after registering a new table (the local session already sees the new row; SYNC CATALOG nudges other compute nodes to re-poll)
REGISTER DELTA TABLE bronze.raw.events LOCATION 'events';
SYNC CATALOG;
SELECT * FROM bronze.raw.events LIMIT 10;
-- Sync after creating a new zone and schema
CREATE ZONE IF NOT EXISTS platinum;
CREATE SCHEMA platinum.aggregates;
SYNC CATALOG;
-- Sync to pick up catalog changes made by another user or compute node
SYNC CATALOG;
SHOW TABLES;

Pitfalls

See Also

Open in interactive docs →   DeltaForge home →