GUIリファレンス
#######################

本セクションでは、Snowflake Native AppのGUI操作について説明します。

権限の付与
***********************
本Native Appは、SnowflakeのTable、Stageに対して操作を行うため、Database、Schema、Table、Stageに対して権限を付与する必要があります。

Snowsight上で以下のSQLコマンドを実行して権限を付与してください。

- <database>.<schema>.<table>に対する権限を付与する場合
    .. code-block:: sql

        GRANT USAGE ON DATABASE <database> TO APPLICATION <application_name>;
        GRANT USAGE ON SCHEMA <database>.<schema> TO APPLICATION <application_name>;
        GRANT SELECT ON TABLE <database>.<schema>.<table> TO APPLICATION <application_name>;
- <database>.<schema>.<stage>に対する権限を付与する場合
    .. code-block:: sql

        GRANT USAGE ON DATABASE <database> TO APPLICATION <application_name>;
        GRANT USAGE ON SCHEMA <database>.<schema> TO APPLICATION <application_name>;
        GRANT READ, WRITE ON STAGE <database>.<schema>.<stage> TO APPLICATION <application_name>;

Streamlitの起動方法
***********************
本セクションでは、Snowflake Native AppのStreamlitを起動する方法について説明します。
本Native Appでは、APC-CLIの機能をGUI操作で利用するためにStreamlitをユーザーインターフェースとして使用しています。

SnowsightでData Productを選択して、Appsをクリックします。

Installed Appsの中から **AUTOPRIVACY_NATIVE_APP** をクリックすることでStreamlitを起動します。

.. image:: ./image/snowflake-application-list.png
    :class: with-border
    :alt: アプリケーション一覧画面
    :width: 100%
    :align: center

起動後、左側のサイドバーからラジオボタンを操作することで、各種ページの切り替えが行えます。

各ページの説明
***********************
以降ではStreamlitの各ページの概要と実行方法について説明します。

初期設定
=======================
.. image:: ./image/streamlit-initialize.png
    :class: with-border
    :alt: 初期設定画面
    :width: 100%
    :align: center

本ページでは、APC-CLIを実行するためのSnowpark Container Service環境の設定を行います。
Native Appで使用する以下のリソースの作成を行います。

- ComputePool
    - 概要: APC-CLIを実行するためのSnowpark Container Serviceのコンピュートリソース
    - `Snowflake Compute Poolについてはこちら <https://docs.snowflake.com/developer-guide/snowpark-container-services/working-with-compute-pool>`_
- Warehouse
    - 概要: Snowpark Container Service内でのSQLクエリを実行するためのウェアハウス
    - `Snowflake Warehouseについてはこちら <https://docs.snowflake.com/user-guide/warehouses-overview>`_

実行方法
-----------------------
- Compute Poolの作成
    1. pool_sizeを選択します。各pool_sizeの説明はSnowflake公式ドキュメントの `コンピューティングプールの作成 <https://docs.snowflake.com/developer-guide/snowpark-container-services/working-with-compute-pool#creating-a-compute-pool>`_ を参照してください。
    2. **Compute Pool作成** をクリックします。

- Warehouseの作成
    1. warehouse_sizeを選択します。各warehouse_sizeの説明はSnowflake公式ドキュメントの `ウェアハウスサイズ <https://docs.snowflake.com/user-guide/warehouses-overview#warehouse-size>`_ を参照してください。
    2. **Warehouse作成** をクリックします。

.. note::
    ComputePoolとWarehouseのサイズ変更は同様の手順で行うことができます。

プロファイル設定
=======================

.. note::
    初期設定ページでComputePoolとWarehouseが作成されている必要があります。
    作成していない場合は、エラーが出力されます。

.. image:: ./image/streamlit-configure.png
    :class: with-border
    :alt: プロファイル設定画面
    :width: 100%
    :align: center

本ページでは、APC-CLIでDataCleanRoomを実行するためのプロファイラ（設定ファイル）の設定を行います。

実行方法
-----------------------
- プロファイラの作成
    1. **New profile_name** に新たに作成するプロファイラの名前を入力します。
    2. サービス提供者から提供するTOMLファイルをアップロードします。
    3. プレビュー画面を確認し、問題なければ **プロファイルの作成開始** をクリックしてSnowpark Container Service Jobを起動します。
    4. **ログ確認** をクリックすることで、Jobの実行ログを確認できます。

DataCleanRoom実行
=======================
.. note::
    初期設定ページでComputePoolとWarehouseが作成されている必要があります。
    作成していない場合は、エラーが出力されます。

.. image:: ./image/streamlit-cleanroom.png
    :class: with-border
    :alt: DataCleanRoom実行画面
    :width: 100%
    :align: center

本ページでは、APC-CLIを使用してDataCleanRoomのパラメータ設定と実行を行います。

実行方法
-----------------------
- CleanRoomの実行
    1. データクリーンルームの設定を行います。
        - profile_name
            - プロファイラの名前を選択します。
        .. note::
            以降のパラメータは両事業者で同じである必要があります。
        - project_id
            - サービス提供者から提供するproject_idを入力します。
        - cleanroom_name
            - デプロイするCleanroomの名前を指定します。Server上に存在するCleanroomの名前を指定した場合は、そのCleanroomが上書きされます。
        - function_id
            - Cleanroomで実行する関数ディレクトリのfunction-idを指定します。
        - runtime
            - Cleanroomのランタイムを指定します。
            .. todo:: 指定できるランタイム一覧
        - handler
            - Cleanroomのハンドラーを指定します。
        - memory
            - Cleanroomのメモリ容量を指定します。

    2. encrypted_file_pathの選択
        encrypted_filesをアップロードします。

        .. note::
            encrypted_fileについては、 :doc:`../../user-files/definition-files` を参照してください。


    3. input_tableの選択
        input_tableは以下の3つの方法で選択できます。

        また、複数のinput_tableを選択できます。

        **手動で作成する場合**

        1. **手動で作成** をクリックします。
        2. ステージの選択画面が表示されるため、database、schema、stageを選択します。

        .. note::
            選択したいdatabase、schema、stageが表示されない場合は、Native Appに権限が付与されているかご確認ください。
        3. file_pathには、保存先のStage内のパスを入力します。
        4. contentには、ファイルに保存するデータを入力します。
        5. **Submit** をクリックします。

        **TABLEから選択する場合**

        1. **TABLEから選択** をクリックします。
        2. テーブルの選択画面が表示されるため、database、schema、tableを選択します。

        .. note::
            選択したいdatabase、schema、tableが表示されない場合は、Native Appに権限が付与されているかご確認ください。
        3. file_nameには、tableをcsvファイルに変換した際に使用するファイル名を指定します。
        4. **Submit** をクリックします。

        **Stageから選択する場合**

        1. **input_tableを選択** をクリックします。
        2. ステージの選択画面が表示されるため、database、schema、stageを選択します。

        .. note::
            選択したいdatabase、schema、stageが表示されない場合は、Native Appに権限が付与されているかご確認ください。
        3. csv_nameには、tableをcsvファイルに変換した際に使用するファイル名を指定します。
        4. **Submit** をクリックします。
    4. output_pathの選択
        1. **ディレクトリを選択** をクリックします。
        2. ステージの選択画面が表示されるため、database、schema、stage, fileを選択します。

        .. note::
            選択したいdatabase、schema、stage, fileが表示されない場合は、Native Appに権限が付与されているかご確認ください。
        3. **Submit** をクリックします。

    5. **データクリーンルーム実行開始** をクリックしてSnowpark Container Service Jobを起動します。
    6. **データクリーンルーム実行ログ確認** をクリックすることで、Jobの実行ログを確認できます。