■ はじめに

https://dk521123.hatenablog.com/entry/2022/12/09/152837

で、Snowflakeには、Timerみたいに疑似的な処理がなさそうで
その代替え案としてストアドプロシージャを軽く触ったのを
きっかけに調べてみた。

【１】ストアドプロシージャ (Stored Procedure)
　１）UDFs （ユーザー定義関数）との違い
【２】サポート言語
　１）使用上の注意
【３】使い方
　１）作成 - CREATE PROCEDURE -
　２）実行（呼び出し） - CALL -
　３）削除 - DROP PROCEDURE -
【４】コマンド
　１）SHOW PROCEDURES
　２）DESCRIBE PROCEDURE
【５】変数の扱い
　１）変数の宣言
　２）変数への値の格納

【１】ストアドプロシージャ (Stored Procedure)

https://docs.snowflake.com/ja/sql-reference/stored-procedures.html

より抜粋
~~~~~~~~~
ストアドプロシージャでは、
プログラムによる構成を使用して、分岐とループを実行できます。
~~~~~~~~~
 => DBの PostgreSQL の ストアド に近い形で組むことができる

１）UDFs （ユーザー定義関数）との違い

https://docs.snowflake.com/ja/sql-reference/stored-procedures-overview.html#differences-between-stored-procedures-and-udfs

に記載されているが、代表的なものとして以下。
~~~~~
[1] ストアドプロシージャから値を返さなくていい（UDFは値を返す）
[2] ストアドプロシージャは独立して呼び出し可能
~~~~~

【２】サポート言語

https://docs.snowflake.com/ja/sql-reference/stored-procedures-overview.html

より抜粋
~~~~~~~
１）Java（Snowparkを使用）
２）JavaScript
３）Python（Snowparkを使用）
４）Scala（Snowparkを使用）
５）Snowflakeスクリプト
~~~~~~~
こんなにあるんだっと、びっくりした、、、

Snowflake スクリプト
https://docs.snowflake.com/ja/sql-reference/stored-procedures-snowflake-scripting.html

１）使用上の注意

https://docs.snowflake.com/ja/sql-reference/stored-procedures-javascript.html#label-considerations-for-case-sensitivity-in-stored-procedures

より抜粋
~~~~~
引数名は、ストアドプロシージャコードの
SQL 部分では大文字と小文字を区別しませんが、
JavaScript部分では大文字と小文字を区別します。
~~~~~

【３】使い方

１）作成 - CREATE PROCEDURE -

https://docs.snowflake.com/ja/sql-reference/sql/create-procedure.html
構文

CREATE PROCEDURE <関数名>(<引数>)
RETURNS <戻り値 (テーブルも返せる)>
LANGUAGE <言語(e.g. SQL)
COMMENT = '<コメント文>'
AS
$$
    -- ブロック (以下の「ブロックの基本構造」を参照)
$$
;

ブロックの基本構造
https://docs.snowflake.com/ja/developer-guide/snowflake-scripting/blocks.html#understanding-the-structure-of-a-block

DECLARE -- https://docs.snowflake.com/ja/sql-reference/snowflake-scripting/declare.html  
  ... (variable declarations, cursor declarations, etc.) ...
BEGIN -- https://docs.snowflake.com/ja/sql-reference/snowflake-scripting/begin.html  
  ... (Snowflake Scripting and SQL statements) ...
EXCEPTION -- https://docs.snowflake.com/ja/sql-reference/snowflake-scripting/exception.html  
  ... (statements for handling exceptions) ...
END;

-- EXCEPTION ブロック に関する詳細はｌ
-- 以下の関連記事を参照のこと。

https://dk521123.hatenablog.com/entry/2022/12/23/223345

例

create or replace procedure say_hello(val1 varchar, val2 varchar)
returns varchar not null
language sql
as
$$
begin
  return :val1 || ' ' || :val2 || '!!';
end;
$$
;

２）実行（呼び出し） - CALL -

https://docs.snowflake.com/ja/sql-reference/sql/call.html

-- プロシージャを実行
CALL <ストアドプロシージャ名>(<引数>);

例

SET var1 = 'Hello';
SET var2 = 'World';
CALL say_hello($var1, $var2);

補足：即時実行について

* 以下の関連記事を参照のこと。

https://dk521123.hatenablog.com/entry/2022/12/17/000217

３）削除 - DROP PROCEDURE -

https://docs.snowflake.com/ja/sql-reference/sql/drop-procedure.html
例

drop procedure say_hello(varchar, varchar);

【４】コマンド

　基本的に、他のコマンドと同じで、いつも通りなのだが、
SHOW PROCEDURESには、INがあったり、
DESCRIBE PROCEDUREには、()が入ったり
ちょっこと異なる点もある。

１）SHOW PROCEDURES

https://docs.snowflake.com/ja/sql-reference/sql/show-procedures.html

-- アクセスする権限があるストアドプロシージャを一覧表示
SHOW PROCEDURES [ LIKE '<pattern>' ] [ IN ...];

２）DESCRIBE PROCEDURE

https://docs.snowflake.com/ja/sql-reference/sql/desc-procedure.html

-- ストアドプロシージャの署名（引数）、戻り値、言語、および本文（定義）などを表示
DESC[RIBE] PROCEDURE <procedure_name> ( [ <arg_data_type> [ , <arg_data_type_2> ... ] ] );

例

DESC PROCEDURE say_hello();

DESC PROCEDURE say_hello(varchar, varchar);

-- 「DESC PROCEDURE say_hello;」だと、()がないので、エラー
-- 引数が分からない場合は、まず「SHOW PROCEDURES;」
-- で調べるといいかも

【５】変数の扱い

* 以下の公式ドキュメントを一読するといい

https://docs.snowflake.com/ja/developer-guide/snowflake-scripting/variables.html

１）変数の宣言

* 以下の2通りで変わる
 a) DECLARE セクション内
 b) BEGIN ... END セクション内

https://docs.snowflake.com/ja/developer-guide/snowflake-scripting/variables.html#declaring-a-variable
a) DECLARE セクション内

-- <variable_name> <type>;
-- <variable_name> DEFAULT <expression> ;
-- <variable_name> <type> DEFAULT <expression> ;

declare
    profit number(38, 2) default 0.0;

b) BEGIN ... END セクション内

-- LET <variable_name> <type> { DEFAULT | := } <expression> ;
-- LET <variable_name> { DEFAULT | := } <expression> ;

begin
    let cost number(38, 2) := 100.0;
    let revenue number(38, 2) default 110.0;

２）変数への値の格納

a) 変数への値の割り当て
https://docs.snowflake.com/ja/developer-guide/snowflake-scripting/variables.html#assigning-a-value-to-a-declared-variable

-- <variable_name> := <expression> ; (「:=」で格納)
profit := revenue - cost;

b) SQL ステートメントでの変数の使用（バインド）
https://docs.snowflake.com/ja/developer-guide/snowflake-scripting/variables.html#using-a-variable-in-a-sql-statement-binding

-- 変数名の前にコロンを付ける
insert into my_table (x) values (:my_variable)

-- オブジェクトの名前として変数を使用している場合
-- （例: SELECT ステートメントの FROM 句にあるテーブルの名前）は、
--  IDENTIFIER キーワードを使用して、変数がオブジェクト識別子を表す
select count(*) from identifier(:table_name)

プログラムの超個人的なメモ

Memo for Programming.

【Snowflake】ストアド～入門編～

■ はじめに

目次

【１】ストアドプロシージャ (Stored Procedure)

１）UDFs （ユーザー定義関数）との違い

【２】サポート言語

１）使用上の注意

【３】使い方

１）作成 - CREATE PROCEDURE -

２）実行（呼び出し） - CALL -

３）削除 - DROP PROCEDURE -

【４】コマンド

１）SHOW PROCEDURES

２）DESCRIBE PROCEDURE

【５】変数の扱い

１）変数の宣言

２）変数への値の格納

関連記事