<budget_name>!ADD_CUSTOM_ACTION

Associates a stored procedure with a budget so that the procedure is called when projected or actual spending reaches a specified threshold. The procedure must be associated by reference.

For more information, see Custom actions for budgets.

语法

<budget_name>!ADD_CUSTOM_ACTION (
  { '<stored_procedure_reference>' | <reference_statement> },
  { <array_of_arguments> | <array_construct_statement> },
  [ { 'ACTUAL' | 'PROJECTED' }, ]
  <threshold> )

实参

'stored_procedure_reference'

The serialized string representation that resolves to a procedure. This string is the output of the SYSTEM$REFERENCE function.

reference_statement

A SYSTEM$REFERENCE statement that creates a reference for the procedure to be associated with the budget.

array_of_arguments

要传递给存储过程的实参数组。

array_construct_statement

An ARRAY_CONSTRUCT statement that returns an array constructed from zero, one, or more inputs.

{ 'ACTUAL' | 'PROJECTED'}

控制操作是基于实际支出还是预计支出触发。

'ACTUAL' — The stored procedure is called when the actual spend reaches the threshold. 'PROJECTED — The stored procedure is called when spending is projected to reach the threshold.

If omitted, defaults to PROJECTED.

threshold

预算限额的百分比。当 Snowflake 判定实际或预计支出超过此预算限额百分比时，将调用该存储过程。

请指定一个介于 0 到 1,000 之间（含 0 和 1,000）的数字。

返回

返回一个 VARCHAR 值，用于指明过程是否已成功与预算相关联。

如果无法将过程与预算关联，该方法将返回一条错误消息。

访问控制要求

要为预算调用此方法，需要具备以下权限和角色：

  • ADMIN instance role for the budget instance.
  • 对包含预算实例的数据库和架构的 USAGE 权限。
  • 对包含存储过程的数据库和架构的 USAGE 权限。
  • 对存储过程的 USAGE 权限。

For more information, see Budgets roles and privileges.

使用说明

  • Calling this method does not return the object. Because of this, you can’t use method chaining to call another method on the return value of this method. Instead, call each method in a separate SQL statement.

示例

Associate the alert_team stored procedure with the budget_db.sch1.my_budget budget so that it is called when spending is forecast to reach 75% of the budget limit:

CALL budget_db.sch1.my_budget!ADD_CUSTOM_ACTION(
  SYSTEM$REFERENCE('PROCEDURE', 'code_db.sch1.alert_team(string, string, string)', 'SESSION', 'USAGE'),
  ARRAY_CONSTRUCT('admin@example.com', 'Budget Alert', 'Spending at 75% of budget limit'),
  'PROJECTED',
  75);

Associate the alert_team stored procedure with the budget_db.sch1.my_budget budget so that it is called when spending has reached 90% of the budget limit:

CALL budget_db.sch1.my_budget!ADD_CUSTOM_ACTION(
  SYSTEM$REFERENCE('PROCEDURE', 'code_db.sch1.alert_team(string, number)', 'SESSION', 'USAGE'),
  ARRAY_CONSTRUCT('Critical budget threshold', 90),
  'ACTUAL',
  90);