Categories:

Data metric functions

DATA_METRIC_SCHEDULED_TIME (system data metric function)¶

Returns the timestamp for when a DMF is scheduled to run or the current timestamp if the function is called manually.

You can use this DMF to define custom metrics to measure the freshness of your data or to define incremental metrics in conjunction with DMFs that already exist.

Syntax¶

SNOWFLAKE.CORE.DATA_METRIC_SCHEDULED_TIME()
Copy

Arguments¶

None.

Returns¶

The function returns a scalar value with a TIMESTAMP_LTZ data type.

Access control requirements¶

Associating and running a system DMF requires the USAGE privilege on the system DMF. You can grant the SNOWFLAKE.DATA_METRIC_USER database role to give users the USAGE privilege on all system DMFs. For more information, see Grant the USAGE privilege on system DMFs.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

Calling this function manually in a SELECT query returns the same value as the CURRENT_TIMESTAMP function.

Example¶

Create a custom data metric function to determine the data freshness on a table in the last hour:

CREATE OR REPLACE DATA METRIC FUNCTION data_freshness_hour(
  ARG_T TABLE (ARG_C TIMESTAMP_LTZ))
  RETURNS NUMBER AS
  'SELECT TIMEDIFF(
     minute,
     MAX(ARG_C),
     SNOWFLAKE.CORE.DATA_METRIC_SCHEDULED_TIME())
   FROM ARG_T';
Copy

Call the data metric function manually:

SELECT data_freshness_hour(SELECT last_updated FROM hr.tables.empl_info) < 60;
Copy

The statement returns True if there are no updates to the table in the last hour (60 minutes).

The statement returns False if there were updates to the table that took place more than one hour ago.

Language: English