purgeStreamGraphRecords

First introduced in version: 3.00.3

Syntax

purgeStreamGraphRecords(name)

Details

Deletes the metadata record of the specified stream graph from the DFS table. This operation is only allowed if the stream graph’s status is "destroyed"; otherwise, an exception will be thrown.

In a cluster deployment, this function can only be run by an administrator or a user who has the COMPUTE_GROUP_EXEC permission for the compute group used when the stream graph was created. In a single-node deployment, no permission check is required.

Parameters

name is a string representing the name of the stream graph. You can provide either the fully qualified name (FQN), such as "catalog_name.orca_graph.graph_name", or just the graph name, like "factors". If only the name is given, the system will automatically complete it using the current catalog.

Returns

None.

Examples

After using dropStreamGraph to destroy a stream graph, you can remove its record as follows:

purgeStreamGraphRecords("demo.orca_graph.indicators")
getStreamGraphMeta("demo.orca_graph.indicators")["status"]

/*
id fqn status semantics checkpointConfig tasks createTime owner reason
-- --- ------ --------- ---------------- ----- ---------- ----- ------
*/