EXECUTE IMMEDIATE FROM¶

テンプレート化ディレクティブ¶

2つのテンプレートディレクティブのいずれかを使うことができます。

推奨ディレクティブは SQL の有効な構文を使います。

--!jinja

オプションで、代替ディレクティブを使うこともできます。

#!jinja

ステージングされたファイルのコンテンツをテンプレートで使用する方法¶

テンプレートは SnowflakeFile API から直接、またはJinja2の include、 import、および inheritance 機能を使って他のステージングされたファイルをロードできます。

ファイルは絶対パスで参照できます。

{% include "@my_stage/path/to/my_template" %}
{% import "@my_stage/path/to/my_template" as my_template %}
{% extends "@my_stage/path/to/my_template" %}
{{ SnowflakeFile.open("@my_stage/path/to/my_template", 'r', require_scoped_url = False).read() }}

インクルード、インポート、エクステンドは相対パスもサポートし、 SnowflakeFile API はスコープされたSnowflakeファイル URLs をサポートします。

{% include "my_template" %}
{% import "../my_template" as my_template %}
{% extends "/path/to/my_template" %}

こちらもご参照ください。

EXECUTE IMMEDIATE

絶対ファイルパス（absoluteFilePath）¶

namespace

内部ステージまたは外部ステージが存在するデータベースまたはスキーマ、あるいはその両方で、 database_name.schema_name または schema_name の形式です。データベースとスキーマがユーザーセッション内で現在使用されている場合、名前空間は オプション です。それ以外の場合は必須です。

stage_name

内部または外部ステージの名前。

path

ステージ内にある、大文字と小文字を区別したファイルへのパス。

filename

実行するファイルの名前。構文的に正しく、有効な SQL ステートメントが含まれている必要があります。各ステートメントはコンマで区切る必要があります。

相対ファイルパス（relativeFilePath）¶

path

ステージ内にある、大文字と小文字を区別したファイルへの相対パス。相対パスは、先頭の / でステージのファイルシステムのルートを示し、 ./ で現在のディレクトリ（親ファイルがあるディレクトリ）を参照し、 ../ で親ディレクトリを参照するなど、確立された規則をサポートします。詳細については、 使用上の注意 をご参照ください。

filename

実行するファイルの名前。構文的に正しく、有効な SQL ステートメントが含まれている必要があります。各ステートメントはコンマで区切る必要があります。

ファイルエラー¶

001501 (02000): File '<directory_name>' not found in stage '<stage_name>'.

001503 (42601): Relative file references like '<filename.sql>' cannot be used in top-level EXECUTE IMMEDIATE calls.

001003 (42000): SQL compilation error: syntax error line <n> at position <m> unexpected '<string>'.

ステージエラー¶

002003 (02000): SQL compilation error: Stage '<stage_name>' does not exist or not authorized.

アクセス制御エラー¶

003001 (42501): Uncaught exception of type 'STATEMENT_ERROR' in file <file_name> on line <n> at position <m>:
SQL access control error: Insufficient privileges to operate on schema '<schema_name>'

ステージエラー もご参照ください。

テンプレート化エラー¶

001003 (42000): SQL compilation error:
syntax error line [n] at position [m] unexpected '{'.

000005 (XX000): Python Interpreter Error:
jinja2.exceptions.UndefinedError: '<key>' is undefined
in template processing

001510 (42601): Unable to use value of template variable '<key>'

001518 (42601): Size of expanded template exceeds limit of 100,000 bytes.

基本的な例¶

この例では、ステージ my_stage にあるファイル create-inventory.sql を実行します。

1. 次のステートメントを使用して、 create-inventory.sql という名前のファイルを作成します。

   CREATE OR REPLACE TABLE my_inventory(
     sku VARCHAR,
     price NUMBER
   );
   
   EXECUTE IMMEDIATE FROM './insert-inventory.sql';
   
   SELECT sku, price
     FROM my_inventory
     ORDER BY price DESC;
   

   Copy

2. 次のステートメントを使用して、 insert-inventory.sql という名前のファイルを作成します。

   INSERT INTO my_inventory
     VALUES ('XYZ12345', 10.00),
            ('XYZ81974', 50.00),
            ('XYZ34985', 30.00),
            ('XYZ15324', 15.00);
   

   Copy

3. 内部ステージ my_stage を作成します。

   CREATE STAGE my_stage;
   

   Copy

4. PUT コマンドを使用して、両方のローカルファイルをステージにアップロードします。

   PUT file://~/sql/scripts/create-inventory.sql @my_stage/scripts/
     AUTO_COMPRESS=FALSE;
   
   PUT file://~/sql/scripts/insert-inventory.sql @my_stage/scripts/
     AUTO_COMPRESS=FALSE;
   

   Copy

5. my_stage の create-inventory.sql スクリプトを実行します。

   EXECUTE IMMEDIATE FROM @my_stage/scripts/create-inventory.sql;
   

   Copy

   戻り値:

   +----------+-------+
   | SKU      | PRICE |
   |----------+-------|
   | XYZ81974 |    50 |
   | XYZ34985 |    30 |
   | XYZ15324 |    15 |
   | XYZ12345 |    10 |
   +----------+-------+
   

簡単なテンプレート例¶

1. 2つの変数とテンプレートディレクティブでテンプレートファイル setup.sql を作成します。

   --!jinja
   
   CREATE SCHEMA {{env}};
   
   CREATE TABLE RAW (COL OBJECT)
       DATA_RETENTION_TIME_IN_DAYS = {{retention_time}};
   

   Copy

2. ステージを作成する --- すでにファイルをアップロードできるステージがある場合は オプション です。

   たとえば、Snowflakeに内部ステージを作成します。

   CREATE STAGE my_stage;
   

   Copy

3. ファイルをステージにコピーします。

   たとえば、 PUT コマンドを使用して、ファイル setup.sql をローカル環境からステージ my_stage にアップロードします。

   PUT file://path/to/setup.sql @my_stage/scripts/
     AUTO_COMPRESS=FALSE;
   

   Copy

4. ファイル setup.sql を実行します。

   EXECUTE IMMEDIATE FROM @my_stage/scripts/setup.sql
       USING (env=>'dev', retention_time=>0);
   

   Copy

マクロ、条件、ループ、インポートを含むテンプレートの例¶

1. マクロ定義を含むテンプレートファイルを作成します。

   たとえば、ローカル環境に macros.jinja というファイルを作成します。

   {%- macro get_environments(deployment_type) -%}
     {%- if deployment_type == 'prod' -%}
       {{ "prod1,prod2" }}
     {%- else -%}
       {{ "dev,qa,staging" }}
     {%- endif -%}
   {%- endmacro -%}
   

   Copy

2. テンプレートファイルを作成し、ファイルの先頭にテンプレートディレクティブ（--!jinja2）を追加します。

   テンプレートディレクティブの後に、 import ステートメントを追加して、前のステップで作成したファイルに定義されたマクロをインポートします。たとえば、ローカル環境に setup-env.sql というファイルを作成します。

   --!jinja2
   {% from "macros.jinja" import get_environments %}
   
   {%- set environments = get_environments(DEPLOYMENT_TYPE).split(",") -%}
   
   {%- for environment in environments -%}
     CREATE DATABASE {{ environment }}_db;
     USE DATABASE {{ environment }}_db;
     CREATE TABLE {{ environment }}_orders (
       id NUMBER,
       item VARCHAR,
       quantity NUMBER);
     CREATE TABLE {{ environment }}_customers (
       id NUMBER,
       name VARCHAR);
   {% endfor %}
   

   Copy

3. ステージを作成する --- すでにファイルをアップロードできるステージがある場合は オプション です。

   たとえば、Snowflakeに内部ステージを作成します。

   CREATE STAGE my_stage;
   

   Copy

4. ファイルをステージにコピーします。

   たとえば、 setup-env.sql と macros.jinja のファイルをステージ my_stage にアップロードするには、内部環境から PUT コマンドを使用します。

   PUT file://path/to/setup-env.sql @my_stage/scripts/
     AUTO_COMPRESS=FALSE;
   PUT file://path/to/macros.jinja @my_stage/scripts/
     AUTO_COMPRESS=FALSE;
   

   Copy

5. テンプレートによってレンダリングされた SQL ステートメントをプレビューして、Jinja2コードに問題がないか確認します。

   EXECUTE IMMEDIATE FROM @my_stage/scripts/setup-env.sql
     USING (DEPLOYMENT_TYPE => 'prod') DRY_RUN = TRUE;
   

   Copy

   戻り値:

   +----------------------------------+
   | rendered file contents           |
   |----------------------------------|
   | --!jinja2                        |
   | CREATE DATABASE prod1_db;        |
   |   USE DATABASE prod1_db;         |
   |   CREATE TABLE prod1_orders (    |
   |     id NUMBER,                   |
   |     item VARCHAR,                |
   |     quantity NUMBER);            |
   |   CREATE TABLE prod1_customers ( |
   |     id NUMBER,                   |
   |     name VARCHAR);               |
   | CREATE DATABASE prod2_db;        |
   |   USE DATABASE prod2_db;         |
   |   CREATE TABLE prod2_orders (    |
   |     id NUMBER,                   |
   |     item VARCHAR,                |
   |     quantity NUMBER);            |
   |   CREATE TABLE prod2_customers ( |
   |     id NUMBER,                   |
   |     name VARCHAR);               |
   |                                  |
   +----------------------------------+
   

6. ファイル setup-env.sql を実行します。

   EXECUTE IMMEDIATE FROM @my_stage/scripts/setup-env.sql
     USING (DEPLOYMENT_TYPE => 'prod');
   

   Copy