connectionRefresh
mutation triggers an asynchronous job that refreshes the metadata for a data warehouse connection. Specifically, it refreshes the list of databases, tables, and columns for the given connection.
This operation starts a background job and returns immediately without waiting for completion. The refresh process will discover new tables, updated schemas, and column changes in your data warehouse.
Signature
This mutation can only be executed by an administrator or a data administrator of the specific connection ID.
The refresh cannot be triggered when a connection is already in
QUEUED
or RUNNING
status. Wait for the current sync to complete before starting a new one.Arguments
The unique identifier of the connection to refresh
Response
The response returns aBoolean
indicating whether the refresh job was successfully triggered:
true
- Refresh job was successfully started
On failure, the mutation throws a GraphQL error rather than returning
false
.